Skip to main content
GET
/
business
/
virtualaccount
/
all
List virtual accounts
curl --request GET \
  --url https://api-staging.usenumero.com/numeroaccount/api/v1/business/virtualaccount/all \
  --header 'X-Numero-Api-Key: <api-key>'
{ "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 }

Authorizations

​
X-Numero-Api-Key
string
header
required

Your business API key (live_key_...). Issued on approval; managed in Dashboard → Settings → Developer.

Query Parameters

​
startDate
string<date-time>
​
endDate
string<date-time>
​
searchBy
string
​
pageNumber
integer
default:1
Required range: x >= 1
​
pageSize
integer
default:50
Required range: 1 <= x <= 200

Response

Successful response

Canonical response envelope for the public surface. data on success, error on failure.

​
data
any
required

Endpoint payload on success (object or array); null on failure.

​
error
object
required
​
meta
object
required