Endpoint
GET /api/v1/business/status
Headers
| Header | Required | Description |
|---|---|---|
X-Numero-Api-Key | Yes | Your API key |
X-Numero-Signature | Yes | Base64 HMAC-SHA256 over the exact raw request body (POST) or the canonicalised query string (GET), keyed with your Public Key. See Request signing. |
X-Numero-Signature-Version | Yes | Always v2. |
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
reference | string | Yes | The transfer reference from the initiate transfer response |
Request example
curl -X GET "https://api.usenumero.com/numeroaccount/api/v1/business/status?reference=TRF-20240115-abc123" \
-H "X-Numero-Api-Key: your_api_key" \
-H "X-Numero-Signature: $SIGNATURE" \
-H "X-Numero-Signature-Version: v2"
Response
{
"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,
"meta": {
"request_id": "req_365123ebc73323f1482508560ce6400e",
"pagination": null
}
}
Transaction statuses
| Status | Description |
|---|---|
Successful | Transfer completed successfully |
Pending | Transfer is being processed |
Failed | Transfer failed — check requestStateDetails for the reason |
Reversed | Transfer was reversed |
Request states
| State | Description |
|---|---|
Completed | Processing is complete |
Processing | Transfer is in progress |
Failed | Processing failed |