This page is here to give you a general explanation of payouts lifecycle.
Payout Flow
As described on the API Flow Overview given in the introduction, when successful the request will generate a payout and return the corresponding status in the response.
If any of the fields value is not valid the provider will reject the payout and your request will return the ERROR status. The payout ID might still be generated if shown in the response.
If the payout goes through normally, you will receive a PENDING status callback. From this point on the payout will go through different statuses depending on its processing stage. A PENDING status does not mean the payout will be successfully processed since it is generated before payment is made.
Payout Flowchart
Payretailers Payout Flowchart.
Payout Statuses
Just like transactions, after payouts are created they go through different statuses that reflect their actual state. The system sends Notifications when the payout is created and every time the status changes until the payout reaches a final status. You can find the meaning of those statuses in the table below.
If one of your payouts is stuck on a status that is not final for no apparent reason please open a ticket with our support team.
Payretailers Payout Status Flowchart.
| Value | Description |
|---|---|
| PENDING | The payout was created and is being sent to the PSP. |
| PROCESSED | The PSP received the Payout request successfully. |
| ACCEPTED | The payout information was checked and is valid. |
| FINISHED | The money was paid by the PSP. |
| ERROR | The information is invalid or the PSP rejected the payout. Please check the error message for more information. |