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.

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}

​
Path parameters

​
payment_method_id
number
required
The ID of the payment method, obtained from GET /payment-methods/payout.
curl -X GET 'https://api.yativo.com/api/v1/beneficiary/form/show/42' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": {
    "payment_method_id": 42,
    "method_name": "Bank Transfer",
    "country": "CHL",
    "fields": [
      {
        "key": "account_number",
        "label": "Account Number",
        "type": "text",
        "required": true,
        "max_length": 20
      },
      {
        "key": "bank_code",
        "label": "Bank",
        "type": "select",
        "required": true,
        "options": [
          { "value": "001", "label": "Banco de Chile" },
          { "value": "009", "label": "Banco Internacional" },
          { "value": "014", "label": "Scotiabank Chile" }
        ]
      },
      {
        "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
      }
    ]
  }
}