curl -X POST 'https://api.yativo.com/api/v1/beneficiaries' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET' \
-H 'Content-Type: application/json' \
-d '{
"recipient_type": "individual",
"customer_name": "Maria Gonzalez",
"customer_email": "maria.gonzalez@example.com",
"customer_address": "123 Main Street, Santiago",
"country": "CHL",
"customer_nickname": "Maria"
}'
{
"status": "success",
"data": {
"id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
"user_id": "usr-001",
"recipient_type": "individual",
"customer_name": "Maria Gonzalez",
"customer_email": "maria.gonzalez@example.com",
"customer_nickname": "Maria",
"country": "CHL",
"customer_address": "123 Main Street, Santiago",
"is_archived": false,
"created_at": "2026-04-02T10:00:00.000000Z",
"updated_at": "2026-04-02T10:00:00.000000Z"
}
}
Create Beneficiary
Create a new beneficiary for sending payments
POST
/
beneficiaries
curl -X POST 'https://api.yativo.com/api/v1/beneficiaries' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET' \
-H 'Content-Type: application/json' \
-d '{
"recipient_type": "individual",
"customer_name": "Maria Gonzalez",
"customer_email": "maria.gonzalez@example.com",
"customer_address": "123 Main Street, Santiago",
"country": "CHL",
"customer_nickname": "Maria"
}'
{
"status": "success",
"data": {
"id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
"user_id": "usr-001",
"recipient_type": "individual",
"customer_name": "Maria Gonzalez",
"customer_email": "maria.gonzalez@example.com",
"customer_nickname": "Maria",
"country": "CHL",
"customer_address": "123 Main Street, Santiago",
"is_archived": false,
"created_at": "2026-04-02T10:00:00.000000Z",
"updated_at": "2026-04-02T10:00:00.000000Z"
}
}
Create a beneficiary record to store recipient information for future payouts. After creating a beneficiary, add their payment method details using the payment methods endpoint.
POST /v1/beneficiaries
Requires an
Idempotency-Key header.curl -X POST 'https://api.yativo.com/api/v1/beneficiaries' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET' \
-H 'Content-Type: application/json' \
-d '{
"recipient_type": "individual",
"customer_name": "Maria Gonzalez",
"customer_email": "maria.gonzalez@example.com",
"customer_address": "123 Main Street, Santiago",
"country": "CHL",
"customer_nickname": "Maria"
}'
{
"status": "success",
"data": {
"id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
"user_id": "usr-001",
"recipient_type": "individual",
"customer_name": "Maria Gonzalez",
"customer_email": "maria.gonzalez@example.com",
"customer_nickname": "Maria",
"country": "CHL",
"customer_address": "123 Main Street, Santiago",
"is_archived": false,
"created_at": "2026-04-02T10:00:00.000000Z",
"updated_at": "2026-04-02T10: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.
Headers
A unique string per request to ensure idempotent processing.
Body
application/json
Beneficiary type: "individual" or "business".
Available options:
individual, business Full name of the beneficiary (individual) or legal business name.
Beneficiary's email address.
Beneficiary's physical address.
Beneficiary's country code (e.g. CHL, MEX, BRA).
A short label for this beneficiary. Defaults to customer_name if omitted.