Skip to main content
POST
/
withdraw
/
open
/
institution
/
otc
/
api
/
v1
/
quote
Get OTC On-ramp Quote
curl --request POST \
  --url https://openplatform.gateapi.io/withdraw/open/institution/otc/api/v1/quote \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "cryptoCurrency": "USDT",
  "fiatCurrency": "USD",
  "side": "FIAT",
  "type": "BUY"
}
'
{
  "code": "0",
  "status": "success",
  "errorMessage": "",
  "data": {
    "quoteToken": "qt_01JXYZABCDEF",
    "validPeriod": 60,
    "cryptoAmount": "1088.42",
    "fiatAmount": "1000",
    "fiatRate": "0.918762",
    "cryptoRate": "1.088420"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.gate.com/llms.txt

Use this file to discover all available pages before exploring further.

Overview

This page documents the shared OTC quote API used by both on-ramp and off-ramp flows. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

Notes

Headers

X-GatePay-Certificate-ClientId
string
required

Merchant application client ID used to identify the calling app.

X-GatePay-Signature
string
required

HMAC signature generated from the request according to GatePay signing rules.

X-GatePay-Timestamp
string
required

Unix timestamp used for replay protection and signature verification.

X-GatePay-Nonce
string
required

Random nonce used together with the timestamp to prevent replay attacks.

X-GatePay-On-Behalf-Of
string
required

Required delegated-subject header. Provide the initiating account ID for this request. For institution merchant APIs, this is typically the target sub-account ID; for institution charge and transfer APIs, it can be either an institution account ID or a sub-account ID.

Query Parameters

bankAccountName
string

Bank account name for fuzzy matching.

iban
string

Account number or IBAN for fuzzy matching.

swift
string

SWIFT code for fuzzy matching.

bankName
string

Bank name for fuzzy matching.

Body

application/json
cryptoCurrency
string
required

Cryptocurrency code used in the quote request. On-ramp supports: USDT, USDC. Off-ramp supports: USDT, USDC.

fiatCurrency
string
required

Fiat currency code used in the quote request. Currently supported: USD.

side
string
required

Quote direction. Use CRYPTO to quote by crypto amount or FIAT to quote by fiat amount.

type
string
required

OTC business type. Use BUY for on-ramp and SELL for off-ramp.

cryptoAmount
string

Cryptocurrency amount used when quoting by crypto amount.

fiatAmount
string

Fiat amount used when quoting by fiat amount.

promotionCode
string

Optional promotion code if supported by the OTC business flow.

Response

200 - application/json

Success

code
string

Business response code.

status
string

Top-level request status.

errorMessage
string

Error message when the request fails.

data
object

Quote payload returned by the API.