Documentation
Console

Payouts API

Get up and running with the Payouts API.

Suggest Edits

❗️

This is a legacy product. The Payments API v3 is the latest version of the Payments API.

If you’re integrating with the Payments product for the first time, you must use v3. Legacy versions will not give you access to the latest product features we’re building, including Signup+.

Learn how to integrate with Payments API v3.

The TrueLayer Payouts API brings payout functionality to our payments platform. Using the API, you can execute payments to any IBAN connected to the Faster Payment Scheme.

Note that for access to the production API, you have to:

Note that all API endpoint URIs in this section are for the sandbox environment. If you wish to follow this guide using the production environment, make sure that you change the endpoint domain from truelayer-sandbox.com to truelayer.com.

Supported countries

Check out our list of banks available for Payouts in different countries.

Get your Client ID and Secret

To authenticate to our API you will need to use your Client ID and Secret for the environment you are using (Live or Sandbox). Both of these values can be found in the TrueLayer Console.

Follow our guide to setup Insomnia with our Insomnia collection .
It contains sample requests so that you can start using our payouts-api.

To upgrade your account to the live environment, you will need to give our Sales team your Client ID. In the sandbox area of the console follow these steps:

  1. Go to the Payments tab.
  2. Select Go to live environment.
  3. Go to the Settings tab.
  4. Copy the client ID field.

Authenticate to use the API

Use our authentication server to obtain a client credentials grant.
You will need to use this on your requests to the Payouts API.

curl -X POST \
    -d grant_type=client_credentials \
    -d client_id=${client_id} \
    -d client_secret=${client_secret} \
    -d scope=payouts \
    https://auth.truelayer-sandbox.com/connect/token

{
  "access_token": "JWT-ACCESS-TOKEN-HERE",
  "expires_in": 3600,
  "token_type": "Bearer"
}

Updated 7 months ago