Sign in

v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB
Virtual Accounts

Filter virtual accounts

You can use this endpoint to filter your virtual accounts.

post/v1/accounts/virtual/list

Query parameters

limitinteger

This endpoint is paginated. limit describes the size of the page you are querying

cursorstring

The cursor is used to scroll to the next page. When making the first call to list all accounts, there is no need to pass in any cursor since the API has not returned any cursor back to you. Only use cursor when the API provides it

Headers

accountIdstring uuid required
Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27

The parent accountId of the business.

Request body

accountNamestring

Account holder's name

accountRefstring

Account reference

bvnstring

Bank Verification Number (BVN)

bankAccountNumberstring

Bank account number

dateCreatedFromstring date-time

Date created from

dateCreatedTostring date-time

Date created to

expiredboolean

Whether the virtual account is expired or not

resourceAcquiredboolean

Whether the virtual account is in use or not

Example request

{
  "accountName": "Daniel Scorsese",
  "accountRef": "1oWbJQQHLyQqqf1SwxjSpudeA21",
  "bvn": "12234412345",
  "bankAccountNumber": "9391076543",
  "dateCreatedFrom": "2023-08-30T14:56:59.000Z",
  "dateCreatedTo": "2024-08-30T14:56:59.000Z"
}

Response

OK - your request was successful.

codestring required

Response Code

descriptionstring required

Response description

Example response

{
  "code": "00",
  "description": "Success",
  "data": {
    "results": [
      {
        "createdAt": "2023-09-04T07:09:06.900Z",
        "accountHolderId": "01a10aeb-d989-460a-bbde-9842f2b4320f",
        "accountRef": "1oWbJQQHLyQqqf1SwxjSpudeA21",
        "bvn": "12234412345",
        "accountName": "Daniel Scorsese",
        "bankName": "Nombank MFB",
        "bankAccountNumber": "9391076543",
        "bankAccountName": "Nomba/Ifeoluwa Adeboye",
        "currency": "NGN",
        "callbackUrl": "https://webhook.site/98ef100f-5adc-4434-800a-0808h60bd8d7",
        "expired": true
      }
    ],
    "cursor": "xchbaVFsjdsbaADddd"
  }
}