Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.yativo.com/llms.txt

Use this file to discover all available pages before exploring further.

Add a payment method to a beneficiary. The account_details object fields vary by country and payment method — use GET /beneficiary/form/show/{payment_method_id} to retrieve the required fields. 
POST /beneficiaries/payment-methods/
Requires Idempotency-Key header.

​
Request body

​
beneficiary_id
string
required
The UUID of the beneficiary to add the payment method to.
​
payment_method_id
number
required
The ID of the payment method. Obtained from GET /payment-methods/payout.
​
account_details
object
required
Key/value pairs of account details required for this payment method. Fields vary by country and payment method — retrieve the required fields from GET /beneficiary/form/show/{payment_method_id}.

​
Account details examples

{
  "account_number": "12345678",
  "bank_code": "001",
  "account_type": "checking",
  "rut": "12.345.678-9"
}

{
  "clabe": "012345678901234567"
}

{
  "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 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: add-pm-maria-chl-001' \
  -d '{
    "beneficiary_id": "ben-7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
    "payment_method_id": 42,
    "account_details": {
      "account_number": "12345678",
      "bank_code": "001",
      "account_type": "checking",
      "rut": "12.345.678-9"
    }
  }'

{
  "status": "success",
  "status_code": 201,
  "message": "Payment method added successfully",
  "data": {
    "id": 101,
    "beneficiary_id": "ben-7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
    "payment_method_id": 42,
    "method_name": "Bank Transfer",
    "currency": "CLP",
    "country": "CHL",
    "account_details": {
      "account_number": "12345678",
      "bank_code": "001",
      "account_type": "checking",
      "rut": "12.345.678-9"
    },
    "created_at": "2026-04-02T10:30:00.000000Z"
  }
}