GAgate

Get OTC Off-ramp Quote

Changed on

Get a fiat-to-crypto quote for the OTC off-ramp flow.

post/withdraw/open/otc/api/v1/quote

Request

  • Base URL
    https://openplatform.gateapi.io
  • Auth
    none declared. Required headers: X-GatePay-Certificate-ClientId, X-GatePay-Signature, X-GatePay-Timestamp, X-GatePay-Nonce

Headers

X-GatePay-Certificate-ClientIdstring required

Merchant application client ID used to identify the calling app.

X-GatePay-Signaturestring required

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

X-GatePay-Timestampstring required

Millisecond timestamp; the difference from server time must not exceed 30 seconds.

X-GatePay-Noncestring required

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

X-GatePay-On-Behalf-Ofstring

Institutional sub-account UID. Only required when an institution submits a request on behalf of a sub-account; not required for direct merchant requests.

Request body

cryptoCurrencystring required

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

fiatCurrencystring required

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

cryptoAmountstring

Cryptocurrency amount used when quoting by crypto amount.

fiatAmountstring

Fiat amount used when quoting by fiat amount.

sidestring required

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

promotionCodestring

Optional promotion code if supported by the OTC business flow.

typestring required

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

bankAccountIdstring

Linked merchant bank account ID (from Query Bank Account List or Create Bank Account).

Example request

{
  "cryptoCurrency": "USDT",
  "fiatCurrency": "USD",
  "fiatAmount": "1000",
  "side": "FIAT",
  "type": "BUY",
  "bankAccountId": "2897434"
}

Response

Success

codestring

Business response code.

statusstring

Top-level request status.

errorMessagestring

Error message when the request fails.

Example response

{
  "code": "0",
  "status": "success",
  "errorMessage": "",
  "data": {
    "quoteToken": "qt_01JXYZABCDEF",
    "validPeriod": 60,
    "cryptoAmount": "1088.42",
    "fiatAmount": "1000",
    "fiatRate": "0.918762",
    "cryptoRate": "1.088420",
    "tradeFee": "10.88",
    "feeCurrency": "USD",
    "feeDetail": [
      {
        "feeType": "BANK",
        "amount": "2.00"
      },
      {
        "feeType": "GATE_PAY",
        "amount": "10.00"
      },
      {
        "feeType": "SUBSIDY",
        "amount": "1.12"
      }
    ]
  }
}

Changes

  • 873496ac0fbfRevision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status