Skip to main content
Retrieve a paginated list of transactions on your merchant account. Supports filtering by date range and search terms.

Endpoint

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

Headers

HeaderRequiredDescription
x-api-keyYesYour API key

Query parameters

ParameterTypeRequiredDefaultDescription
startDatedatetimeNoFilter transactions from this date
endDatedatetimeNoFilter transactions to this date
searchBystringNoSearch by reference, description, or beneficiary
pageNumberintegerNo1Page number
pageSizeintegerNo50Records per page

Request example

curl -X GET "https://api-dev.usenumero.com/numeroaccount/api/v1/business/transaction?startDate=2024-01-01&endDate=2024-01-31&pageNumber=1&pageSize=20" \
  -H "x-api-key: your_api_key"

Response

{
  "status": true,
  "message": "Successful",
  "code": "200",
  "version": "v1",
  "reference": "abc123",
  "data": {
    "transactions": [
      {
        "trxAmount": 50000.00,
        "trxFee": 25.00,
        "settledAmount": 50000.00,
        "merchant": "Your Business Name",
        "businessCode": "BUS001",
        "reference": "TRF-20240115-abc123",
        "sessionId": "session123",
        "vendorReference": "vendor_ref_001",
        "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.00
      }
    ],
    "pageNumber": 1,
    "pageSize": 20,
    "totalCount": 150
  },
  "error": null
}

Transaction fields

FieldTypeDescription
trxAmountnumberTransaction amount
trxFeenumberFee charged
settledAmountnumberAmount settled to the beneficiary
referencestringUnique transaction reference
typestringTransaction type (e.g., Transfer, Funding, FxConversion)
statusstringCurrent status (Successful, Pending, Failed, Reversed)
postingTypestringDebit or Credit
servicestringService used (SingleTransfer, BulkTransfer, VirtualAccount, etc.)
requestStatestringProcessing state (Completed, Processing, Failed)
currencystringTransaction currency
dateCreateddatetimeWhen the transaction was initiated
beneficiaryBankstringRecipient bank name (for transfers)
beneficiaryNamestringRecipient name (for transfers)
beneficiaryNumberstringRecipient account number (for transfers)
stampDutyAppliedbooleanWhether stamp duty was charged
stampDutyAmountnumberStamp duty amount