Skip to main content
Returns a paginated list of all beneficiaries associated with your account.
GET /v1/beneficiaries/list

Query parameters

per_page
number
Number of records per page (default: 20).
curl -X GET 'https://api.yativo.com/api/v1/beneficiaries/list?per_page=20' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
const response = await fetch('https://api.yativo.com/api/v1/beneficiaries/list?per_page=20', {
  headers: { 'Authorization': `Bearer ${token}` },
});
const data = await response.json();
{
  "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"
    },
    {
      "id": "8b9c0d1e-2f3a-4b5c-6d7e-8f9a0b1c2d3e",
      "user_id": "usr-001",
      "recipient_type": "business",
      "customer_name": "Tech Solutions SA",
      "customer_email": "payments@techsolutions.mx",
      "customer_nickname": "Tech Solutions",
      "country": "MEX",
      "customer_address": "789 Reforma Ave, Mexico City",
      "is_archived": false,
      "created_at": "2026-03-20T09:00:00.000000Z",
      "updated_at": "2026-03-20T09:00:00.000000Z"
    }
  ],
  "pagination": {
    "total": 45,
    "per_page": 20,
    "current_page": 1,
    "last_page": 3,
    "next_page_url": "https://api.yativo.com/api/v1/beneficiaries/list?page=2",
    "prev_page_url": null
  }
}