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

# Initiate On Ramp Transaction

This endpoints initiates the 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": {
    "/custodial/on_ramp_transactions/initiate": {
      "post": {
        "summary": "Initiate On Ramp Transaction",
        "description": "This endpoints initiates the on ramp transaction",
        "operationId": "initiate-on-ramp-transaction",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "from_currency": {
                    "type": "string",
                    "default": "ngn",
                    "enum": [
                      "ngn",
                      "ghs"
                    ]
                  },
                  "to_currency": {
                    "type": "string",
                    "description": "https://docs.quidax.io/docs/supported-crypto-assets",
                    "default": "usdt",
                    "enum": [
                      "usdt",
                      "usdc",
                      "cngn"
                    ]
                  },
                  "from_amount": {
                    "type": "string",
                    "default": "1000"
                  },
                  "merchant_reference": {
                    "type": "string",
                    "default": "xncbncvv"
                  },
                  "customer": {
                    "type": "object",
                    "properties": {
                      "email": {
                        "type": "string",
                        "description": "Note: Please use your company domain for the email extension.",
                        "default": "test@domain.com"
                      },
                      "first_name": {
                        "type": "string",
                        "description": "Please use the customer's first name, as it is the name the system will use for comparison before approving the deposit.",
                        "default": "test"
                      },
                      "last_name": {
                        "type": "string",
                        "description": "Please use the customer's last name, as it is the name the system will use for comparison before approving the deposit.",
                        "default": "user"
                      }
                    }
                  },
                  "wallet_address": {
                    "type": "object",
                    "properties": {
                      "address": {
                        "type": "string",
                        "default": "0xxx"
                      },
                      "network": {
                        "type": "string",
                        "default": "bep20"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"ok\",\n    \"message\": \"Transaction successfully initiated\",\n    \"data\": {\n        \"public_id\": \"6a089a1a-7633-4e4c-b6e6-39da723dd4fa\",\n        \"reference\": \"TRX-29U3YLYGC8\",\n        \"merchant_reference\": \"ui79ffjbbnj-fftxnkfffbb12jj345\",\n        \"from_currency\": \"ngn\",\n        \"to_currency\": \"usdt\",\n        \"from_amount\": \"2000.0\",\n        \"to_amount\": \"1.23\",\n        \"status\": \"pending\",\n        \"created_at\": \"2025-05-16T13:17:30.212Z\",\n        \"updated_at\": \"2025-05-16T13:17:33.292Z\",\n        \"blockchain_fee\": \"1.0\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "ok"
                    },
                    "message": {
                      "type": "string",
                      "example": "Transaction successfully initiated"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "public_id": {
                          "type": "string",
                          "example": "6a089a1a-7633-4e4c-b6e6-39da723dd4fa"
                        },
                        "reference": {
                          "type": "string",
                          "example": "TRX-29U3YLYGC8"
                        },
                        "merchant_reference": {
                          "type": "string",
                          "example": "ui79ffjbbnj-fftxnkfffbb12jj345"
                        },
                        "from_currency": {
                          "type": "string",
                          "example": "ngn"
                        },
                        "to_currency": {
                          "type": "string",
                          "example": "usdt"
                        },
                        "from_amount": {
                          "type": "string",
                          "example": "2000.0"
                        },
                        "to_amount": {
                          "type": "string",
                          "example": "1.23"
                        },
                        "status": {
                          "type": "string",
                          "example": "pending"
                        },
                        "created_at": {
                          "type": "string",
                          "example": "2025-05-16T13:17:30.212Z"
                        },
                        "updated_at": {
                          "type": "string",
                          "example": "2025-05-16T13:17:33.292Z"
                        },
                        "blockchain_fee": {
                          "type": "string",
                          "example": "1.0"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "invalid amount": {
                    "value": "{\n  \"status\": \"bad_request\",\n  \"message\": \"Invalid amount\",\n  \"data\": null\n}"
                  },
                  "Result": {
                    "value": "{\n  \"status\": \"forbidden\",\n  \"message\": \"Invalid private key\",\n  \"data\": null\n}"
                  },
                  "invalid address format": {
                    "value": "{\n  \"status\": \"bad_request\",\n  \"message\": \"Invalid network\",\n  \"data\": null\n}"
                  }
                },
                "schema": {
                  "oneOf": [
                    {
                      "title": "invalid amount",
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "bad_request"
                        },
                        "message": {
                          "type": "string",
                          "example": "Invalid amount"
                        },
                        "data": {}
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "forbidden"
                        },
                        "message": {
                          "type": "string",
                          "example": "Invalid private key"
                        },
                        "data": {}
                      }
                    },
                    {
                      "title": "invalid address format",
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "bad_request"
                        },
                        "message": {
                          "type": "string",
                          "example": "Invalid address format"
                        },
                        "data": {}
                      }
                    },
                    {
                      "title": "invalid address format",
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "bad_request"
                        },
                        "message": {
                          "type": "string",
                          "example": "Invalid network"
                        },
                        "data": {}
                      }
                    }
                  ]
                }
              }
            }
          },
          "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": {}
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "6981ba5faf9470ee082aeecd:6981ba5faf9470ee082aef5f"
}
```