Sign in

v1

latestOpenAPI 3.1.02026-07-2691531.2 KB
Transactions

List transactions

Returns a paginated list of transactions for your account, newest first. Use cursor from the previous response to fetch the next page.

get/transactions

Query parameters

limitinteger

Number of records per page (1–100, default 20).

cursorstring

Pagination cursor from the previous response nextCursor field.

status'PENDING' | 'PROCESSING' | 'SUCCESS' | 'FAILED' | 'REVERSED' | 'CANCELLED'
  • PENDING — Awaiting customer action or provider response
  • PROCESSING — Provider accepted; waiting for final confirmation
  • SUCCESS — Completed successfully
  • FAILED — Transaction failed (provider declined or timeout)
  • REVERSED — Successfully reversed (wallet credited back)
  • CANCELLED — Cancelled before processing

Filter by transaction status.

type'STK' | 'B2C'
  • STK — M-Pesa STK Push collection
  • B2C — Business to Customer payout

Filter by transaction type.

Response

Paginated list of transactions.

successboolean required
requestIdstring uuid required

Unique identifier for this API request. Include in support tickets.

Example response

{
  "success": true,
  "data": {
    "items": [
      {
        "amount": 1000,
        "currency": "KES",
        "phone": "254712345678",
        "accountReference": "INV-2024-001",
        "transactionDesc": "Payment for invoice #2024-001",
        "provider": "m-pesa",
        "providerRequestId": "29115-34620561-1",
        "providerCheckoutId": "ws_CO_191220191020363925",
        "resultCode": "0",
        "resultDesc": "The service request is processed successfully."
      }
    ]
  },
  "requestId": "c1b2a3d4-e5f6-7890-abcd-ef1234567890"
}