Get a transfer's status by reference

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

{
  "status": true,
  "message": "Successful",
  "code": "200",
  "version": "v1",
  "reference": "abc123",
  "data": {
    "transactionRecord": {
      "trxAmount": 5000,
      "trxFee": 25,
      "settledAmount": 5000,
      "userBusinessName": "Your Business Name",
      "businessCode": "BUS001",
      "reference": "TRF-20240115-abc123",
      "type": "Transfer",
      "status": "Successful",
      "channel": "API",
      "postingType": "Debit",
      "description": "Payment for order #123",
      "service": "SingleTransfer",
      "requestState": "Completed",
      "requestStateDetails": "Transfer completed successfully",
      "currency": "NGN",
      "sessionId": "session123",
      "stan": "123456",
      "receiverBankCode": "000013",
      "receiverBankName": "GT Bank",
      "receiverAccountName": "John Doe",
      "receiverAccountNumber": "0123456789"
    }
  },
  "error": null
}

GET

business

status

Get a transfer's status by reference

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

{
  "status": true,
  "message": "Successful",
  "code": "200",
  "version": "v1",
  "reference": "abc123",
  "data": {
    "transactionRecord": {
      "trxAmount": 5000,
      "trxFee": 25,
      "settledAmount": 5000,
      "userBusinessName": "Your Business Name",
      "businessCode": "BUS001",
      "reference": "TRF-20240115-abc123",
      "type": "Transfer",
      "status": "Successful",
      "channel": "API",
      "postingType": "Debit",
      "description": "Payment for order #123",
      "service": "SingleTransfer",
      "requestState": "Completed",
      "requestStateDetails": "Transfer completed successfully",
      "currency": "NGN",
      "sessionId": "session123",
      "stan": "123456",
      "receiverBankCode": "000013",
      "receiverBankName": "GT Bank",
      "receiverAccountName": "John Doe",
      "receiverAccountNumber": "0123456789"
    }
  },
  "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

reference

string

required

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

Show child attributes