Skip to main content
Retrieve a paginated list of all virtual accounts created under your merchant account.

Endpoint

GET /api/v1/business/virtualaccount/all
Signature required: No

Headers

HeaderRequiredDescription
x-api-keyYesYour API key

Query parameters

ParameterTypeRequiredDefaultDescription
startDatedatetimeNoFilter by creation date (from)
endDatedatetimeNoFilter by creation date (to)
searchBystringNoSearch by account name, number, or reference
pageNumberintegerNo1Page number
pageSizeintegerNo50Records per page

Request example

curl -X GET "https://api-dev.usenumero.com/numeroaccount/api/v1/business/virtualaccount/all?pageNumber=1&pageSize=20" \
  -H "x-api-key: your_api_key"

Response

{
  "status": true,
  "message": "Successful",
  "code": "200",
  "version": "v1",
  "reference": "abc123",
  "data": {
    "accounts": [
      {
        "reference": "VA-20240115-abc123",
        "accountName": "John Doe",
        "accountNumber": "8012345678",
        "bankName": "Providus Bank",
        "providerCode": "PROVIDUS",
        "details": {
          "type": "Customer",
          "email": "[email protected]",
          "firstName": "John",
          "lastName": "Doe",
          "phone": "08012345678"
        }
      }
    ],
    "pageNumber": 1,
    "pageSize": 20,
    "totalCount": 45
  },
  "error": null
}