API Reference
List Beneficiaries [GET]

List Beneficiaries

https://sandboxapi.bitnob.co/api/v1/beneficiaries (opens in a new tab)

List all beneficiaries linked to your account

Request

Beneficiaries/List Beneficiaries [GET]
curl --request GET \
     --url https://sandboxapi.bitnob.co/api/v1/beneficiaries \
     --header 'Authorization: Bearer API_KEY' \
     --header 'accept: application/json'

Responses

🟢 200 - Result example
{
  "status": true,
  "message": "successfully fetched all beneficiaries",
  "data": {
      "beneficiaries": [
          {
              "id": "42aa6d30-b54c-4e84-822a-c74d9aa53c04",
              "createdAt": "2023-08-21T10:40:55.531Z",
              "updatedAt": "2023-08-21T10:40:55.531Z",
              "reference": "hdnkklwbejwj",
              "status": "success",
              "country": "NG",
              "currency": "NGN",
              "destination": {
                  "type": "NUBAN",
                  "bankCode": "044",
                  "accountName": "Joe Zen",
                  "accountNumber": "0691110031"
              }
          },],
        "meta": {
          "page": 1,
          "take": 10,
          "itemCount": 10,
          "pageCount": 1,
          "hasPreviousPage": false,
          "hasNextPage": false
      }
  }
 
}
Last updated on