Payment Statuses

Pay Runs

A Pay Run is a collection of Payables that are initiated in the same payment session.

• Draft - The pay run has been created and can be checked out
• Open - The pay run is ready to pay
• UserInitiationInProgress - A batch of payables are being authorised at the bank
• Processing - One or more batches have been authorised
  • This status takes precedence over UserInitiationInProgress
• Cancelling - Cancellation of the pay run has been requested
  • This status takes precedence over all of the above statuses
• Processed - The pay run has concluded and all Payables were successfully Processed
• Cancelled - The pay run has concluded and all Payables were successfully Cancelled
• Concluded - The pay run has concluded in some other way, check the relevant Payable statuses for individual outcomes

🚧

Processed is not always final

Payables that are Processed can, in rare circumstances, be rejected by the beneficiary bank and return to Processing status. There is no time limit on when this can happen.

If any Payable moves back to Processing then its Pay Run also moves back to Processing.

Payables

A Payable is a payment that the customer intends to make.

• Draft - The payment has been created and can be checked out
• Open - The payment is ready to pay
• UserInitiationInProgress - The payment is being authorised at the bank
• AwaitingMultiAuth - The payment has been authorised by the initiating user but requires additional bank account signatories to authorise
• BankInitiating - The bank is preparing to initiate transfer
• TransfersInProgress - The funding transfer is in progress
• Processed - The payment has concluded successfully
• Cancelled - The payment has concluded and was not sent
• Cancelling - Cancellation has been requested but not yet confirmed
• Processing - The payment is undergoing further processing after the initial funding transfer
• WaitingForCustomer - The payment is awaiting further information from the customer
• Reversing - The payment is being processed for reversal, with intent to send funds back to the payer
• Reversed - The payment has been reversed and funds have been sent back to the payer

🚧

Processed is not always final

Payables that are Processed can, in rare circumstances, be rejected by the beneficiary bank and return to Processing status. There is no time limit on when this can happen.

Payable Groups

A Payable Group is a collection of payments to the same beneficiary that have been bundled together into a single payment to the beneficiary.

• Open - The group is ready to pay
• UserInitiationInProgress - The group is being authorised at the bank
• Processing- The group has been authorised
• Cancelling - Cancellation has been requested but is not yet confirmed
• Processed - The group has concluded, check the relevant Payable statuses for outcomes

📘

Payable Group status updates

Payable Group statuses can be queried through Get pay run but are not available as a webhook category. Consider following Payable or Pay Run webhooks instead.

🚧

Processed is not always final

Payables that are Processed can, in rare circumstances, be rejected by the beneficiary bank and return to Processing status. There is no time limit on when this can happen.

If any Payable moves back to Processing then its Payable Group also moves back to Processing.

Payable Batches

A Payable Batch is a collection of payments that are authorised together at the payer's bank. A Pay Run could be split into several Payable Batches to accommodate bank restrictions on how many Payables can be authorised at once.

• Open - The batch is ready to pay
• UserInitiationInProgress - The batch is being authorised at the bank
• Processing - The batch has been authorised
• Cancelling - Cancellation of the batch has been requested but is not yet confirmed
• Processed - The batch has concluded, check the relevant Payable statuses for outcomes

📘

Payable Batch status updates

Payable Batch statuses can be queried through Get pay run but are not available as a webhook category. Consider following Payable or Pay Run webhooks instead.

🚧

Processed is not always final

Payables that are Processed can, in rare circumstances, be rejected by the beneficiary bank and return to Processing status. There is no time limit on when this can happen.

If any Payable moves back to Processing then its Payable Batch also moves back to Processing.

Authorisations

An Authorisation is a user's attempt to authorise one Payable Batch with their bank. If an Authorisation fails, the user can opt to retry, hence there could be multiple Authorisations per Payable Batch.

• Created - New authorisation attempt has been created
• UserAuthorising - User is in the process of authorising with their bank
• BankAuthorising - User has authorised but the bank is running its own checks
• AwaitingMultiAuth - The batch has been authorised by the initiating user but requires additional bank account signatories to authorise
• Processed - Authorisation completed successfully and the batch will be initiated
• Failed - Authorisation failed
• Cancelled- User cancelled their authorisation attempt
• TimedOut - User did not conclude their authorisation attempt and it has timed out

📘

Why track Authorisations?

Tracking Authorisations can give you an insight into a user's payment journey, including how many times they retry before succeeding. To track the state of a particular payment, it is instead more appropriate to examine each Payable.