API Reference
Asset librariesConsole

Create payout

post
https://api.truelayer-sandbox.com/v3/payouts

Pay out from one of your merchant accounts.

📘

Endpoint path changes

All Payments API v3 endpoints now start with /v3/. The old endpoints still work, but you must use the new path for all new integrations.

Body Params
uuid
required

Unique ID for the Merchant Account

integer
required
≥ 1

A 'cent' value representing the amount. eg 100 == 1GBP

string
enum
required
Allowed:
beneficiary
required
scheme_selection
sub_merchants
object

The details related to any applicable sub-merchants, for example a partner you are working with.

metadata
object

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.

Headers
string
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.

string
required

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

string
enum
Defaults to application/json; charset=UTF-8

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json; charset=UTF-8
application/problem+json; charset=UTF-8

Updated about 1 month ago