Skip to main content
Check the current status of a transfer using its reference.

Endpoint

GET /api/v1/business/status
Signature required: No

Headers

HeaderRequiredDescription
x-api-keyYesYour API key

Query parameters

ParameterTypeRequiredDescription
referencestringYesThe transfer reference from the initiate transfer response

Request example

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

Response

{
  "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
}

Transaction statuses

StatusDescription
SuccessfulTransfer completed successfully
PendingTransfer is being processed
FailedTransfer failed — check requestStateDetails for the reason
ReversedTransfer was reversed

Request states

StateDescription
CompletedProcessing is complete
ProcessingTransfer is in progress
FailedProcessing failed