TRtruelayer
Payouts

Create payout

Pay out from one of your merchant accounts.

post/v3/payouts

Request

  • Base URL
    https://api.truelayer-sandbox.com
  • URL
    https://api.truelayer-sandbox.com/v3/payouts
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://auth.truelayer.com/connect/token scopes: payments
    • or OAuth 2
      Client credentials
      Token URL: https://auth.truelayer.com/connect/token scopes: payments:payout:business_account

Headers

Idempotency-Keystring required

An idempotency key to allow safe retrying without the operation being performed multiple times. The value should be unique for each operation, e.g. a UUID, with the same key being sent on a retry of the same request.

Tl-Signaturestring required

A JWS with detached content, signed with your private key. See Request Signing

Request body

merchant_account_idstring uuid required

Unique ID for the Merchant Account

amount_in_minorinteger required

A 'cent' value representing the amount, e.g. 100 == 1GBP

currency'GBP' | 'EUR' | 'PLN' required
metadataMetadata

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.

Example request

{
  "merchant_account_id": "AB8FA060-3F1B-4AE8-9692-4AA3131020D0",
  "currency": "GBP",
  "beneficiary": {
    "account_identifier": {
      "sort_code": "560029",
      "account_number": "26207729"
    },
    "date_of_birth": "1990-01-31",
    "address": {
      "address_line1": "40 Finsbury Square",
      "address_line2": "The Gilbert",
      "city": "London",
      "state": "London",
      "zip": "EC2A 1PX",
      "country_code": "GB"
    }
  },
  "sub_merchants": {
    "ultimate_counterparty": {
      "url": "https://truelayer.com",
      "mcc": "1234",
      "address": {
        "address_line1": "40 Finsbury Square",
        "address_line2": "The Gilbert",
        "city": "London",
        "state": "London",
        "zip": "EC2A 1PX",
        "country_code": "GB"
      }
    }
  },
  "metadata": {
    "prop1": "value1",
    "prop2": "value2"
  }
}

Response

Payout

OR

Example response

{
  "id": "0cd1b0f7-71bc-4d24-b209-95259dadcc20"
}

Changes

No recorded changes to this operation across all 1 revision of this API.