v1

latestOpenAPI 3.1.02026-07-21152963.1 KB

Create OTC Withdrawal Order

Create an OTC withdrawal order after obtaining a quote.

post/withdraw/open/otc/api/order/create

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

Unix timestamp used for replay protection and signature verification.

X-GatePay-Noncestring required

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

quoteTokenstring required

Quote token returned by the quote API.

bankAccountIdstring required

Destination bank account ID for fiat settlement.

cryptoCurrencystring required

Cryptocurrency being sold. Currently supported: USDT, USDC.

fiatCurrencystring required

Fiat currency to be settled out. Currently supported: USD.

cryptoAmountstring required

Crypto amount for the withdrawal order.

fiatAmountstring required

Expected fiat settlement amount.

typestring required

Order type. Use SELL for off-ramp.

clientOrderIdstring required

Merchant-defined unique order ID.

Success

codestring

Business response code.

statusstring

Top-level request status.

errorMessagestring

Error message when the request fails.