--- agentTools: projectIndex: https://docs.quidax.io/llms.txt --- # Fetch On 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": { "/on_ramp_transactions": { "get": { "summary": "Fetch On Ramp Transactions", "description": "These endpoints allow a merchant to fetch paginated on-ramp transactions for the authenticated app.", "operationId": "fetch-on-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\": \"d5e46711-7f96-4d81-8f7a-57b6c7304090\",\n \"status\": \"completed\",\n \"mode\": \"buy\",\n \"from_currency\": \"ngn\",\n \"to_currency\": \"usdt\",\n \"from_amount\": \"3000.0\",\n \"to_amount\": \"2.0542\",\n \"network\": \"celo\",\n \"merchant_reference\": \"user-demo\",\n \"error_message\": null,\n \"blockchain_fee\": \"0.005\",\n \"crypto_payout\": {\n \"public_id\": \"09a7fe6e-a933-45b5-8def-85c2af15a823\",\n \"transaction_hash\": \"0x2c8cb922aede1464ec575c5e06a5740d7b015c5b890183ad951085c4adfd7d97\",\n \"status\": \"completed\",\n \"amount\": \"2.0542\",\n \"processor_fee\": \"0.005\",\n \"address\": \"0xEBd827CC80D8BD95B42824467D45A6faAe91A05e\",\n \"network\": \"celo\",\n \"currency\": \"usdt\",\n \"created_at\": \"2026-02-10T09:59:22.715Z\",\n \"updated_at\": \"2026-02-10T09:59:44.800Z\"\n },\n \"fiat_deposit\": {\n \"public_id\": \"44b8c2bd-34e1-4e8b-8745-2460f1ce46fb\",\n \"status\": \"success\",\n \"currency\": \"ngn\",\n \"amount\": \"3000.0\",\n \"fee\": \"80.63\",\n \"created_at\": \"2026-02-10T09:59:14.842Z\",\n \"updated_at\": \"2026-02-10T09:59:14.857Z\"\n },\n \"mobile_money_deposit\": null,\n \"created_at\": \"2026-02-10T09:57:23.872Z\",\n \"updated_at\": \"2026-02-10T09:59:44.823Z\"\n },\n {\n \"public_id\": \"1ebf538b-2466-460e-bd1a-656f1be7d9a9\",\n \"status\": \"completed\",\n \"mode\": \"buy\",\n \"from_currency\": \"ghs\",\n \"to_currency\": \"usdt\",\n \"from_amount\": \"51.15\",\n \"to_amount\": \"3.721\",\n \"network\": \"celo\",\n \"merchant_reference\": \"993894514678\",\n \"error_message\": null,\n \"blockchain_fee\": \"0.005\",\n \"crypto_payout\": {\n \"public_id\": \"f3fbeb36-5215-401b-bd51-44055842d872\",\n \"transaction_hash\": \"0xb2cc5978370c09989d710a08307650e2b76229162e21f54dbb3f758887a683e0\",\n \"status\": \"completed\",\n \"amount\": \"3.721\",\n \"processor_fee\": \"0.005\",\n \"address\": \"0x1e2555b82b0f805be51510E9E65dD5bFB9f4e200\",\n \"network\": \"celo\",\n \"currency\": \"usdt\",\n \"created_at\": \"2025-12-03T11:10:54.453Z\",\n \"updated_at\": \"2025-12-03T11:11:26.414Z\"\n },\n \"fiat_deposit\": null,\n \"mobile_money_deposit\": {\n \"public_id\": \"e324d524-d3e2-4c38-b7f2-5d8ab48c113f\",\n \"status\": \"success\",\n \"currency\": \"ghs\",\n \"amount\": \"51.15\",\n \"fee\": null,\n \"created_at\": \"2025-12-03T11:10:01.531Z\",\n \"updated_at\": \"2025-12-03T11:10:43.833Z\"\n },\n \"created_at\": \"2025-12-03T11:06:48.162Z\",\n \"updated_at\": \"2025-12-03T11:11:26.434Z\"\n },\n {\n \"public_id\": \"0188ef67-229e-4305-b3a6-30f12108bd99\",\n \"status\": \"pending\",\n \"mode\": \"buy\",\n \"from_currency\": \"ghs\",\n \"to_currency\": \"usdt\",\n \"from_amount\": \"300.0\",\n \"to_amount\": \"23.32624\",\n \"network\": \"bep20\",\n \"merchant_reference\": \"bbnvvnnbnnbbhjjhggg\",\n \"error_message\": null,\n \"blockchain_fee\": \"0.02\",\n \"crypto_payout\": null,\n \"fiat_deposit\": null,\n \"mobile_money_deposit\": {\n \"public_id\": \"25abd549-380f-44bf-8b44-485ae517b4bc\",\n \"status\": \"processing\",\n \"currency\": \"ghs\",\n \"amount\": \"300.0\",\n \"fee\": null,\n \"created_at\": \"2026-06-19T15:01:57.379Z\",\n \"updated_at\": \"2026-06-19T15:01:57.581Z\"\n },\n \"created_at\": \"2026-06-18T14:20:01.227Z\",\n \"updated_at\": \"2026-06-18T14:20:01.400Z\"\n },\n {\n \"public_id\": \"b4fc3a4c-3889-4829-a922-e848a142576c\",\n \"status\": \"pending\",\n \"mode\": \"buy\",\n \"from_currency\": \"ghs\",\n \"to_currency\": \"usdt\",\n \"from_amount\": \"300.0\",\n \"to_amount\": \"23.36608\",\n \"network\": \"bep20\",\n \"merchant_reference\": \"bbnnnbbhjjhggg\",\n \"error_message\": null,\n \"blockchain_fee\": \"0.02\",\n \"crypto_payout\": null,\n \"fiat_deposit\": null,\n \"mobile_money_deposit\": null,\n \"created_at\": \"2026-06-18T13:59:10.219Z\",\n \"updated_at\": \"2026-06-18T13:59:10.418Z\"\n },\n {\n \"public_id\": \"8dfc8dd1-eeb7-49c6-814b-fc199bddbd29\",\n \"status\": \"abandoned\",\n \"mode\": \"buy\",\n \"from_currency\": \"ngn\",\n \"to_currency\": \"usdt\",\n \"from_amount\": \"30000.0\",\n \"to_amount\": \"21.2542612\",\n \"network\": \"bep20\",\n \"merchant_reference\": \"bbbfvvffgbfbffbgffffffgggnfnffnfffnbbfff\",\n \"error_message\": null,\n \"blockchain_fee\": \"0.02\",\n \"crypto_payout\": null,\n \"fiat_deposit\": null,\n \"mobile_money_deposit\": null,\n \"created_at\": \"2026-06-10T19:49:37.819Z\",\n \"updated_at\": \"2026-06-11T00:01:13.707Z\"\n },\n {\n \"public_id\": \"faba4496-bfb1-44eb-8889-1737c32bda0c\",\n \"status\": \"abandoned\",\n \"mode\": \"buy\",\n \"from_currency\": \"ngn\",\n \"to_currency\": \"usdt\",\n \"from_amount\": \"3000.0\",\n \"to_amount\": \"2.124388\",\n \"network\": \"bep20\",\n \"merchant_reference\": \"bbbfvvffgbfbffbgffffffgggnnffnfffnbbfff\",\n \"error_message\": null,\n \"blockchain_fee\": \"0.02\",\n \"crypto_payout\": null,\n \"fiat_deposit\": null,\n \"mobile_money_deposit\": null,\n \"created_at\": \"2026-06-10T19:49:10.109Z\",\n \"updated_at\": \"2026-06-11T00:01:13.636Z\"\n }\n ],\n \"meta\": {\n \"page\": 1,\n \"per_page\": 25,\n \"total_count\": 16,\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": "d5e46711-7f96-4d81-8f7a-57b6c7304090" }, "status": { "type": "string", "example": "completed" }, "mode": { "type": "string", "example": "buy" }, "from_currency": { "type": "string", "example": "ngn" }, "to_currency": { "type": "string", "example": "usdt" }, "from_amount": { "type": "string", "example": "3000.0" }, "to_amount": { "type": "string", "example": "2.0542" }, "network": { "type": "string", "example": "celo" }, "merchant_reference": { "type": "string", "example": "user-demo" }, "error_message": {}, "blockchain_fee": { "type": "string", "example": "0.005" }, "crypto_payout": { "type": "object", "properties": { "public_id": { "type": "string", "example": "09a7fe6e-a933-45b5-8def-85c2af15a823" }, "transaction_hash": { "type": "string", "example": "0x2c8cb922aede1464ec575c5e06a5740d7b015c5b890183ad951085c4adfd7d97" }, "status": { "type": "string", "example": "completed" }, "amount": { "type": "string", "example": "2.0542" }, "processor_fee": { "type": "string", "example": "0.005" }, "address": { "type": "string", "example": "0xEBd827CC80D8BD95B42824467D45A6faAe91A05e" }, "network": { "type": "string", "example": "celo" }, "currency": { "type": "string", "example": "usdt" }, "created_at": { "type": "string", "example": "2026-02-10T09:59:22.715Z" }, "updated_at": { "type": "string", "example": "2026-02-10T09:59:44.800Z" } } }, "fiat_deposit": { "type": "object", "properties": { "public_id": { "type": "string", "example": "44b8c2bd-34e1-4e8b-8745-2460f1ce46fb" }, "status": { "type": "string", "example": "success" }, "currency": { "type": "string", "example": "ngn" }, "amount": { "type": "string", "example": "3000.0" }, "fee": { "type": "string", "example": "80.63" }, "created_at": { "type": "string", "example": "2026-02-10T09:59:14.842Z" }, "updated_at": { "type": "string", "example": "2026-02-10T09:59:14.857Z" } } }, "mobile_money_deposit": {}, "created_at": { "type": "string", "example": "2026-02-10T09:57:23.872Z" }, "updated_at": { "type": "string", "example": "2026-02-10T09:59:44.823Z" } } } }, "meta": { "type": "object", "properties": { "page": { "type": "integer", "example": 1, "default": 0 }, "per_page": { "type": "integer", "example": 25, "default": 0 }, "total_count": { "type": "integer", "example": 16, "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:6a4e2c97316df59a2f88fc61" } ```