Payout codes [Payouts API]
Payout statuses, rejection codes and failure reasons.
Payout rejection codes
| Code | Description |
|---|---|
insufficient_funds | Your account does not have sufficient funds required to make the payout. |
server_error | We encountered a technical issue when authorising the payment. Please try again later. |
Payout failure codes
| Code | Description |
|---|---|
scheme_error | The scheme was unable to fulfill the payment. |
server_error | We encountered a technical issue when processing the payment. Please try again later. |
Payout context codes
| Code | Description |
|---|---|
withdrawal | The payout is allowing an end user to withdraw funds from your service. For example, this code would be used if you are an iGaming company allowing users to withdraw their winnings. |
service_payment | The payout is being used to pay for a service. For example, you are a Gig Economy company paying a driver or you are a platform paying a merchant. |
internal | You are paying yourself. Use this code to withdraw your funds from your account with us. |
Payout state machine
| State | Terminal | Description |
|---|---|---|
new | No | The payout has been created with TrueLayer but has not yet been authorised and sent to the payment scheme for execution. |
authorised | No | TrueLayer has performed a funds check and there are sufficient funds to make the transaction. |
submitted | No | TrueLayer has submitted the payout to the payment scheme for execution. |
settled | Yes | The scheme has notified TrueLayer that the payout has settled into the end account. |
failed | Yes | The payout failed. This may be because of an internal error or an error with the payment scheme. This state can occur at any stage before settled and is a final state. |
rejected | Yes | The payout was rejected, this can be because of a lack of funds or a risk check. This state can occur at any stage before settled and is a final state. |
Updated 9 months ago