curl -X GET 'https://api.yativo.com/api/v1/beneficiary/form/show/42' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET'
{
"gateway_id": 42,
"currency": "CLP",
"form_data": [
{
"key": "account_number",
"label": "Account Number",
"type": "text",
"required": true
},
{
"key": "bank_code",
"label": "Bank",
"type": "select",
"required": true,
"options": [
{ "value": "001", "label": "Banco de Chile" },
{ "value": "009", "label": "Banco Internacional" }
]
},
{
"key": "account_type",
"label": "Account Type",
"type": "select",
"required": true,
"options": [
{ "value": "checking", "label": "Checking Account" },
{ "value": "savings", "label": "Savings Account" }
]
},
{
"key": "rut",
"label": "RUT (Chilean Tax ID)",
"type": "text",
"required": true
}
],
"created_at": "2026-04-01T10:00:00.000000Z",
"updated_at": "2026-04-01T10:00:00.000000Z"
}
{
"gateway_id": 15,
"currency": "MXN",
"form_data": [
{
"key": "clabe",
"label": "CLABE",
"type": "text",
"required": true
}
],
"created_at": "2026-04-01T10:00:00.000000Z",
"updated_at": "2026-04-01T10:00:00.000000Z"
}
Payments & Transfers
Get Payout Form Fields
Retrieve the required form fields for a specific payout method
GET
/
beneficiary
/
form
/
show
/
{payment_method_id}
curl -X GET 'https://api.yativo.com/api/v1/beneficiary/form/show/42' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET'
{
"gateway_id": 42,
"currency": "CLP",
"form_data": [
{
"key": "account_number",
"label": "Account Number",
"type": "text",
"required": true
},
{
"key": "bank_code",
"label": "Bank",
"type": "select",
"required": true,
"options": [
{ "value": "001", "label": "Banco de Chile" },
{ "value": "009", "label": "Banco Internacional" }
]
},
{
"key": "account_type",
"label": "Account Type",
"type": "select",
"required": true,
"options": [
{ "value": "checking", "label": "Checking Account" },
{ "value": "savings", "label": "Savings Account" }
]
},
{
"key": "rut",
"label": "RUT (Chilean Tax ID)",
"type": "text",
"required": true
}
],
"created_at": "2026-04-01T10:00:00.000000Z",
"updated_at": "2026-04-01T10:00:00.000000Z"
}
{
"gateway_id": 15,
"currency": "MXN",
"form_data": [
{
"key": "clabe",
"label": "CLABE",
"type": "text",
"required": true
}
],
"created_at": "2026-04-01T10:00:00.000000Z",
"updated_at": "2026-04-01T10:00:00.000000Z"
}
Returns the dynamic form fields required to add a beneficiary payment method or execute a payout. Fields vary by country and payment method.
GET /beneficiary/form/show/{payment_method_id}
curl -X GET 'https://api.yativo.com/api/v1/beneficiary/form/show/42' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET'
{
"gateway_id": 42,
"currency": "CLP",
"form_data": [
{
"key": "account_number",
"label": "Account Number",
"type": "text",
"required": true
},
{
"key": "bank_code",
"label": "Bank",
"type": "select",
"required": true,
"options": [
{ "value": "001", "label": "Banco de Chile" },
{ "value": "009", "label": "Banco Internacional" }
]
},
{
"key": "account_type",
"label": "Account Type",
"type": "select",
"required": true,
"options": [
{ "value": "checking", "label": "Checking Account" },
{ "value": "savings", "label": "Savings Account" }
]
},
{
"key": "rut",
"label": "RUT (Chilean Tax ID)",
"type": "text",
"required": true
}
],
"created_at": "2026-04-01T10:00:00.000000Z",
"updated_at": "2026-04-01T10:00:00.000000Z"
}
{
"gateway_id": 15,
"currency": "MXN",
"form_data": [
{
"key": "clabe",
"label": "CLABE",
"type": "text",
"required": true
}
],
"created_at": "2026-04-01T10:00:00.000000Z",
"updated_at": "2026-04-01T10:00: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.
Path Parameters
The ID of the payment method, obtained from GET /payment-methods/payout.

