Skip to main content
POST

Headers

​
X-Idempotency-Key
string<uuid>
required

Unique UUID per request. Prevents duplicate processing on retries.

Body

application/json
​
account_id
string<uuid>
required
​
merchant_reference
string
required
Required string length: 3 - 255
​
country
enum<string>
required

ISO 3166-1 alpha-2 country code

Available options:
AR,
BO,
BR,
CL,
CO,
CR,
EC,
SV,
GT,
HN,
MX,
NI,
PA,
PY,
PE,
US,
UY
​
purpose
enum<string>
required
Available options:
FAMILY_AND_FRIENDS,
PERSONAL_TRANSFER,
REMITTANCES,
PROVIDER_SERVICES,
EXPENSES,
REFUND,
SALARY,
PENSION,
LOAN,
DIVIDENDS
​
amount
object
required
​
beneficiary
object
required
​
withdrawal_method
object
required
​
description
string

Response

201 - application/json

Payout created

​
id
string<uuid>
​
merchant_reference
string
​
status
enum<string>
Available options:
SUCCEEDED,
PENDING,
DECLINED,
PROCESSING
​
amount
object
​
created_at
string<date-time>