v1

latestOpenAPI 3.1.02026-07-2656258207.2 KB

Virtual-Accounts

List all virtual accounts

get/virtual-accounts

Query parameters

tostring date-time

The end date and time for a period. This parameter is used in conjunction with the 'from' parameter to define a time range. The value should be in ISO 8601 format.

fromstring date-time

The start date and time for a period. This parameter is used in conjunction with the 'to' parameter to define a time range. The value should be in ISO 8601 format.

pageinteger

The page of the data to retrieve. The most recent data entry is on page 1.

sizeinteger

Length of data returned. Defaults to 10.

referencestring

A custom identifier to track the transaction, This must be unique across all your transactions.

Headers

X-Trace-Idstring

A unique identifier to track this operation. It must be between 12 and 255 characters in length.

Response

status'success' | 'failed'

messagestring

Example response

{
  "data": [
    {
      "amount": 1000,
      "account_number": "7824822527",
      "reference": "htuy68787hvhyff454",
      "account_bank_name": "WEMA BANK",
      "account_type": "static",
      "account_expiration_datetime": "2025-12-03T13:54:21.546559974Z",
      "note": "Please make a bank transfer to James Burgers",
      "customer_id": "cus_J0PvwvJB2n",
      "created_datetime": "2024-12-03T13:54:21.546559974Z",
      "customer_reference": "AEGP2345",
      "currency": "NGN",
      "narration": "James Burgers"
    }
  ]
}