v1

latestOpenAPI 3.1.02026-07-24590534.0 KB

Fetch On Ramp Transactions

These endpoints allow a merchant to fetch paginated on-ramp transactions for the authenticated app.

get/on_ramp_transactions

Query parameters

pagestring

Page number. Must be a positive integer. Defaults to 1.

per_pagestring

Number of records per page. Must be a positive integer. Defaults to 25, max 50.

status'completed' | 'pending' | 'processing' | 'refunded' | 'needs_attention' | 'failed' | 'abandoned' | 'cancelled' | 'swap_reversed'

Filter by transaction status.

from_currencystring

Filter by source currency code, e.g. ngn, usdt.

to_currencystring

Filter by destination currency code, e.g. usd, ngn.

start_datestring

Start date. Must be used with end_date. Format: YYYY-MM-DD.

end_datestring

End date. Must be used with start_date. Format: YYYY-MM-DD.

Response

200

statusstring
messagestring

Example response

{
  "status": "ok",
  "message": "Transactions fetched successfully",
  "data": [
    {
      "public_id": "d5e46711-7f96-4d81-8f7a-57b6c7304090",
      "status": "completed",
      "mode": "buy",
      "from_currency": "ngn",
      "to_currency": "usdt",
      "from_amount": "3000.0",
      "to_amount": "2.0542",
      "network": "celo",
      "merchant_reference": "user-demo",
      "blockchain_fee": "0.005",
      "crypto_payout": {
        "public_id": "09a7fe6e-a933-45b5-8def-85c2af15a823",
        "transaction_hash": "0x2c8cb922aede1464ec575c5e06a5740d7b015c5b890183ad951085c4adfd7d97",
        "status": "completed",
        "amount": "2.0542",
        "processor_fee": "0.005",
        "address": "0xEBd827CC80D8BD95B42824467D45A6faAe91A05e",
        "network": "celo",
        "currency": "usdt",
        "created_at": "2026-02-10T09:59:22.715Z",
        "updated_at": "2026-02-10T09:59:44.800Z"
      },
      "fiat_deposit": {
        "public_id": "44b8c2bd-34e1-4e8b-8745-2460f1ce46fb",
        "status": "success",
        "currency": "ngn",
        "amount": "3000.0",
        "fee": "80.63",
        "created_at": "2026-02-10T09:59:14.842Z",
        "updated_at": "2026-02-10T09:59:14.857Z"
      },
      "created_at": "2026-02-10T09:57:23.872Z",
      "updated_at": "2026-02-10T09:59:44.823Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 16,
    "total_pages": 1
  }
}