List Virtual Accounts

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

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

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 account name
startDatedateFilter date range by date of which virtual account was created eg. 2017-05-16T00:30:13+01:00
endDatedateFilter date range by date of which virtual account 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": 6,
        "pageCount": 1,
        "hasPreviousPage": false,
        "hasNextPage": false,
        "data": [
            {
                "id": "d4cfbb74-7664-4a72-b62b-60c9a0ea90d0",
                "accountNumber": "4700040150",
                "accountName": "Raphael Ajilore",
                "bankCode": "999999",
                "bankName": "VFD Microfinance Bank",
                "balance": 1000,
                "accountCategory": "VIRTUAL_ACCOUNT",
                "accountType": "INDIVIDUAL",
                "reference": "Raphael Ajilore-cF0ln70YSj",
                "expiresAt": "30",
                "isPermanent": false,
                "provider": "VFD",
                "createdAt": "2024-07-09T09:21:21.878Z",
                "updatedAt": "2024-07-09T09:21:21.878Z",
                "version": 1
            },
            {
                "id": "257755b3-d8d2-4040-90ff-e8cd0d2be2f8",
                "accountNumber": "4700039950",
                "accountName": "Raphael Ajilore",
                "bankCode": "999999",
                "bankName": "VFD Microfinance Bank",
                "balance": 1000,
                "accountCategory": "VIRTUAL_ACCOUNT",
                "accountType": "INDIVIDUAL",
                "reference": "Raphael Ajilore-VjTJGL8h4F",
                "expiresAt": "30",
                "isPermanent": false,
                "provider": "VFD",
                "createdAt": "2024-07-08T13:30:55.044Z",
                "updatedAt": "2024-07-08T13:30:55.044Z",
                "version": 1
            },
            {
                "id": "fccd8e9f-f2ac-4752-ba60-79a97e878419",
                "accountNumber": "4700039943",
                "accountName": "Raphael Ajilore",
                "bankCode": "999999",
                "bankName": "VFD Microfinance Bank",
                "balance": 10,
                "accountCategory": "VIRTUAL_ACCOUNT",
                "accountType": "INDIVIDUAL",
                "reference": "Raphael Ajilore-EHvIqrAYIQ",
                "expiresAt": "30",
                "isPermanent": false,
                "provider": "VFD",
                "createdAt": "2024-07-08T13:18:27.789Z",
                "updatedAt": "2024-07-08T13:18:27.789Z",
                "version": 1
            },
            {
                "id": "53e2b115-c9b7-489f-8027-2452b5ff4513",
                "accountNumber": "4700039936",
                "accountName": "Raphael Ajilore",
                "bankCode": "999999",
                "bankName": "VFD Microfinance Bank",
                "balance": 10,
                "accountCategory": "VIRTUAL_ACCOUNT",
                "accountType": "INDIVIDUAL",
                "reference": "Raphael Ajilore--wz1vYI2Kg",
                "expiresAt": "30",
                "isPermanent": false,
                "provider": "VFD",
                "createdAt": "2024-07-08T13:15:38.122Z",
                "updatedAt": "2024-07-08T13:15:38.122Z",
                "version": 1
            },
            {
                "id": "47e3b15c-d897-41c1-b709-bcd56ed05678",
                "accountNumber": "4700039929",
                "accountName": "Raphael Ajilore",
                "bankCode": "999999",
                "bankName": "VFD Microfinance Bank",
                "balance": 10,
                "accountCategory": "VIRTUAL_ACCOUNT",
                "accountType": "INDIVIDUAL",
                "reference": "Raphael Ajilore-tX_eYWEdRj",
                "expiresAt": "30",
                "isPermanent": false,
                "provider": "VFD",
                "createdAt": "2024-07-08T13:12:18.607Z",
                "updatedAt": "2024-07-08T13:12:18.607Z",
                "version": 1
            },
            {
                "id": "7830c47e-d41a-47bd-bd2c-68ba5b861161",
                "accountNumber": "Raphael Ajilore",
                "accountName": null,
                "bankCode": "999999",
                "bankName": "VFD Microfinance Bank",
                "balance": 10,
                "accountCategory": "VIRTUAL_ACCOUNT",
                "accountType": "INDIVIDUAL",
                "reference": "Raphael Ajilore-M4N7AAcySx",
                "expiresAt": "-1",
                "isPermanent": false,
                "provider": "VFD",
                "createdAt": "2024-07-08T13:02:33.872Z",
                "updatedAt": "2024-07-08T13:02:33.872Z",
                "version": 1
            }
        ]
    },
    "status": true,
    "message": "Success",
    "code": 200
}