List Beneficiaries
Retrieve payout beneficiaries for your business.
-H "x-api-key: your_secret_key"GET {{host}}/v1/transfer/beneficiariesQuery Parameters
| Field | Data Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page to retrieve. Defaults to 1. |
| limit | integer | No | Records per page. Maximum is 100. |
| order | string | No | ASC or DESC. Defaults to DESC. |
| sort | string | No | Field to sort by. Defaults to createdAt. |
| query | string | No | Search by account name. |
| accountNumber | string | No | Search by account number. |
| startDate | string | No | ISO date/time start filter. |
| endDate | string | No | ISO date/time end filter. |
| integrationId | string | No | Filter by integration ID. |
{
"status": true,
"message": "Success",
"code": 200,
"data": {
"page": 1,
"limit": 100,
"total": 1,
"pageCount": 1,
"hasPreviousPage": false,
"hasNextPage": false,
"data": [
{
"id": "8495ec4e-ce21-405f-b0cf-982702881f4d",
"accountName": "FEMI ZACK",
"accountNumber": "0123456789",
"bankName": "Access Bank",
"bankCode": "000014",
"bvn": "",
"description": "Supplier payout",
"isActive": true,
"mode": "live",
"createdAt": "2026-05-20T10:15:00.000Z"
}
]
}
}Updated about 13 hours ago
