List Beneficiaries

List Beneficiaries available

You do this by making a GET request to transfer endpoint from your server.

-H "x-api-key: your_secret_key".
{{host}}/v1/transfer/beneficiaries

Query Parameters

StatusData TypeDescription
orderenumallowed values are ASC or DESC
pageintegerSpecify exactly what page you want to retrieve. If not specified we use a default value of 1
limitintegerSpecify how many records you want to retrieve per page. maximum record per page is 100
querystringFilter by beneficiary account name
startDatedateFilter date range by date of which beneficiary was created eg. 2017-05-16T00:30:13+01:00
endDatedateFilter date range by date of which beneficiary was created eg. 2017-05-16T00:30:13+01:00

If the API call is successful, Kyshi returns the following response:

{
    "data": {
        "page": 1,
        "limit": 100,
        "total": 1,
        "pageCount": 1,
        "hasPreviousPage": false,
        "hasNextPage": false,
        "data": [
            {
                "id": "8495ec4e-ce21-405f-b0cf-982702881f4d",
                "accountName": "FEMI ZACK",
                "accountNumber": "1111111103",
                "bankName": "Keystone Bank",
                "bankCode": "000002",
                "bvn": "22222222224",
                "description": "TEST",
                "isActive": true,
                "createdAt": "2024-07-08T14:25:58.115Z",
                "updatedAt": "2024-07-08T14:25:58.115Z",
                "version": 1
            }
        ]
    },
    "status": true,
    "message": "Success",
    "code": 200
}