Payment order lifecycle events

Below are the payment orders state machine and a description of the related events and statuses.

Events

EventDescription
pending_approvalThe payment order has been created and is pending approval.
approvedThe payment order has been approved.
auto_approvedThe payment order has been automatically approved.
processingThe payment order is being processed and added to a payment file.
sentThe payment file including the payment order has been sent to the bank.
executedThe payment order has been executed by the bank.
canceledThe payment order has been canceled.
processing_canceledThe file including the payment order has been canceled.
pendingThe payment order has been put on hold by the bank.
pending_retryThe file including the payment order has been rejected by the bank. The payment order will be sent in a new file.
retriedThe payment order has been retried.
rejectedThe payment order has been rejected by the bank due to incorrect information.
returnedThe payment order has been reconciled against a posted return transaction.
reconciledThe payment order has been reconciled with one or multiple transactions.
partially_reconciledThe payment order has been partially reconciled with one or multiple transactions.
unreconciledThe payment order has been unreconciled with one or multiple transactions.

Statuses

StatusDescription
pending_approvalThe payment order has been created and is pending approval.
approvedThe payment order has been approved.
canceledThe payment order has been canceled.
processingThe payment order is being processed and added to a payment file. The payment file is pending approval. In case a payment file is not validated, corresponding payment orders go back to the approved status.
sentThe payment order has been sent to the bank.
executedThe payment order has been executed by the bank.
pendingThe payment order has been put on hold by the bank.
rejectedThe payment order has been rejected by the bank.
returnedThe payment has been returned after having been executed by the bank.
retriedThe payment has been retried.

State machine