Payout codes

Payout rejection codes

CodeDescription
insufficient_fundsYour account does not have sufficient funds required to make the payout.
server_errorWe encountered a technical issue when authorising the payment. Please try again later.

Payout failure codes

CodeDescription
scheme_errorThe scheme was unable to fulfill the payment.
server_errorWe encountered a technical issue when processing the payment. Please try again later.

Payout context codes

CodeDescription
withdrawalThe 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_paymentThe 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.
internalYou are paying yourself. Use this code to withdraw your funds from your account with us.

Payout state machine

StateTerminalDescription
newNoThe payout has been created with TrueLayer but has not yet been authorised and sent to the payment scheme for execution.
authorisedNoTrueLayer has performed a funds check and there are sufficient funds to make the transaction.
submittedNoTrueLayer has submitted the payout to the payment scheme for execution.
settledYesThe scheme has notified TrueLayer that the payout has settled into the end account.
failedYesThe 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.
rejectedYesThe 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.

Did this page help you?