Endpoint
GET /api/v1/business/transaction
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 | Default | Description |
|---|---|---|---|---|
startDate | datetime | No | — | Filter transactions from this date |
endDate | datetime | No | — | Filter transactions to this date |
searchBy | string | No | — | Search by reference, description, or beneficiary |
pageNumber | integer | No | 1 | Page number |
pageSize | integer | No | 50 | Records per page |
Request example
curl -X GET "https://api.usenumero.com/numeroaccount/api/v1/business/transaction?startDate=2024-01-01&endDate=2024-01-31&pageNumber=1&pageSize=20" \
-H "X-Numero-Api-Key: your_api_key" \
-H "X-Numero-Signature: $SIGNATURE" \
-H "X-Numero-Signature-Version: v2"
Response
{
"data": {
"transactions": [
{
"trxAmount": 50000.0,
"trxFee": 25.0,
"settledAmount": 50000.0,
"merchant": "Your Business Name",
"businessCode": "BUS001",
"reference": "TRF-20240115-abc123",
"sessionId": "session123",
"type": "Transfer",
"status": "Successful",
"channel": "API",
"postingType": "Debit",
"description": "Salary payment",
"service": "SingleTransfer",
"requestState": "Completed",
"requestStateDetails": "Transfer completed successfully",
"currency": "NGN",
"dateCreated": "2024-01-15T10:30:00Z",
"dateModified": "2024-01-15T10:31:00Z",
"beneficiaryBank": "GT Bank",
"beneficiaryName": "John Doe",
"beneficiaryNumber": "0123456789",
"stampDutyApplied": true,
"stampDutyAmount": 50.0
}
],
"pageNumber": 1,
"pageSize": 20,
"totalCount": 150
},
"error": null,
"meta": {
"request_id": "req_365123ebc73323f1482508560ce6400e",
"pagination": null
}
}
Transaction fields
| Field | Type | Description |
|---|---|---|
trxAmount | number | Transaction amount |
trxFee | number | Fee charged |
settledAmount | number | Amount settled to the beneficiary |
reference | string | Unique transaction reference |
type | string | Transaction type (e.g., Transfer, Funding, FxConversion) |
status | string | Current status (Successful, Pending, Failed, Reversed) |
postingType | string | Debit or Credit |
service | string | Service used (SingleTransfer, BulkTransfer, VirtualAccount, etc.) |
requestState | string | Processing state (Completed, Processing, Failed) |
currency | string | Transaction currency |
dateCreated | datetime | When the transaction was initiated |
beneficiaryBank | string | Recipient bank name (for transfers) |
beneficiaryName | string | Recipient name (for transfers) |
beneficiaryNumber | string | Recipient account number (for transfers) |
stampDutyApplied | boolean | Whether stamp duty was charged |
stampDutyAmount | number | Stamp duty amount |