Skip to main content
POST
Creates a payout. Returns the transaction in status CREATED. Processing continues asynchronously. Authenticate with the HMAC headers described in Conventions and Authentication. Query and path parameters: none.
string
required
API key. Alias: X-Client-Id.
string
required
Unix time in seconds. Must be within 600 s of server time.
string
required
Hex HMAC-SHA256 of X-Api-Key + X-Timestamp, keyed with the API secret. Upper or lower case hex. Alias: X-Secret-Key.
string
required
Unique id per request, e.g. a UUID.
string
required
application/json
Do not send X-User-Id or X-Source on this endpoint.

Body

string (UUID)
required
Non-zero UUID. Single use.
string
1 to 100 characters. Unique per client.
string
required
Crypto symbol, e.g. USDT. Case insensitive. No leading or trailing spaces. Must differ from to_currency.
string
required
INR
string (decimal)
required
Greater than 0, less than 10^18, at most 18 decimal places. Amount debited in from_currency.
string
required
bank_transfer. Case-sensitive.
string
1 to 100 characters.
string
Not supported. Must be omitted. Sending it returns 402011.
object
required
Exactly one of sender.id or sender.travel_rule_data.
object
required
Exactly one of beneficiary.id or beneficiary.travel_rule_data.
object
required
Exactly one of beneficiary_instrument.id or beneficiary_instrument.bank_account.

Party details (travel_rule_data)

Fields of sender.travel_rule_data and beneficiary.travel_rule_data.

Bank account (bank_account)

Fields of beneficiary_instrument.bank_account.

Response

201 Created. data is the transaction object.

Status and error codes

Full list in the Error List.