Skip to content

Developer Documentation

Transactions

Endpoints for querying transaction history and checking the status of a specific transaction.

Get Transaction History

GET /v1/payments/transactions

Retrieve a paginated list of transactions. Can be filtered by wallet, status, or type.

Query Parameters
  • wallet_id (integer, optional): Filter by a specific wallet ID.
  • limit (integer, optional, default: 20): Number of records to return.
  • offset (integer, optional, default: 0): Number of records to skip for pagination.
  • status (string, optional): Filter by status (e.g., `settled`, `failed`).
Request Body
{
  "limit": 20,
  "status": "settled"
}
Body Parameters
Test Request
Response
{
  "status": "success",
  "count": 1,
  "data": [
    {
      "tx_id": 10056,
      "tx_hash": "a1b2c3d4e5f6...",
      "tx_type": "transfer",
      "status": "settled",
      "created_at": "2025-10-26 12:00:00",
      "settled_at": "2025-10-26 12:00:01",
      "metadata": "{\"note\":\"For lunch\"}",
      "total_volume": "50.00",
      "currency": "KES"
    }
  ]
}

Check Transaction Status

GET /v1/payments/status

Check the real-time status of a single transaction by its ID.

Query Parameters
  • tx_id (integer, required): The unique ID of the transaction.
Request Body
{
  "tx_id": 10056
}
Body Parameters
Test Request
Response
{
  "status": "success",
  "data": {
    "tx_id": 10056,
    "tx_hash": "a1b2c3d4e5f6...",
    "tx_type": "transfer",
    "status": "settled",
    "created_at": "2025-10-26 12:00:00",
    "settled_at": "2025-10-26 12:00:01"
  }
}