Re-query a VAS purchase 🔒

curl --request GET \
  --url https://api-staging.usenumero.com/numeroaccount/api/v1/business/vas/status \
  --header 'X-Numero-Api-Key: <api-key>' \
  --header 'X-Numero-Signature: <api-key>'

{
  "data": {
    "reference": "<string>",
    "type": "<string>",
    "service": "<string>",
    "status": "<string>",
    "requestState": "<string>",
    "requestStateDetails": "<string>",
    "channel": "<string>",
    "sourcePlatform": "<string>",
    "merchant": "<string>",
    "businessCode": "<string>",
    "currency": "NGN",
    "trxAmount": 123,
    "trxFee": 123,
    "stampDutyApplied": true,
    "stampDutyAmount": 123,
    "balanceBefore": 123,
    "balanceAfter": 123,
    "beneficiaryName": "<string>",
    "beneficiaryNumber": "<string>",
    "beneficiaryBank": "<string>",
    "toAccountName": "<string>",
    "toAccountNumber": "<string>",
    "toAccountBank": "<string>",
    "description": "<string>",
    "token": "<string>",
    "isReversed": true,
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateModified": "2023-11-07T05:31:56Z"
  },
  "error": {
    "message": "<string>",
    "param": "<string>"
  },
  "meta": {
    "request_id": "<string>",
    "pagination": {
      "page": 123,
      "page_size": 123,
      "total": 123,
      "has_more": true
    }
  }
}

GET

business

vas

status

Re-query a VAS purchase 🔒

curl --request GET \
  --url https://api-staging.usenumero.com/numeroaccount/api/v1/business/vas/status \
  --header 'X-Numero-Api-Key: <api-key>' \
  --header 'X-Numero-Signature: <api-key>'

{
  "data": {
    "reference": "<string>",
    "type": "<string>",
    "service": "<string>",
    "status": "<string>",
    "requestState": "<string>",
    "requestStateDetails": "<string>",
    "channel": "<string>",
    "sourcePlatform": "<string>",
    "merchant": "<string>",
    "businessCode": "<string>",
    "currency": "NGN",
    "trxAmount": 123,
    "trxFee": 123,
    "stampDutyApplied": true,
    "stampDutyAmount": 123,
    "balanceBefore": 123,
    "balanceAfter": 123,
    "beneficiaryName": "<string>",
    "beneficiaryNumber": "<string>",
    "beneficiaryBank": "<string>",
    "toAccountName": "<string>",
    "toAccountNumber": "<string>",
    "toAccountBank": "<string>",
    "description": "<string>",
    "token": "<string>",
    "isReversed": true,
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateModified": "2023-11-07T05:31:56Z"
  },
  "error": {
    "message": "<string>",
    "param": "<string>"
  },
  "meta": {
    "request_id": "<string>",
    "pagination": {
      "page": 123,
      "page_size": 123,
      "total": 123,
      "has_more": true
    }
  }
}

Authorizations

X-Numero-Api-Key

string

header

required

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

X-Numero-Signature

string

header

required

Base64(HMAC-SHA256(secretApiKey, input)) over the raw request body (POST) or canonicalized query string (signed GET). Also send X-Numero-Signature-Version: v2. Required on money-movement / state-changing endpoints (marked 🔒).

Query Parameters

reference

string

required

The VAS transaction reference returned when you initiated the purchase.

Response

The reconciled transaction.

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

data

object

required

The data of a FUNDING_NOTIFICATION (money in) or TRANSFER_NOTIFICATION (money out). Field names are camelCase; amounts are in naira (major units).

Show child attributes

error

object

required

Show child attributes