Statuses

Pay Run Entities

Where a status is a Processing status it is in a state that might change.

Status	Phase	Description	Pay Run	Batch	Group	Payable
Invalid	Final	Entity is not valid for payment. Generally represents a validation error or other backend issue during payable creation.				✅
Open		Ready to be paid.	✅	✅	✅	✅
Processed	FInal	Processing has been concluded.	✅	✅	✅	✅
Cancelled	Final	Entity has been cancelled and can no longer be paid.	✅	✅	✅	✅
PartiallyProcessed	Processing	Processing is partially complete. Some child entities have been processed.	✅
PartiallyProcessedAndCancelled	Processing	Processing is partially complete and has been cancelled. Some child entities have been processed, the remainder have been cancelled and can no longer be paid.	✅
UserInitiationInProgress	Processing	The user initiation phase of payment is currently underway. Generally this means the user is in the process of authorising a batch.	✅	✅	✅	✅
UserInitiationInProgressAndCancelled	Processing	The user initiation phase of paying a batch is currently underway and the entity has been cancelled. Because the user is in the process of authorising payments and the entity will transition to Processed, TransfersInProgress, Cancelled or PartiallyProcessedAndCancelled once complete	✅	✅	✅	✅
TransfersInProgress	Processing	User initiation is complete and the transfer of funds is now in progress. The batch will transition to Processed, TransfersInProgress, TransfersInProgressAndCancelled, Cancelled or Open.		✅	✅	✅
TransfersInProgressAndCancelled	Processing	User initiation is complete and the transfer of funds is now in progress and/or the pay run has been cancelled. The pay run will transition to Processed, PartiallyProcessedAndCancelled or Cancelled once transfer is complete or fails.	✅

Pay Run States

Batch, Group and Payable States

Authorisation

Status	Description
Created	New authorisation attempt has been created
UserAuthorising	User authorisation in progress
BankAuthorising	User authorisation complete, bank authorisation and verification in progress
AwaitingMultiAuth	Authorisation is blocked awaiting one or more additional authentications
Processed	Payment initiation complete
Failed	Authorisation failed
Cancelled	Authorisation attempt cancelled by user
TimedOut	Authorisation timed out

Authorisation States

Organisation Onboarding

Status	Description
Initiated	Organisation onboarding initiated
Authenticated	Organisation user authenticated
BankSelected	Organisation user selected bank
AccountsConnected	Organisation user bank accounts connected
Complete	Organisation onboarding complete

Organisation Onboarding States

Event Payloads

AccountsConnected

json

{
    BankAccountIds: ["bb523a39-0e22-45cd-8c20-73302e87296a", "21ae3b48-ccb3-4cb1-9c7f-2640d3811e29"]
}

Bank Account

Status	Description
Active	The bank account has a valid consent
Disconnected	The bank account's consent has expired or been revoked