Below are the payment orders state machine and a description of the related events and statuses.
Events
| Event | Description |
|---|---|
| pending_approval | The payment order has been created and is pending approval. |
| approved | The payment order has been approved. |
| auto_approved | The payment order has been automatically approved. |
| processing | The payment order is being processed and added to a payment file. |
| sent | The payment file including the payment order has been approved and sent to the bank. |
| executed | The payment order has been executed by the bank. |
| canceled | The payment order has been canceled by a user during the approval. |
| processing_canceled | The payment order's file has been canceled. |
| pending | The payment order has been put on hold by the bank. |
| pending_retry | The file has been rejected by the bank. The payment order will be sent in a new file. |
| retried | The payment order has been sent in a new file. |
| rejected | The payment order has been rejected by the bank due to incorrect information. |
| returned | The payment order has been reconciled against a posted return transaction. |
| reconciled | The payment order has been reconciled against an account statement's transaction. |
| partially_reconciled | The payment order has been partially reconciled against an account statement's transaction. |
| unreconciled | The payment order has been unreconciled from any account statement's transaction. |
Statuses
| Status | Description |
|---|---|
| pending_approval | The payment order has been created and is pending approval. |
| approved | The payment order has been approved. |
| canceled | The payment order has been canceled. |
| processing | The 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. |
| sent | The payment order has been sent to the bank. |
| executed | The payment order has been executed by the bank. |
| pending | The payment order has been put on hold by the bank. |
| rejected | The payment order has been rejected by the bank. |
| returned | The payment has been returned after having been executed by the bank. |
State machine
