--- title: "Get payout" method: GET path: "/v3/payouts/{id}" tags: ["Payouts"] --- # Get payout `GET /v3/payouts/{id}` ## Request - Base URL: `https://api.truelayer-sandbox.com` - URL: `https://api.truelayer-sandbox.com/v3/payouts/{id}` - Auth: OAuth 2 - Client credentials - Token URL: `https://auth.truelayer.com/connect/token` scopes: `payments` Returns payout details. ## Path parameters - `id` string, required: Unique ID for the Payout ## Response `200` Payout - union - PayoutPending: The payout has been created against TrueLayer's API but it has not yet been authorized and sent to the payment scheme for execution. - `id` string, required: Unique ID for the Payout - `merchant_account_id` string, uuid, required: Unique ID for the Merchant Account - `amount_in_minor` integer, required: A 'cent' value representing the amount, e.g. 100 == 1GBP - `currency` 'GBP' | 'EUR' | 'PLN', required - `beneficiary` union, required - PayoutDestinationExternalAccount: The routing information for an external bank account. - `type` 'external_account', required: Type `external_account` - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - `account_holder_name` string, required: The name of the external account holder. - `account_identifiers` AccountIdentifier[] - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - `account_holder_verification` union - AccountHolderVerificationCompleted - `id` string, uuid, required - `status` 'completed', required: A match result was returned. - `match_result` union, required - … - AccountHolderVerificationFailed - `id` string, uuid, required - `status` 'failed', required: A match result was not returned. - `failure_reason` string, required: The reason why the verification failed. There can be many reasons for this, for example: - `VoP scheme provider error`: Failure with one of the providers in the scheme - likely to be transitory. - `Internal error`: An internal error occurred while processing the request. - PayoutDestinationVerifiedExternalAccount: Payout response for an external account using a previously completed verification. The beneficiary details (name and account identifier) are retrieved from the verification. - `type` 'verified_external_account', required: Type `verified_external_account` - `account_holder_verification_id` string, uuid, required: The ID of the account holder verification - `account_holder_name` string, required: The name of the external account holder (retrieved from verification) - `account_identifiers` AccountIdentifier[], required - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - PayoutDestinationPaymentSource - `type` 'payment_source', required: Type `payment_source` - `payment_source_id` string, required: ID of the external account which has become a payment source - `user_id` string, required: ID of the owning user of the external account - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - `account_holder_name` string, required: The name of the account holder. - `account_identifiers` AccountIdentifier[], required - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - PayoutDestinationBusinessAccount - `type` 'business_account', required: Type `business_account` - `account_holder_name` string, required: The name of the external account holder. - `account_identifiers` AccountIdentifier[], required - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - PayoutDestinationUserDetermined: User determined beneficiary details - `type` 'user_determined', required: Type `user_determined` - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - `user` PaymentUser, required - `id` string, required: Unique ID for the User - `account_holder_name` string: The name of the account holder. - `account_identifiers` AccountIdentifier[] - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - `verification` PayoutBeneficiaryVerification: Object that describes the verification checks that were request for the payout. - `verify_name` boolean: Whether to verify the account holder name. - `transaction_search_criteria` PayoutBeneficiaryVerificationTransactionSearchCriteria: An object describing the search criteria to use to look for a transaction in the transaction history of the bank account connected to the end user - `tokens` string[], required: A list of tokens to look for as transaction reference. The size of this array can vary between 1 and 5 items. Each item should present minimum 3 and maximum 50 characters, including spaces. We recommend adding the merchant's name and an identifier in the transaction's description. e.g. `["18db38", "Betropolis LTD", "LC Betropolis"]` - `amount_in_minor` integer, required: A 'cent' value representing the amount, e.g. 100 == 1GBP - `currency` 'GBP', required: The currency that the payout will be in. - `created_at` string, date, required: The date the transaction was created at, e.g. `"2024-05-07"` - PayoutDestinationServiceProvider - `type` 'service_provider', required: Type `service_provider`, paid to TrueLayer's internal account. - `metadata` Metadata: Optional field for adding custom key-value data to a resource. This object can contain a maximum of 10 key-value pairs, each with a key with a maximum length of 40 characters and a non-null value with a maximum length of 500 characters. - `scheme_id` 'faster_payments_service' | 'sepa_credit_transfer' | 'sepa_credit_transfer_instant' | 'polish_domestic_standard' | 'polish_domestic_express' | 'norwegian_domestic_credit_transfer' - `created_at` string, date-time, required: The date and time the payout was created at - `status` 'pending', required - PayoutAuthorizationRequired: The payout has been created against TrueLayer's API but it needs an action from the end user to proceed to next stages. - `id` string, required: Unique ID for the Payout - `merchant_account_id` string, uuid, required: Unique ID for the Merchant Account - `amount_in_minor` integer, required: A 'cent' value representing the amount, e.g. 100 == 1GBP - `currency` 'GBP' | 'EUR' | 'PLN', required - `beneficiary` union, required - PayoutDestinationExternalAccount: The routing information for an external bank account. - `type` 'external_account', required: Type `external_account` - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - `account_holder_name` string, required: The name of the external account holder. - `account_identifiers` AccountIdentifier[] - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - `account_holder_verification` union - AccountHolderVerificationCompleted - `id` string, uuid, required - `status` 'completed', required: A match result was returned. - `match_result` union, required - … - AccountHolderVerificationFailed - `id` string, uuid, required - `status` 'failed', required: A match result was not returned. - `failure_reason` string, required: The reason why the verification failed. There can be many reasons for this, for example: - `VoP scheme provider error`: Failure with one of the providers in the scheme - likely to be transitory. - `Internal error`: An internal error occurred while processing the request. - PayoutDestinationVerifiedExternalAccount: Payout response for an external account using a previously completed verification. The beneficiary details (name and account identifier) are retrieved from the verification. - `type` 'verified_external_account', required: Type `verified_external_account` - `account_holder_verification_id` string, uuid, required: The ID of the account holder verification - `account_holder_name` string, required: The name of the external account holder (retrieved from verification) - `account_identifiers` AccountIdentifier[], required - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - PayoutDestinationPaymentSource - `type` 'payment_source', required: Type `payment_source` - `payment_source_id` string, required: ID of the external account which has become a payment source - `user_id` string, required: ID of the owning user of the external account - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - `account_holder_name` string, required: The name of the account holder. - `account_identifiers` AccountIdentifier[], required - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - PayoutDestinationBusinessAccount - `type` 'business_account', required: Type `business_account` - `account_holder_name` string, required: The name of the external account holder. - `account_identifiers` AccountIdentifier[], required - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - PayoutDestinationUserDetermined: User determined beneficiary details - `type` 'user_determined', required: Type `user_determined` - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - `user` PaymentUser, required - `id` string, required: Unique ID for the User - `account_holder_name` string: The name of the account holder. - `account_identifiers` AccountIdentifier[] - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - `verification` PayoutBeneficiaryVerification: Object that describes the verification checks that were request for the payout. - `verify_name` boolean: Whether to verify the account holder name. - `transaction_search_criteria` PayoutBeneficiaryVerificationTransactionSearchCriteria: An object describing the search criteria to use to look for a transaction in the transaction history of the bank account connected to the end user - `tokens` string[], required: A list of tokens to look for as transaction reference. The size of this array can vary between 1 and 5 items. Each item should present minimum 3 and maximum 50 characters, including spaces. We recommend adding the merchant's name and an identifier in the transaction's description. e.g. `["18db38", "Betropolis LTD", "LC Betropolis"]` - `amount_in_minor` integer, required: A 'cent' value representing the amount, e.g. 100 == 1GBP - `currency` 'GBP', required: The currency that the payout will be in. - `created_at` string, date, required: The date the transaction was created at, e.g. `"2024-05-07"` - PayoutDestinationServiceProvider - `type` 'service_provider', required: Type `service_provider`, paid to TrueLayer's internal account. - `metadata` Metadata: Optional field for adding custom key-value data to a resource. This object can contain a maximum of 10 key-value pairs, each with a key with a maximum length of 40 characters and a non-null value with a maximum length of 500 characters. - `scheme_id` 'faster_payments_service' | 'sepa_credit_transfer' | 'sepa_credit_transfer_instant' | 'polish_domestic_standard' | 'polish_domestic_express' | 'norwegian_domestic_credit_transfer' - `created_at` string, date-time, required: The date and time the payout was created at - `status` 'authorization_required', required - PayoutAuthorizing: The payout has been created against TrueLayer's API and the associated authorization flow in progress. - `id` string, required: Unique ID for the Payout - `merchant_account_id` string, uuid, required: Unique ID for the Merchant Account - `amount_in_minor` integer, required: A 'cent' value representing the amount, e.g. 100 == 1GBP - `currency` 'GBP' | 'EUR' | 'PLN', required - `beneficiary` union, required - PayoutDestinationExternalAccount: The routing information for an external bank account. - `type` 'external_account', required: Type `external_account` - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - `account_holder_name` string, required: The name of the external account holder. - `account_identifiers` AccountIdentifier[] - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - `account_holder_verification` union - AccountHolderVerificationCompleted - `id` string, uuid, required - `status` 'completed', required: A match result was returned. - `match_result` union, required - … - AccountHolderVerificationFailed - `id` string, uuid, required - `status` 'failed', required: A match result was not returned. - `failure_reason` string, required: The reason why the verification failed. There can be many reasons for this, for example: - `VoP scheme provider error`: Failure with one of the providers in the scheme - likely to be transitory. - `Internal error`: An internal error occurred while processing the request. - PayoutDestinationVerifiedExternalAccount: Payout response for an external account using a previously completed verification. The beneficiary details (name and account identifier) are retrieved from the verification. - `type` 'verified_external_account', required: Type `verified_external_account` - `account_holder_verification_id` string, uuid, required: The ID of the account holder verification - `account_holder_name` string, required: The name of the external account holder (retrieved from verification) - `account_identifiers` AccountIdentifier[], required - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - PayoutDestinationPaymentSource - `type` 'payment_source', required: Type `payment_source` - `payment_source_id` string, required: ID of the external account which has become a payment source - `user_id` string, required: ID of the owning user of the external account - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - `account_holder_name` string, required: The name of the account holder. - `account_identifiers` AccountIdentifier[], required - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - PayoutDestinationBusinessAccount - `type` 'business_account', required: Type `business_account` - `account_holder_name` string, required: The name of the external account holder. - `account_identifiers` AccountIdentifier[], required - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - PayoutDestinationUserDetermined: User determined beneficiary details - `type` 'user_determined', required: Type `user_determined` - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - `user` PaymentUser, required - `id` string, required: Unique ID for the User - `account_holder_name` string: The name of the account holder. - `account_identifiers` AccountIdentifier[] - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - `verification` PayoutBeneficiaryVerification: Object that describes the verification checks that were request for the payout. - `verify_name` boolean: Whether to verify the account holder name. - `transaction_search_criteria` PayoutBeneficiaryVerificationTransactionSearchCriteria: An object describing the search criteria to use to look for a transaction in the transaction history of the bank account connected to the end user - `tokens` string[], required: A list of tokens to look for as transaction reference. The size of this array can vary between 1 and 5 items. Each item should present minimum 3 and maximum 50 characters, including spaces. We recommend adding the merchant's name and an identifier in the transaction's description. e.g. `["18db38", "Betropolis LTD", "LC Betropolis"]` - `amount_in_minor` integer, required: A 'cent' value representing the amount, e.g. 100 == 1GBP - `currency` 'GBP', required: The currency that the payout will be in. - `created_at` string, date, required: The date the transaction was created at, e.g. `"2024-05-07"` - PayoutDestinationServiceProvider - `type` 'service_provider', required: Type `service_provider`, paid to TrueLayer's internal account. - `metadata` Metadata: Optional field for adding custom key-value data to a resource. This object can contain a maximum of 10 key-value pairs, each with a key with a maximum length of 40 characters and a non-null value with a maximum length of 500 characters. - `scheme_id` 'faster_payments_service' | 'sepa_credit_transfer' | 'sepa_credit_transfer_instant' | 'polish_domestic_standard' | 'polish_domestic_express' | 'norwegian_domestic_credit_transfer' - `created_at` string, date-time, required: The date and time the payout was created at - `status` 'authorizing', required - PayoutAuthorized: The payout has been authorized (i.e. there are enough funds) and it has been submitted to the payment scheme for execution. - `id` string, required: Unique ID for the Payout - `merchant_account_id` string, uuid, required: Unique ID for the Merchant Account - `amount_in_minor` integer, required: A 'cent' value representing the amount, e.g. 100 == 1GBP - `currency` 'GBP' | 'EUR' | 'PLN', required - `beneficiary` union, required - PayoutDestinationExternalAccount: The routing information for an external bank account. - `type` 'external_account', required: Type `external_account` - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - `account_holder_name` string, required: The name of the external account holder. - `account_identifiers` AccountIdentifier[] - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - `account_holder_verification` union - AccountHolderVerificationCompleted - `id` string, uuid, required - `status` 'completed', required: A match result was returned. - `match_result` union, required - … - AccountHolderVerificationFailed - `id` string, uuid, required - `status` 'failed', required: A match result was not returned. - `failure_reason` string, required: The reason why the verification failed. There can be many reasons for this, for example: - `VoP scheme provider error`: Failure with one of the providers in the scheme - likely to be transitory. - `Internal error`: An internal error occurred while processing the request. - PayoutDestinationVerifiedExternalAccount: Payout response for an external account using a previously completed verification. The beneficiary details (name and account identifier) are retrieved from the verification. - `type` 'verified_external_account', required: Type `verified_external_account` - `account_holder_verification_id` string, uuid, required: The ID of the account holder verification - `account_holder_name` string, required: The name of the external account holder (retrieved from verification) - `account_identifiers` AccountIdentifier[], required - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - PayoutDestinationPaymentSource - `type` 'payment_source', required: Type `payment_source` - `payment_source_id` string, required: ID of the external account which has become a payment source - `user_id` string, required: ID of the owning user of the external account - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - `account_holder_name` string, required: The name of the account holder. - `account_identifiers` AccountIdentifier[], required - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - PayoutDestinationBusinessAccount - `type` 'business_account', required: Type `business_account` - `account_holder_name` string, required: The name of the external account holder. - `account_identifiers` AccountIdentifier[], required - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - PayoutDestinationUserDetermined: User determined beneficiary details - `type` 'user_determined', required: Type `user_determined` - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - `user` PaymentUser, required - `id` string, required: Unique ID for the User - `account_holder_name` string: The name of the account holder. - `account_identifiers` AccountIdentifier[] - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - `verification` PayoutBeneficiaryVerification: Object that describes the verification checks that were request for the payout. - `verify_name` boolean: Whether to verify the account holder name. - `transaction_search_criteria` PayoutBeneficiaryVerificationTransactionSearchCriteria: An object describing the search criteria to use to look for a transaction in the transaction history of the bank account connected to the end user - `tokens` string[], required: A list of tokens to look for as transaction reference. The size of this array can vary between 1 and 5 items. Each item should present minimum 3 and maximum 50 characters, including spaces. We recommend adding the merchant's name and an identifier in the transaction's description. e.g. `["18db38", "Betropolis LTD", "LC Betropolis"]` - `amount_in_minor` integer, required: A 'cent' value representing the amount, e.g. 100 == 1GBP - `currency` 'GBP', required: The currency that the payout will be in. - `created_at` string, date, required: The date the transaction was created at, e.g. `"2024-05-07"` - PayoutDestinationServiceProvider - `type` 'service_provider', required: Type `service_provider`, paid to TrueLayer's internal account. - `metadata` Metadata: Optional field for adding custom key-value data to a resource. This object can contain a maximum of 10 key-value pairs, each with a key with a maximum length of 40 characters and a non-null value with a maximum length of 500 characters. - `scheme_id` 'faster_payments_service' | 'sepa_credit_transfer' | 'sepa_credit_transfer_instant' | 'polish_domestic_standard' | 'polish_domestic_express' | 'norwegian_domestic_credit_transfer' - `created_at` string, date-time, required: The date and time the payout was created at - `status` 'authorized', required - PayoutExecuted: The payout was executed - the funds have left your merchant account. - `id` string, required: Unique ID for the Payout - `merchant_account_id` string, uuid, required: Unique ID for the Merchant Account - `amount_in_minor` integer, required: A 'cent' value representing the amount, e.g. 100 == 1GBP - `currency` 'GBP' | 'EUR' | 'PLN', required - `beneficiary` union, required - PayoutDestinationExternalAccount: The routing information for an external bank account. - `type` 'external_account', required: Type `external_account` - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - `account_holder_name` string, required: The name of the external account holder. - `account_identifiers` AccountIdentifier[] - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - `account_holder_verification` union - AccountHolderVerificationCompleted - `id` string, uuid, required - `status` 'completed', required: A match result was returned. - `match_result` union, required - … - AccountHolderVerificationFailed - `id` string, uuid, required - `status` 'failed', required: A match result was not returned. - `failure_reason` string, required: The reason why the verification failed. There can be many reasons for this, for example: - `VoP scheme provider error`: Failure with one of the providers in the scheme - likely to be transitory. - `Internal error`: An internal error occurred while processing the request. - PayoutDestinationVerifiedExternalAccount: Payout response for an external account using a previously completed verification. The beneficiary details (name and account identifier) are retrieved from the verification. - `type` 'verified_external_account', required: Type `verified_external_account` - `account_holder_verification_id` string, uuid, required: The ID of the account holder verification - `account_holder_name` string, required: The name of the external account holder (retrieved from verification) - `account_identifiers` AccountIdentifier[], required - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - PayoutDestinationPaymentSource - `type` 'payment_source', required: Type `payment_source` - `payment_source_id` string, required: ID of the external account which has become a payment source - `user_id` string, required: ID of the owning user of the external account - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - `account_holder_name` string, required: The name of the account holder. - `account_identifiers` AccountIdentifier[], required - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - PayoutDestinationBusinessAccount - `type` 'business_account', required: Type `business_account` - `account_holder_name` string, required: The name of the external account holder. - `account_identifiers` AccountIdentifier[], required - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - PayoutDestinationUserDetermined: User determined beneficiary details - `type` 'user_determined', required: Type `user_determined` - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - `user` PaymentUser, required - `id` string, required: Unique ID for the User - `account_holder_name` string: The name of the account holder. - `account_identifiers` AccountIdentifier[] - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - `verification` PayoutBeneficiaryVerification: Object that describes the verification checks that were request for the payout. - `verify_name` boolean: Whether to verify the account holder name. - `transaction_search_criteria` PayoutBeneficiaryVerificationTransactionSearchCriteria: An object describing the search criteria to use to look for a transaction in the transaction history of the bank account connected to the end user - `tokens` string[], required: A list of tokens to look for as transaction reference. The size of this array can vary between 1 and 5 items. Each item should present minimum 3 and maximum 50 characters, including spaces. We recommend adding the merchant's name and an identifier in the transaction's description. e.g. `["18db38", "Betropolis LTD", "LC Betropolis"]` - `amount_in_minor` integer, required: A 'cent' value representing the amount, e.g. 100 == 1GBP - `currency` 'GBP', required: The currency that the payout will be in. - `created_at` string, date, required: The date the transaction was created at, e.g. `"2024-05-07"` - PayoutDestinationServiceProvider - `type` 'service_provider', required: Type `service_provider`, paid to TrueLayer's internal account. - `metadata` Metadata: Optional field for adding custom key-value data to a resource. This object can contain a maximum of 10 key-value pairs, each with a key with a maximum length of 40 characters and a non-null value with a maximum length of 500 characters. - `scheme_id` 'faster_payments_service' | 'sepa_credit_transfer' | 'sepa_credit_transfer_instant' | 'polish_domestic_standard' | 'polish_domestic_express' | 'norwegian_domestic_credit_transfer' - `created_at` string, date-time, required: The date and time the payout was created at - `status` 'executed', required - `executed_at` string, datetime, required: The date and time the payout transitioned to `executed` - PayoutFailed: The payout failed - the funds have not left your merchant account. - `id` string, required: Unique ID for the Payout - `merchant_account_id` string, uuid, required: Unique ID for the Merchant Account - `amount_in_minor` integer, required: A 'cent' value representing the amount, e.g. 100 == 1GBP - `currency` 'GBP' | 'EUR' | 'PLN', required - `beneficiary` union, required - PayoutDestinationExternalAccount: The routing information for an external bank account. - `type` 'external_account', required: Type `external_account` - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - `account_holder_name` string, required: The name of the external account holder. - `account_identifiers` AccountIdentifier[] - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - `account_holder_verification` union - AccountHolderVerificationCompleted - `id` string, uuid, required - `status` 'completed', required: A match result was returned. - `match_result` union, required - … - AccountHolderVerificationFailed - `id` string, uuid, required - `status` 'failed', required: A match result was not returned. - `failure_reason` string, required: The reason why the verification failed. There can be many reasons for this, for example: - `VoP scheme provider error`: Failure with one of the providers in the scheme - likely to be transitory. - `Internal error`: An internal error occurred while processing the request. - PayoutDestinationVerifiedExternalAccount: Payout response for an external account using a previously completed verification. The beneficiary details (name and account identifier) are retrieved from the verification. - `type` 'verified_external_account', required: Type `verified_external_account` - `account_holder_verification_id` string, uuid, required: The ID of the account holder verification - `account_holder_name` string, required: The name of the external account holder (retrieved from verification) - `account_identifiers` AccountIdentifier[], required - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - PayoutDestinationPaymentSource - `type` 'payment_source', required: Type `payment_source` - `payment_source_id` string, required: ID of the external account which has become a payment source - `user_id` string, required: ID of the owning user of the external account - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - `account_holder_name` string, required: The name of the account holder. - `account_identifiers` AccountIdentifier[], required - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - PayoutDestinationBusinessAccount - `type` 'business_account', required: Type `business_account` - `account_holder_name` string, required: The name of the external account holder. - `account_identifiers` AccountIdentifier[], required - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - PayoutDestinationUserDetermined: User determined beneficiary details - `type` 'user_determined', required: Type `user_determined` - `reference` string, required: The reference for the payout, which displays in the beneficiary's bank statement. For SEPA payments, the maximum length is **140 characters**. The format must respect the requirements specified [here](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). For FPS payments, the maximum length is **18 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;{@\r\n]*$` For Elixir payments, the maximum length is **20 characters**. The format must respect this regex: `^[a-zA-Z0-9\/\-?:().,'+\s]*$` - `user` PaymentUser, required - `id` string, required: Unique ID for the User - `account_holder_name` string: The name of the account holder. - `account_identifiers` AccountIdentifier[] - union: A unique scheme identifier for an external account. - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes. - … - AccountIdentifierIban: The international bank account number. - … - AccountIdentifierNrb: The scheme identifier for a bank account participating in Poland's payment schemes. - … - `verification` PayoutBeneficiaryVerification: Object that describes the verification checks that were request for the payout. - `verify_name` boolean: Whether to verify the account holder name. - `transaction_search_criteria` PayoutBeneficiaryVerificationTransactionSearchCriteria: An object describing the search criteria to use to look for a transaction in the transaction history of the bank account connected to the end user - `tokens` string[], required: A list of tokens to look for as transaction reference. The size of this array can vary between 1 and 5 items. Each item should present minimum 3 and maximum 50 characters, including spaces. We recommend adding the merchant's name and an identifier in the transaction's description. e.g. `["18db38", "Betropolis LTD", "LC Betropolis"]` - `amount_in_minor` integer, required: A 'cent' value representing the amount, e.g. 100 == 1GBP - `currency` 'GBP', required: The currency that the payout will be in. - `created_at` string, date, required: The date the transaction was created at, e.g. `"2024-05-07"` - PayoutDestinationServiceProvider - `type` 'service_provider', required: Type `service_provider`, paid to TrueLayer's internal account. - `metadata` Metadata: Optional field for adding custom key-value data to a resource. This object can contain a maximum of 10 key-value pairs, each with a key with a maximum length of 40 characters and a non-null value with a maximum length of 500 characters. - `scheme_id` 'faster_payments_service' | 'sepa_credit_transfer' | 'sepa_credit_transfer_instant' | 'polish_domestic_standard' | 'polish_domestic_express' | 'norwegian_domestic_credit_transfer' - `created_at` string, date-time, required: The date and time the payout was created at - `status` 'failed', required - `executed_at` string, datetime: The date and time the payout transitioned to `executed` - `failed_at` string, datetime, required: The date and time the payout transitioned to `failed` - `failure_reason` string, required: The reason the outbound payment failed. Example values to expect: - `insufficient_funds` - `scheme_error` - `server_error` - `blocked` - `returned` - `account_not_valid`: the bank accounts associated with the given AIS consent are not valid. Note that this error is only relevant for `user_determined` beneficiaries. - `expired`: the user did not authorize the payout within the required timeframe. This error applies only to `user_determined` beneficiaries. - `verification_name_mismatch`: the name provided as part of a payout verification does not match the one available on the connected bank account - `verification_transaction_not_found`: the transaction details provided as part of a payout verification are not found within the associated bank account's transactions - `invalid_iban`: the beneficiary IBAN is invalid - `invalid_scan`: the beneficiary SCAN is invalid - `reversed`: the payment was reversed after settling - `unknown`: the failure could not be classified into a more specific reason Clients should handle unexpected values gracefully as a unknown failure. ## Other responses - `401`: Unauthenticated - `403`: Forbidden - `404`: Payout Not Found - `500`: Unknown Error --- [API](https://skmtc.dev/truelayer/apis/payments-api-v3.md) - [All operations](https://skmtc.dev/truelayer/apis/payments-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/truelayer/apis/payments-api-v3/revisions/a7c585fc9b84?raw)