Skip to main content
Retrieve the details of a specific virtual account by its reference.

Endpoint

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

Headers

HeaderRequiredDescription
x-api-keyYesYour API key

Query parameters

ParameterTypeRequiredDescription
referencestringYesThe virtual account reference

Request example

curl -X GET "https://api-dev.usenumero.com/numeroaccount/api/v1/business/virtualaccount/reference?reference=VA-20240115-abc123" \
  -H "x-api-key: your_api_key"

Response

{
  "status": true,
  "message": "Successful",
  "code": "200",
  "version": "v1",
  "reference": "abc123",
  "data": {
    "reference": "VA-20240115-abc123",
    "accountName": "John Doe",
    "accountNumber": "8012345678",
    "bankName": "Providus Bank",
    "providerCode": "PROVIDUS",
    "details": {
      "businessName": null,
      "category": "Individual",
      "email": "[email protected]",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "08012345678",
      "rcNumber": null,
      "tin": null,
      "type": "Customer"
    }
  },
  "error": null
}
FieldTypeDescription
details.typestring"Customer" or "Business"
details.categorystringAccount category
details.businessNamestringBusiness name (for business accounts only)
details.rcNumberstringRC number (for business accounts only)