---
agentTools:
  projectIndex: https://docs.quidax.io/llms.txt
---

# Fetch On Ramp Transaction

# 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_transaction/{merchant_reference}": {
      "get": {
        "summary": "Fetch On Ramp Transaction",
        "description": "",
        "operationId": "fetch-on-ramp-transaction",
        "parameters": [
          {
            "name": "merchant_reference",
            "in": "path",
            "description": "The merchant reference provided when the on-ramp transaction was created.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"status\": \"ok\",\n  \"message\": \"Transaction found\",\n  \"data\": {\n    \"public_id\": \"11fbee44-eef0-4d27-b21c-b2d0070aa3bb\",\n    \"status\": \"completed\",\n    \"mode\": \"buy\",\n    \"from_currency\": \"ngn\",\n    \"to_currency\": \"usdc\",\n    \"from_amount\": \"3000.0\",\n    \"to_amount\": \"1.927314\",\n    \"network\": \"solana\",\n    \"merchant_reference\": \"rhhhhfffbbfffrrrrr\",\n    \"error_message\": null,\n    \"blockchain_fee\": \"0.025\",\n    \"crypto_payout\": {\n      \"public_id\": \"656b176e-9e33-48ec-bf8b-b5f119ef05ac\",\n      \"transaction_hash\": \"5WCENqT47Qs3aGz2yghSvDMYK2KBCmxEShaPWeyiLgP1Y5V7QXRHuQwkFa83HZwUbyUckQV9RUV4WfEaSBhQrrTi\",\n      \"status\": \"completed\",\n      \"amount\": \"1.927314\",\n      \"processor_fee\": \"0.025\",\n      \"address\": \"FQw1J6qke2JDgjzLmdzeU7mxKgNDePK2Stf81XGpUZog\",\n      \"network\": \"solana\",\n      \"currency\": \"usdc\",\n      \"created_at\": \"2026-05-29T16:57:24.982Z\",\n      \"updated_at\": \"2026-05-29T16:58:21.729Z\"\n    },\n    \"fiat_deposit\": {\n      \"public_id\": \"d0dbc26b-3937-4d09-87ef-9a1a231d60d1\",\n      \"status\": \"success\",\n      \"currency\": \"ngn\",\n      \"amount\": \"3000.0\",\n      \"fee\": \"80.63\",\n      \"created_at\": \"2026-05-29T16:57:19.983Z\",\n      \"updated_at\": \"2026-05-29T16:57:20.008Z\"\n    },\n    \"mobile_money_deposit\": null,\n    \"created_at\": \"2026-05-29T16:53:50.733Z\",\n    \"updated_at\": \"2026-05-29T16:58:21.755Z\"\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "ok"
                    },
                    "message": {
                      "type": "string",
                      "example": "Transaction found"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "public_id": {
                          "type": "string",
                          "example": "11fbee44-eef0-4d27-b21c-b2d0070aa3bb"
                        },
                        "status": {
                          "type": "string",
                          "example": "completed"
                        },
                        "mode": {
                          "type": "string",
                          "example": "buy"
                        },
                        "from_currency": {
                          "type": "string",
                          "example": "ngn"
                        },
                        "to_currency": {
                          "type": "string",
                          "example": "usdc"
                        },
                        "from_amount": {
                          "type": "string",
                          "example": "3000.0"
                        },
                        "to_amount": {
                          "type": "string",
                          "example": "1.927314"
                        },
                        "network": {
                          "type": "string",
                          "example": "solana"
                        },
                        "merchant_reference": {
                          "type": "string",
                          "example": "rhhhhfffbbfffrrrrr"
                        },
                        "error_message": {},
                        "blockchain_fee": {
                          "type": "string",
                          "example": "0.025"
                        },
                        "crypto_payout": {
                          "type": "object",
                          "properties": {
                            "public_id": {
                              "type": "string",
                              "example": "656b176e-9e33-48ec-bf8b-b5f119ef05ac"
                            },
                            "transaction_hash": {
                              "type": "string",
                              "example": "5WCENqT47Qs3aGz2yghSvDMYK2KBCmxEShaPWeyiLgP1Y5V7QXRHuQwkFa83HZwUbyUckQV9RUV4WfEaSBhQrrTi"
                            },
                            "status": {
                              "type": "string",
                              "example": "completed"
                            },
                            "amount": {
                              "type": "string",
                              "example": "1.927314"
                            },
                            "processor_fee": {
                              "type": "string",
                              "example": "0.025"
                            },
                            "address": {
                              "type": "string",
                              "example": "FQw1J6qke2JDgjzLmdzeU7mxKgNDePK2Stf81XGpUZog"
                            },
                            "network": {
                              "type": "string",
                              "example": "solana"
                            },
                            "currency": {
                              "type": "string",
                              "example": "usdc"
                            },
                            "created_at": {
                              "type": "string",
                              "example": "2026-05-29T16:57:24.982Z"
                            },
                            "updated_at": {
                              "type": "string",
                              "example": "2026-05-29T16:58:21.729Z"
                            }
                          }
                        },
                        "fiat_deposit": {
                          "type": "object",
                          "properties": {
                            "public_id": {
                              "type": "string",
                              "example": "d0dbc26b-3937-4d09-87ef-9a1a231d60d1"
                            },
                            "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-05-29T16:57:19.983Z"
                            },
                            "updated_at": {
                              "type": "string",
                              "example": "2026-05-29T16:57:20.008Z"
                            }
                          }
                        },
                        "mobile_money_deposit": {},
                        "created_at": {
                          "type": "string",
                          "example": "2026-05-29T16:53:50.733Z"
                        },
                        "updated_at": {
                          "type": "string",
                          "example": "2026-05-29T16:58:21.755Z"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "403",
            "content": {
              "application/json": {
                "examples": {
                  "Invalid private 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": {}
                  }
                }
              }
            }
          },
          "404": {
            "description": "404",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"status\": \"not_found\",\n  \"message\": \"Transaction not found\",\n  \"data\": null\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "not_found"
                    },
                    "message": {
                      "type": "string",
                      "example": "Transaction not found"
                    },
                    "data": {}
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "6981ba5faf9470ee082aeecd:6981ba5faf9470ee082aef5b"
}
```