curl -X POST 'https://api.yativo.com/api/v1/beneficiaries/payment-methods' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: pm-create-001' \
-d '{
"gateway_id": 42,
"currency": "CLP",
"nickname": "Maria CLP Account",
"payment_data": {
"account_number": "12345678",
"bank_code": "001",
"account_type": "checking",
"rut": "12.345.678-9"
}
}'
curl -X POST 'https://api.yativo.com/api/v1/beneficiaries/payment-methods' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: pm-create-001' \
-d '{
"gateway_id": 15,
"currency": "MXN",
"nickname": "Tech Solutions SPEI",
"payment_data": {
"clabe": "012345678901234567"
}
}'
{
"status": "success",
"data": {
"id": "pm-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"user_id": "usr-001",
"gateway_id": 42,
"currency": "CLP",
"nickname": "Maria CLP Account",
"payment_data": {
"account_number": "12345678",
"bank_code": "001",
"account_type": "checking",
"rut": "12.345.678-9"
},
"beneficiary_id": null,
"created_at": "2026-04-02T10:30:00.000000Z",
"updated_at": "2026-04-02T10:30:00.000000Z"
}
}
Beneficiaries
Add Beneficiary
Save a recipient’s account details for one payout method
POST
/
beneficiaries
/
payment-methods
curl -X POST 'https://api.yativo.com/api/v1/beneficiaries/payment-methods' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: pm-create-001' \
-d '{
"gateway_id": 42,
"currency": "CLP",
"nickname": "Maria CLP Account",
"payment_data": {
"account_number": "12345678",
"bank_code": "001",
"account_type": "checking",
"rut": "12.345.678-9"
}
}'
curl -X POST 'https://api.yativo.com/api/v1/beneficiaries/payment-methods' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: pm-create-001' \
-d '{
"gateway_id": 15,
"currency": "MXN",
"nickname": "Tech Solutions SPEI",
"payment_data": {
"clabe": "012345678901234567"
}
}'
{
"status": "success",
"data": {
"id": "pm-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"user_id": "usr-001",
"gateway_id": 42,
"currency": "CLP",
"nickname": "Maria CLP Account",
"payment_data": {
"account_number": "12345678",
"bank_code": "001",
"account_type": "checking",
"rut": "12.345.678-9"
},
"beneficiary_id": null,
"created_at": "2026-04-02T10:30:00.000000Z",
"updated_at": "2026-04-02T10:30:00.000000Z"
}
}
Save a recipient’s account details as a beneficiary. The
payment_data fields depend on the payout method. Get them from GET /beneficiary/form/show/{payment_method_id}. Use the returned id in payouts and quotes.
POST /v1/beneficiaries/payment-methods
Requires an
Idempotency-Key header.Payment data examples
Chile — Bank Transfer
Chile — Bank Transfer
{
"account_number": "12345678",
"bank_code": "001",
"account_type": "checking",
"rut": "12.345.678-9"
}
Mexico — SPEI
Mexico — SPEI
{
"clabe": "012345678901234567"
}
Brazil — PIX / Bank Transfer
Brazil — PIX / Bank Transfer
{
"account_number": "12345-6",
"branch_number": "0001",
"bank_code": "341",
"account_type": "checking",
"cpf": "123.456.789-00"
}
curl -X POST 'https://api.yativo.com/api/v1/beneficiaries/payment-methods' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: pm-create-001' \
-d '{
"gateway_id": 42,
"currency": "CLP",
"nickname": "Maria CLP Account",
"payment_data": {
"account_number": "12345678",
"bank_code": "001",
"account_type": "checking",
"rut": "12.345.678-9"
}
}'
curl -X POST 'https://api.yativo.com/api/v1/beneficiaries/payment-methods' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: pm-create-001' \
-d '{
"gateway_id": 15,
"currency": "MXN",
"nickname": "Tech Solutions SPEI",
"payment_data": {
"clabe": "012345678901234567"
}
}'
{
"status": "success",
"data": {
"id": "pm-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"user_id": "usr-001",
"gateway_id": 42,
"currency": "CLP",
"nickname": "Maria CLP Account",
"payment_data": {
"account_number": "12345678",
"bank_code": "001",
"account_type": "checking",
"rut": "12.345.678-9"
},
"beneficiary_id": null,
"created_at": "2026-04-02T10:30:00.000000Z",
"updated_at": "2026-04-02T10:30:00.000000Z"
}
}
Authorizations
Your API key (yativo_pk_...) from Developers → API Keys. Send together with X-Api-Secret.
Your API secret (yativo_sk_...), shown once when the key is created.
Headers
A unique string per request to ensure idempotent processing.
Body
application/json
The ID of the payout method (gateway) to use. Obtain available IDs from the payout methods endpoint.
Key/value pairs of account details required for this payment method. The fields vary depending on the selected gateway_id.
Currency code for this payment method (e.g. CLP, MXN, BRL).
Example:
"CLP"
A label to identify this payment method.