Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
default:""
required

ID of the payout

Body

application/json
source
string
required

ID of the collect to fund the payout

Response

200 - application/json
amount
number

Amount of the payout in payout currency

balance_transaction
string

ID of the balance transaction associated with this payout

beneficiary
string

Unique identifier of the payout beneficiary

beneficiary_details
object

Comprehensive beneficiary information including personal details and destination

charge_type
string

Type of charge (e.g., shared, ours, beneficiary)

confirmation_documents
array

List of confirmation documents uploaded for the payout

created_at
string

Timestamp when the payout was created

currency
string

Currency of the payout

documents
array

List of payout-related documents

holding_currency
string

Currency in which funds are held before conversion

holding_fx_transaction
object

Details of an FX conversion transaction

id
string

Unique payout ID

local
object

Local payout information

logistics_tracking_details
array

Tracking details for logistics-related payouts (if applicable). This is mandatory for CNY local payouts.

metadata
object | null

Custom metadata key-value pairs attached to the object

mt103
string

SWIFT MT103 reference number, if applicable

object
string

Type of object

on_behalf_of
string

Entity on whose behalf the payout is made

payout_fx_transaction
object

Details of an FX conversion transaction

purpose
string

Purpose code or reason for the payout

reference_id
string

External reference ID

source
string

Source collection ID for the payout

statement_descriptor
string

Statement descriptor shown on recipient’s statement

status
string

Current status of the payout

status_description
string

Additional status description

failure
object | null

Failure details of the payout. Only present when the payout has failed.

tracking_details
null

Tracking details if available

transaction_description
string

Description or purpose of the payout transaction

type
string

Type of payout (e.g., local, swift)