--- agentTools: projectIndex: https://docs.quidax.io/llms.txt --- # Fetch Off Ramp Transactions These endpoints allow a merchant to fetch paginated on-ramp transactions for the authenticated app. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Ramp Merchant API", "version": "3.0" }, "servers": [ { "url": "https://ramp-be.quidax.io/api/v1/merchants/" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "name": "x-private-key", "in": "header", "x-default": "secret_key" } } }, "security": [ { "sec0": [] } ], "paths": { "/off_ramp_transactions": { "get": { "summary": "Fetch Off Ramp Transactions", "description": "These endpoints allow a merchant to fetch paginated on-ramp transactions for the authenticated app.", "operationId": "fetch-off-ramp-transactions", "parameters": [ { "name": "page", "in": "query", "description": "Page number. Must be a positive integer. Defaults to 1.", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "description": "Number of records per page. Must be a positive integer. Defaults to 25, max 50.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter by transaction status.", "schema": { "type": "string", "enum": [ "completed", "pending", "processing", "refunded", "needs_attention", "failed", "abandoned", "cancelled", "swap_reversed" ] } }, { "name": "from_currency", "in": "query", "description": "Filter by source currency code, e.g. ngn, usdt.", "schema": { "type": "string" } }, { "name": "to_currency", "in": "query", "description": "Filter by destination currency code, e.g. usd, ngn.", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Start date. Must be used with end_date. Format: YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "End date. Must be used with start_date. Format: YYYY-MM-DD.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": \"ok\",\n \"message\": \"Transactions fetched successfully\",\n \"data\": [\n {\n \"public_id\": \"7a0234bf-6be4-41ea-a168-618358ef0e7f\",\n \"status\": \"completed\",\n \"mode\": \"sell\",\n \"from_currency\": \"USDT\",\n \"to_currency\": \"GHS\",\n \"from_amount\": \"4.5\",\n \"to_amount\": \"47.652228\",\n \"network\": \"bep20\",\n \"merchant_reference\": \"tx123bb45-ramp-12221-Alva\",\n \"crypto_deposit\": {\n \"public_id\": \"94e44666-12d2-400e-9fda-0d6786e0c9b2\",\n \"txid\": \"0xc9f1626c602adff92098c8d57a528564022b7bab31d785b29b301bb9adb3173e\",\n \"status\": \"accepted\",\n \"amount\": \"4.5\",\n \"currency\": \"usdt\",\n \"network\": \"bep20\",\n \"created_at\": \"2025-12-03T11:09:51.098Z\",\n \"updated_at\": \"2025-12-03T11:09:51.213Z\"\n },\n \"error_message\": null,\n \"fiat_payout\": {\n \"public_id\": \"7ad2ca95-b777-4897-9c2a-730fb483ce1f\",\n \"amount\": \"47.652228\",\n \"status\": \"completed\",\n \"currency\": \"ghs\",\n \"processor_fee\": \"2.0\",\n \"completed_at\": null,\n \"created_at\": \"2025-12-03T11:10:00.853Z\",\n \"updated_at\": \"2025-12-03T11:10:11.580Z\"\n },\n \"created_at\": \"2025-12-03T10:59:12.488Z\",\n \"updated_at\": \"2025-12-03T11:10:11.725Z\"\n },\n {\n \"public_id\": \"61e87c86-2616-45e7-9f14-f47e2d2d41cc\",\n \"status\": \"completed\",\n \"mode\": \"sell\",\n \"from_currency\": \"USDT\",\n \"to_currency\": \"GHS\",\n \"from_amount\": \"4.5\",\n \"to_amount\": \"52.0839\",\n \"network\": \"bep20\",\n \"merchant_reference\": \"tx123bb45-ramp-12221-Keon\",\n \"crypto_deposit\": {\n \"public_id\": \"21c6b094-d1a8-465f-b875-b6c4dacc39e2\",\n \"txid\": \"0xd8110f06fd47aa813a4d2f37f41f750104f064e434dfd8a58cfc4929c8cb2d4c\",\n \"status\": \"accepted\",\n \"amount\": \"4.5\",\n \"currency\": \"usdt\",\n \"network\": \"bep20\",\n \"created_at\": \"2025-11-07T16:12:55.936Z\",\n \"updated_at\": \"2025-11-07T16:12:55.977Z\"\n },\n \"error_message\": null,\n \"fiat_payout\": {\n \"public_id\": \"a800fb8a-54f8-4310-a514-d68c77c12db6\",\n \"amount\": \"52.0839\",\n \"status\": \"completed\",\n \"currency\": \"ghs\",\n \"processor_fee\": \"0.5261\",\n \"completed_at\": null,\n \"created_at\": \"2025-11-07T16:13:02.664Z\",\n \"updated_at\": \"2025-11-07T16:15:17.655Z\"\n },\n \"created_at\": \"2025-11-07T16:06:25.534Z\",\n \"updated_at\": \"2025-11-07T16:15:17.735Z\"\n },\n {\n \"public_id\": \"ddd5e3e8-da3e-44e7-98ef-2f570cdc58be\",\n \"status\": \"completed\",\n \"mode\": \"sell\",\n \"from_currency\": \"USDT\",\n \"to_currency\": \"GHS\",\n \"from_amount\": \"4.5\",\n \"to_amount\": \"51.7275\",\n \"network\": \"bep20\",\n \"merchant_reference\": \"tx123bb45-ramp-12221-Mallie3\",\n \"crypto_deposit\": {\n \"public_id\": \"6a8ae568-b492-46f4-ac03-fd4a6a36861e\",\n \"txid\": \"0xf965fb5e066a2910fc8570916f0f60aa49899fd198911976ce340c86f71811f2\",\n \"status\": \"accepted\",\n \"amount\": \"4.5\",\n \"currency\": \"usdt\",\n \"network\": \"bep20\",\n \"created_at\": \"2025-10-30T10:40:36.660Z\",\n \"updated_at\": \"2025-10-30T10:40:36.706Z\"\n },\n \"error_message\": null,\n \"fiat_payout\": {\n \"public_id\": \"5752afe1-82cb-4b81-84a6-d2081c8c5ec5\",\n \"amount\": \"51.7275\",\n \"status\": \"completed\",\n \"currency\": \"ghs\",\n \"processor_fee\": \"1.0\",\n \"completed_at\": null,\n \"created_at\": \"2025-11-06T13:49:57.029Z\",\n \"updated_at\": \"2025-11-06T13:52:16.839Z\"\n },\n \"created_at\": \"2025-10-30T10:33:11.806Z\",\n \"updated_at\": \"2025-11-06T13:52:16.922Z\"\n },\n {\n \"public_id\": \"3cf5f9e7-6706-434f-a2b7-633dcba36510\",\n \"status\": \"pending\",\n \"mode\": \"sell\",\n \"from_currency\": \"CNGN\",\n \"to_currency\": \"NGN\",\n \"from_amount\": \"3000.0\",\n \"to_amount\": \"2930.032\",\n \"network\": \"bep20\",\n \"merchant_reference\": \"mnnmmjffbnnbnbbbbbjbbbbffbbjmnnmnolkbbbh\",\n \"crypto_deposit\": null,\n \"error_message\": null,\n \"fiat_payout\": null,\n \"created_at\": \"2026-06-17T17:56:16.406Z\",\n \"updated_at\": \"2026-06-17T17:56:16.852Z\"\n },\n {\n \"public_id\": \"eb63553b-f2fb-4305-83b3-115e6bf29fe5\",\n \"status\": \"pending\",\n \"mode\": \"sell\",\n \"from_currency\": \"CNGN\",\n \"to_currency\": \"NGN\",\n \"from_amount\": \"3000.0\",\n \"to_amount\": \"2930.032\",\n \"network\": \"bep20\",\n \"merchant_reference\": \"mnnmmjffbnnbnbbbbbjbbbbffbbjmnnmnolkbbh\",\n \"crypto_deposit\": null,\n \"error_message\": null,\n \"fiat_payout\": null,\n \"created_at\": \"2026-06-17T17:56:08.386Z\",\n \"updated_at\": \"2026-06-17T17:56:08.653Z\"\n }\n ],\n \"meta\": {\n \"page\": 1,\n \"per_page\": 10,\n \"total_count\": 3,\n \"total_pages\": 1,\n \"next_page\": null\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "ok" }, "message": { "type": "string", "example": "Transactions fetched successfully" }, "data": { "type": "array", "items": { "type": "object", "properties": { "public_id": { "type": "string", "example": "7a0234bf-6be4-41ea-a168-618358ef0e7f" }, "status": { "type": "string", "example": "completed" }, "mode": { "type": "string", "example": "sell" }, "from_currency": { "type": "string", "example": "USDT" }, "to_currency": { "type": "string", "example": "GHS" }, "from_amount": { "type": "string", "example": "4.5" }, "to_amount": { "type": "string", "example": "47.652228" }, "network": { "type": "string", "example": "bep20" }, "merchant_reference": { "type": "string", "example": "tx123bb45-ramp-12221-Alva" }, "crypto_deposit": { "type": "object", "properties": { "public_id": { "type": "string", "example": "94e44666-12d2-400e-9fda-0d6786e0c9b2" }, "txid": { "type": "string", "example": "0xc9f1626c602adff92098c8d57a528564022b7bab31d785b29b301bb9adb3173e" }, "status": { "type": "string", "example": "accepted" }, "amount": { "type": "string", "example": "4.5" }, "currency": { "type": "string", "example": "usdt" }, "network": { "type": "string", "example": "bep20" }, "created_at": { "type": "string", "example": "2025-12-03T11:09:51.098Z" }, "updated_at": { "type": "string", "example": "2025-12-03T11:09:51.213Z" } } }, "error_message": {}, "fiat_payout": { "type": "object", "properties": { "public_id": { "type": "string", "example": "7ad2ca95-b777-4897-9c2a-730fb483ce1f" }, "amount": { "type": "string", "example": "47.652228" }, "status": { "type": "string", "example": "completed" }, "currency": { "type": "string", "example": "ghs" }, "processor_fee": { "type": "string", "example": "2.0" }, "completed_at": {}, "created_at": { "type": "string", "example": "2025-12-03T11:10:00.853Z" }, "updated_at": { "type": "string", "example": "2025-12-03T11:10:11.580Z" } } }, "created_at": { "type": "string", "example": "2025-12-03T10:59:12.488Z" }, "updated_at": { "type": "string", "example": "2025-12-03T11:10:11.725Z" } } } }, "meta": { "type": "object", "properties": { "page": { "type": "integer", "example": 1, "default": 0 }, "per_page": { "type": "integer", "example": 10, "default": 0 }, "total_count": { "type": "integer", "example": 3, "default": 0 }, "total_pages": { "type": "integer", "example": 1, "default": 0 }, "next_page": {} } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "invalid currency": { "value": "{\n \"message\": \"Invalid currency\",\n \"data\": null\n}" }, "invalid status": { "value": "{\n \"message\": \"status is invalid\",\n \"data\": null\n}" }, "Invalid date range": { "value": "{\n \"message\": \"start_date and end_date must both be present\",\n \"data\": null\n}" }, "Invalid pagination": { "value": "{\n \"message\": \"page must be a positive integer\",\n \"data\": null\n}" } }, "schema": { "oneOf": [ { "title": "invalid currency", "type": "object", "properties": { "message": { "type": "string", "example": "Invalid currency" }, "data": {} } }, { "title": "invalid status", "type": "object", "properties": { "message": { "type": "string", "example": "status is invalid" }, "data": {} } }, { "title": "Invalid date range", "type": "object", "properties": { "message": { "type": "string", "example": "start_date and end_date must both be present" }, "data": {} } }, { "title": "Invalid pagination", "type": "object", "properties": { "message": { "type": "string", "example": "page must be a positive integer" }, "data": {} } } ] } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "invalid api key": { "value": "{\n \"status\": \"forbidden\",\n \"message\": \"Invalid private key\",\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "forbidden" }, "message": { "type": "string", "example": "Invalid private key" }, "data": {} } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true, "_id": "6981ba5faf9470ee082aeecd:6a4e2e0648ec8f33f572860b" } ```