Aurax PayAurax Pay Docs

List Transactions

Retrieve a paginated list of transactions for your merchant account. Supports filtering by status, channel, type, and date range.

GEThttps://api.auraxpay.net/v1/paymentsRequires payments.read permission

Query parameters

ParameterTypeDescription
statusstringFilter by status: PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED
typestringFilter by type: COLLECTION or DISBURSEMENT
channelstringFilter by channel: MPESA, TIGO_PESA, AIRTEL_MONEY, HALOPESA
fromstringStart date in ISO 8601 format. E.g. 2025-06-01T00:00:00Z
tostringEnd date in ISO 8601 format. E.g. 2025-06-30T23:59:59Z
searchstringSearch by reference, phone number, or buyer name
pageintegerPage number. Default: 1
limitintegerResults per page. Default: 20, max: 100

Example requests

All transactions (latest 20)
curl "https://api.auraxpay.net/v1/payments" \
  -H "x-api-key: axp_live_YOUR_KEY"
Completed M-Pesa collections this month
curl "https://api.auraxpay.net/v1/payments?status=COMPLETED&channel=MPESA&from=2025-06-01T00:00:00Z&to=2025-06-30T23:59:59Z" \
  -H "x-api-key: axp_live_YOUR_KEY"
Search by phone number
curl "https://api.auraxpay.net/v1/payments?search=%2B255712345678" \
  -H "x-api-key: axp_live_YOUR_KEY"

Response

Response 200
{
  "success": true,
  "transactions": [
    {
      "id": "txn_01j2k3m4n5p6q7r8s9t0",
      "reference": "AXP-SXSZF5H6",
      "type": "COLLECTION",
      "amount": 25000,
      "fee": 0,
      "netAmount": 25000,
      "channel": "MPESA",
      "status": "COMPLETED",
      "buyerName": "Amina Hassan",
      "createdAt": "2025-06-09T14: 30: 00.000Z",
      "completedAt": "2025-06-09T14: 30: 45.000Z"
    }
  ],
  "pagination": {
    "total": 142,
    "page": 1,
    "limit": 20,
    "pages": 8
  }
}