Below are the returns state machine and a description of the related events and statuses.
Events
| Event | Description |
|---|---|
| pending | The return has been created. |
| sent | The return has been sent to the bank. |
| processing | The return is being processed and has been added to a file. |
| executed | The return has been executed by the bank. |
| received | The return has been received from the bank. |
| rejected | The return has been rejected. |
| pending_retry | The file has been rejected by the bank. The return will be sent in a new file. |
| retried | The return has been sent in a new file. |
| reconciled | The return has been reconciled against an account statement's transaction. |
| partially_reconciled | The return has been partially reconciled against an account statement's transaction. |
| unreconciled | The return has been unreconciled from any account statement's transaction. |
Statuses
| Status | Description |
|---|---|
| pending | The return has been created. This is the initial status for a return corresponding to an incoming payment. |
| sent | The return has been sent to the bank. |
| processing | The return is being processed and has been added to a file. |
| executed | The return has been executed by the bank. |
| received | The return has been received from the bank. This is the initial status for a return corresponding to a payment order. |
| rejected | The return has been rejected. |
| pending_retry | The file has been rejected by the bank. The return will be sent in a new file. |
State machine
