v1

latestOpenAPI 3.1.02026-07-24590534.0 KB

Fetch Off Ramp Transactions

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

get/off_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.

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": "7a0234bf-6be4-41ea-a168-618358ef0e7f",
      "status": "completed",
      "mode": "sell",
      "from_currency": "USDT",
      "to_currency": "GHS",
      "from_amount": "4.5",
      "to_amount": "47.652228",
      "network": "bep20",
      "merchant_reference": "tx123bb45-ramp-12221-Alva",
      "crypto_deposit": {
        "public_id": "94e44666-12d2-400e-9fda-0d6786e0c9b2",
        "txid": "0xc9f1626c602adff92098c8d57a528564022b7bab31d785b29b301bb9adb3173e",
        "status": "accepted",
        "amount": "4.5",
        "currency": "usdt",
        "network": "bep20",
        "created_at": "2025-12-03T11:09:51.098Z",
        "updated_at": "2025-12-03T11:09:51.213Z"
      },
      "fiat_payout": {
        "public_id": "7ad2ca95-b777-4897-9c2a-730fb483ce1f",
        "amount": "47.652228",
        "status": "completed",
        "currency": "ghs",
        "processor_fee": "2.0",
        "created_at": "2025-12-03T11:10:00.853Z",
        "updated_at": "2025-12-03T11:10:11.580Z"
      },
      "created_at": "2025-12-03T10:59:12.488Z",
      "updated_at": "2025-12-03T11:10:11.725Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total_count": 3,
    "total_pages": 1
  }
}