Get Beneficiaries

GET {{baseUrl}}/beneficiaries/list

Description

This endpoint retrieves a list of beneficiaries associated with the authenticated user. Beneficiaries are the recipients of payments or transfers, and their details are stored in the system for ease of transactions.

Request

Headers

• Authorization: Bearer YOUR_ACCESS_TOKEN

Get Beneficiaries

get

The endpoint retrieves a list of beneficiaries.

The response for this request can be documented as a JSON schema:

{
    "type": "object",
    "properties": {
        "status": {"type": "string"},
        "status_code": {"type": "integer"},
        "message": {"type": "string"},
        "data": {
            "type": "object",
            "properties": {
                "current_page": {"type": "integer"},
                "data": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "id": {"type": "integer"},
                            "user_id": {"type": "integer"},
                            "nickname": {"type": "string"},
                            "mode": {"type": "string"},
                            "currency": {"type": "string"},
                            "address": {
                                "type": "object",
                                "properties": {
                                    "city": {"type": "string"},
                                    "state": {"type": "string"},
                                    "country": {"type": "string"},
                                    "postal_code": {"type": "string"}
                                }
                            },
                            "beneficiary": {
                                "type": "object",
                                "properties": {
                                    "name": {"type": "string"},
                                    "email": {"type": "string"}
                                }
                            },
                            "payment_object": {
                                "type": "object",
                                "properties": {
                                    "bank_name": {"type": "string"},
                                    "bank_code": {"type": "string"},
                                    "account_number": {"type": "string"},
                                    "account_name": {"type": "string"}
                                }
                            },
                            "created_at": {"type": "string"},
                            "updated_at": {"type": "string"},
                            "deleted_at": {"type": ["string", "null"]}
                        }
                    }
                },
                "first_page_url": {"type": "string"},
                "from": {"type": "integer"},
                "last_page": {"type": "integer"},
                "last_page_url": {"type": "string"},
                "links": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "url": {"type": ["string", "null"]},
                            "label": {"type": "string"},
                            "active": {"type": "boolean"}
                        }
                    }
                },
                "next_page_url": {"type": ["string", "null"]},
                "path": {"type": "string"},
                "per_page": {"type": "integer"},
                "prev_page_url": {"type": ["string", "null"]},
                "to": {"type": "integer"},
                "total": {"type": "integer"}
            }
        }
    }
}

Authorizations

Responses

Responseall of

and

anyOptionalExample: {"status":"success","status_code":200,"message":"Request successful","data":{"current_page":1,"data":[{"id":1,"user_id":2,"nickname":"John Doe Zenith bank","mode":"unknown","currency":"NGN","address":{"city":"Lugbe","state":"FCT - Abuja","country":"Nigeria","postal_code":"900709"},"beneficiary":{"name":"Yativo Smith","email":"[e-mail]"},"payment_object":{"bank_name":"Access bank","bank_code":"044","account_number":"0719841763","account_name":"Yativo Smith"},"created_at":"2024-02-06T21:07:39.000000Z","updated_at":"2024-02-06T21:07:39.000000Z","deleted_at":null},{"id":2,"user_id":2,"nickname":"Monnet CLP (Success Tests 1)","mode":"monnet","currency":"CLP","address":{"name":"Miguel Perez","city":"Lugbe","state":"FCT - Abuja","country":"Nigeria","postal_code":"900709"},"beneficiary":{"name":"Miguel Perez","email":"[e-mail]","document":{"type":1,"number":"10366311-3"}},"payment_object":{"bankAccount":{"bankCode":"001","accountType":1,"accountNumber":"2661901"}},"created_at":"2024-03-02T08:54:25.000000Z","updated_at":"2024-03-02T08:54:25.000000Z","deleted_at":null},{"id":3,"user_id":2,"nickname":"Monnet CLP (Success Tests 1)","mode":"monnet","currency":"CLP","address":{"name":"Miguel Perez","city":"Lugbe","state":"FCT - Abuja","country":"Nigeria","postal_code":"900709"},"beneficiary":{"name":"Miguel Perez","email":"[e-mail]","document":{"type":1,"number":"10366311-3"}},"payment_object":{"bankAccount":{"bankCode":"001","accountType":1,"accountNumber":"2661901"}},"created_at":"2024-03-02T10:04:32.000000Z","updated_at":"2024-03-02T10:04:32.000000Z","deleted_at":null},{"id":4,"user_id":2,"nickname":"Monnet CLP (Success Tests 1)","mode":"monnet","currency":"CLP","address":{"name":"Miguel Perez","city":"Lugbe","state":"FCT - Abuja","country":"Nigeria","postal_code":"900709"},"beneficiary":{"name":"Miguel Perez","lastName":"Perez","email":"[e-mail]","document":{"type":1,"number":"10366311-3"}},"payment_object":{"bankAccount":{"bankCode":"001","accountType":1,"accountNumber":"2661901","cbu":null,"clave":null}},"created_at":"2024-03-02T10:19:37.000000Z","updated_at":"2024-03-02T10:19:37.000000Z","deleted_at":null},{"id":5,"user_id":2,"nickname":"Monnet CLP (Success Tests 2)","mode":"monnet","currency":"CLP","address":{"name":"Miguel Perez","city":"Lugbe","state":"FCT - Abuja","country":"Nigeria","postal_code":"900709"},"beneficiary":{"name":"Miguel Perez","lastName":"Perez","email":"[e-mail]","document":{"type":1,"number":"0366311-3"}},"payment_object":{"bankAccount":{"bankCode":"001","accountType":4,"accountNumber":"2661901","cbu":null,"clave":null}},"created_at":"2024-03-02T11:24:24.000000Z","updated_at":"2024-03-02T11:24:24.000000Z","deleted_at":null},{"id":6,"user_id":2,"nickname":"Monnet CLP (Success Tests 2)","mode":"monnet","currency":"CLP","address":{"name":"Miguel Perez","city":"Lugbe","state":"FCT - Abuja","country":"Nigeria","postal_code":"900709"},"beneficiary":{"name":"Miguel Perez","lastName":"Perez","email":"[e-mail]","document":{"type":1,"number":"0366311-3"}},"payment_object":{"bankAccount":{"bankCode":"001","accountType":4,"accountNumber":"2661901","cbu":null,"clave":null}},"created_at":"2024-03-02T11:37:41.000000Z","updated_at":"2024-03-02T11:37:41.000000Z","deleted_at":null},{"id":7,"user_id":2,"nickname":"Monnet CLP (Success Tests 2)","mode":"monnet","currency":"CLP","address":{"name":"Miguel Perez","city":"Lugbe","state":"FCT - Abuja","country":"Nigeria","postal_code":"900709"},"beneficiary":{"name":"Miguel Perez","lastName":"Perez","email":"[e-mail]","document":{"type":1,"number":"0366311-3"}},"payment_object":{"bankAccount":{"bankCode":"001","accountType":4,"accountNumber":null,"cbu":null,"clave":null}},"created_at":"2024-03-02T11:38:53.000000Z","updated_at":"2024-03-02T11:38:53.000000Z","deleted_at":null}],"first_page_url":"https://zee.test/api/v1/beneficiaries?page=1","from":1,"last_page":1,"last_page_url":"https://zee.test/api/v1/beneficiaries?page=1","links":[{"url":null,"label":"« Previous","active":false},{"url":"https://zee.test/api/v1/beneficiaries?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"next_page_url":null,"path":"https://zee.test/api/v1/beneficiaries","per_page":20,"prev_page_url":null,"to":7,"total":7}}

get

HTTPcURLJavaScriptPython

GET /api/v1/beneficiaries/list HTTP/1.1
Host: smtp.yativo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 1,
        "user_id": 2,
        "nickname": "John Doe Zenith bank",
        "mode": "unknown",
        "currency": "NGN",
        "address": {
          "city": "Lugbe",
          "state": "FCT - Abuja",
          "country": "Nigeria",
          "postal_code": "900709"
        },
        "beneficiary": {
          "name": "Yativo Smith",
          "email": "[e-mail]"
        },
        "payment_object": {
          "bank_name": "Access bank",
          "bank_code": "044",
          "account_number": "0719841763",
          "account_name": "Yativo Smith"
        },
        "created_at": "2024-02-06T21:07:39.000000Z",
        "updated_at": "2024-02-06T21:07:39.000000Z",
        "deleted_at": null
      },
      {
        "id": 2,
        "user_id": 2,
        "nickname": "Monnet CLP (Success Tests 1)",
        "mode": "monnet",
        "currency": "CLP",
        "address": {
          "name": "Miguel Perez",
          "city": "Lugbe",
          "state": "FCT - Abuja",
          "country": "Nigeria",
          "postal_code": "900709"
        },
        "beneficiary": {
          "name": "Miguel Perez",
          "email": "[e-mail]",
          "document": {
            "type": 1,
            "number": "10366311-3"
          }
        },
        "payment_object": {
          "bankAccount": {
            "bankCode": "001",
            "accountType": 1,
            "accountNumber": "2661901"
          }
        },
        "created_at": "2024-03-02T08:54:25.000000Z",
        "updated_at": "2024-03-02T08:54:25.000000Z",
        "deleted_at": null
      },
      {
        "id": 3,
        "user_id": 2,
        "nickname": "Monnet CLP (Success Tests 1)",
        "mode": "monnet",
        "currency": "CLP",
        "address": {
          "name": "Miguel Perez",
          "city": "Lugbe",
          "state": "FCT - Abuja",
          "country": "Nigeria",
          "postal_code": "900709"
        },
        "beneficiary": {
          "name": "Miguel Perez",
          "email": "[e-mail]",
          "document": {
            "type": 1,
            "number": "10366311-3"
          }
        },
        "payment_object": {
          "bankAccount": {
            "bankCode": "001",
            "accountType": 1,
            "accountNumber": "2661901"
          }
        },
        "created_at": "2024-03-02T10:04:32.000000Z",
        "updated_at": "2024-03-02T10:04:32.000000Z",
        "deleted_at": null
      },
      {
        "id": 4,
        "user_id": 2,
        "nickname": "Monnet CLP (Success Tests 1)",
        "mode": "monnet",
        "currency": "CLP",
        "address": {
          "name": "Miguel Perez",
          "city": "Lugbe",
          "state": "FCT - Abuja",
          "country": "Nigeria",
          "postal_code": "900709"
        },
        "beneficiary": {
          "name": "Miguel Perez",
          "lastName": "Perez",
          "email": "[e-mail]",
          "document": {
            "type": 1,
            "number": "10366311-3"
          }
        },
        "payment_object": {
          "bankAccount": {
            "bankCode": "001",
            "accountType": 1,
            "accountNumber": "2661901",
            "cbu": null,
            "clave": null
          }
        },
        "created_at": "2024-03-02T10:19:37.000000Z",
        "updated_at": "2024-03-02T10:19:37.000000Z",
        "deleted_at": null
      },
      {
        "id": 5,
        "user_id": 2,
        "nickname": "Monnet CLP (Success Tests 2)",
        "mode": "monnet",
        "currency": "CLP",
        "address": {
          "name": "Miguel Perez",
          "city": "Lugbe",
          "state": "FCT - Abuja",
          "country": "Nigeria",
          "postal_code": "900709"
        },
        "beneficiary": {
          "name": "Miguel Perez",
          "lastName": "Perez",
          "email": "[e-mail]",
          "document": {
            "type": 1,
            "number": "0366311-3"
          }
        },
        "payment_object": {
          "bankAccount": {
            "bankCode": "001",
            "accountType": 4,
            "accountNumber": "2661901",
            "cbu": null,
            "clave": null
          }
        },
        "created_at": "2024-03-02T11:24:24.000000Z",
        "updated_at": "2024-03-02T11:24:24.000000Z",
        "deleted_at": null
      },
      {
        "id": 6,
        "user_id": 2,
        "nickname": "Monnet CLP (Success Tests 2)",
        "mode": "monnet",
        "currency": "CLP",
        "address": {
          "name": "Miguel Perez",
          "city": "Lugbe",
          "state": "FCT - Abuja",
          "country": "Nigeria",
          "postal_code": "900709"
        },
        "beneficiary": {
          "name": "Miguel Perez",
          "lastName": "Perez",
          "email": "[e-mail]",
          "document": {
            "type": 1,
            "number": "0366311-3"
          }
        },
        "payment_object": {
          "bankAccount": {
            "bankCode": "001",
            "accountType": 4,
            "accountNumber": "2661901",
            "cbu": null,
            "clave": null
          }
        },
        "created_at": "2024-03-02T11:37:41.000000Z",
        "updated_at": "2024-03-02T11:37:41.000000Z",
        "deleted_at": null
      },
      {
        "id": 7,
        "user_id": 2,
        "nickname": "Monnet CLP (Success Tests 2)",
        "mode": "monnet",
        "currency": "CLP",
        "address": {
          "name": "Miguel Perez",
          "city": "Lugbe",
          "state": "FCT - Abuja",
          "country": "Nigeria",
          "postal_code": "900709"
        },
        "beneficiary": {
          "name": "Miguel Perez",
          "lastName": "Perez",
          "email": "[e-mail]",
          "document": {
            "type": 1,
            "number": "0366311-3"
          }
        },
        "payment_object": {
          "bankAccount": {
            "bankCode": "001",
            "accountType": 4,
            "accountNumber": null,
            "cbu": null,
            "clave": null
          }
        },
        "created_at": "2024-03-02T11:38:53.000000Z",
        "updated_at": "2024-03-02T11:38:53.000000Z",
        "deleted_at": null
      }
    ],
    "first_page_url": "https://zee.test/api/v1/beneficiaries?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://zee.test/api/v1/beneficiaries?page=1",
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://zee.test/api/v1/beneficiaries?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "next_page_url": null,
    "path": "https://zee.test/api/v1/beneficiaries",
    "per_page": 20,
    "prev_page_url": null,
    "to": 7,
    "total": 7
  }
}

Request Body

No request body is required for this endpoint.

Python

import requests

url = "{{baseUrl}}/beneficiaries/list"

payload = {}
headers = {
  'Authorization': 'Bearer eyJ0exxxxxxxxxxxxxxxxxxxx'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Ruby

require "uri"
require "net/http"

url = URI("{{baseUrl}}/beneficiaries/list")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"

response = https.request(request)
puts response.read_body

Node js

var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{baseUrl}}/beneficiaries/list',
  'headers': {
    'Authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Response

Example Response

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 1,
        "user_id": 2,
        "nickname": "John Doe Banco de Chile",
        "mode": "unknown",
        "currency": "CLP",
        "address": {
          "city": "Santiago",
          "state": "Región Metropolitana",
          "country": "Chile",
          "postal_code": "8320000"
        },
        "beneficiary": {
          "name": "Yativo Smith",
          "email": "[e-mail]"
        },
        "payment_object": {
          "bank_name": "Banco de Chile",
          "bank_code": "001",
          "account_number": "0719841763",
          "account_name": "Yativo Smith"
        },
        "created_at": "2024-02-06T21:07:39.000000Z",
        "updated_at": "2024-02-06T21:07:39.000000Z",
        "deleted_at": null
      },
      {
        "id": 2,
        "user_id": 2,
        "nickname": "Monnet CLP (Success Tests 1)",
        "mode": "monnet",
        "currency": "CLP",
        "address": {
          "city": "Santiago",
          "state": "Región Metropolitana",
          "country": "Chile",
          "postal_code": "8320000"
        },
        "beneficiary": {
          "name": "Miguel Perez",
          "email": "[e-mail]",
          "document": {
            "type": 1,
            "number": "10366311-3"
          }
        },
        "payment_object": {
          "bankAccount": {
            "bankCode": "001",
            "accountType": 1,
            "accountNumber": "2661901"
          }
        },
        "created_at": "2024-03-02T08:54:25.000000Z",
        "updated_at": "2024-03-02T08:54:25.000000Z",
        "deleted_at": null
      }
    ],
    "first_page_url": "https://zee.test/api/v1/beneficiaries?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://zee.test/api/v1/beneficiaries?page=1",
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://zee.test/api/v1/beneficiaries?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "next_page_url": null,
    "path": "https://zee.test/api/v1/beneficiaries",
    "per_page": 20,
    "prev_page_url": null,
    "to": 7,
    "total": 7
  }
}