Fetch Beneficiary

​

Request Parameters

The following fields are required to retrieve a specific beneficiary:

• type (Object, Required): Specifies the type of the request object.

• after (String, Required): A cursor indicating the starting point for pagination.

• before (String, Required): A cursor indicating the ending point for pagination.

• limit (Integer, Required): The maximum number of records to return in the response.

• user_id (String, Required): The unique identifier of the user associated with the beneficiary.

• account_id (String, Required): The unique identifier of the account associated with the beneficiary.

​

Initialization

To retrieve a specific beneficiary, ensure all required fields are included in the request.

GET /beneficiaries/{id}

Sample Response

{
  "data":{
      "account_name": "MICHAEL ENITAN ASAJU",
      "account_number": "0821081314",
      "account_type": "savings",
      "address": {},
      "bank_address": {},
      "bank_code": "000014",
      "bank_id": "",
      "bank_name": "ACCESS BANK",
      "bic": null,
      "currency": "NGN",
      "id": "d8c0226b-048c-4c44-9606-a93333f56283",
      "lifetime": "permanent",
      "routing_number": null,
      "sort_code": null,
      "type": "bank_account",
      "user_id": "c545cbc5-9915-4bfb-98ee-3759894feac2",
      "virtual": false
    }
}

​

Notes

• Ensure the after and before cursors are correctly formatted to avoid pagination errors.

• The limit value must be a positive integer and should not exceed the system’s maximum allowed limit.

• The user_id and account_id must correspond to valid and existing records in the system.

• The response includes detailed information about the beneficiary, such as account details, bank information, and associated metadata.