Common
Balance
Institution
Payment
Convert
Payout
Gift Card
Subscription
curl --request POST \
--url https://openplatform.gateapi.io/withdraw/open/otc/api/order/create \
--header 'Content-Type: application/json' \
--header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
--header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
--header 'X-GatePay-Signature: <x-gatepay-signature>' \
--header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
--data '
{
"quoteToken": "<string>",
"bankAccountId": "<string>",
"cryptoCurrency": "<string>",
"fiatCurrency": "<string>",
"cryptoAmount": "<string>",
"fiatAmount": "<string>",
"type": "<string>",
"clientOrderId": "<string>"
}
'{
"code": "<string>",
"status": "<string>",
"errorMessage": "<string>",
"data": {
"orderId": "<string>",
"status": "<string>",
"cryptoCurrency": "<string>",
"fiatCurrency": "<string>",
"cryptoAmount": "<string>",
"fiatAmount": "<string>",
"fiatRate": "<string>",
"bankAccountId": "<string>",
"clientOrderId": "<string>",
"type": "<string>",
"createTime": 123,
"updateTime": 123,
"errMsg": "<string>",
"tradeFee": "<string>",
"finalFiatAmount": "<string>",
"bankSlipInfo": "<string>",
"promCode": "<string>"
}
}Create Withdrawal Order
Create an OTC withdrawal order after obtaining a quote.
curl --request POST \
--url https://openplatform.gateapi.io/withdraw/open/otc/api/order/create \
--header 'Content-Type: application/json' \
--header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
--header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
--header 'X-GatePay-Signature: <x-gatepay-signature>' \
--header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
--data '
{
"quoteToken": "<string>",
"bankAccountId": "<string>",
"cryptoCurrency": "<string>",
"fiatCurrency": "<string>",
"cryptoAmount": "<string>",
"fiatAmount": "<string>",
"type": "<string>",
"clientOrderId": "<string>"
}
'{
"code": "<string>",
"status": "<string>",
"errorMessage": "<string>",
"data": {
"orderId": "<string>",
"status": "<string>",
"cryptoCurrency": "<string>",
"fiatCurrency": "<string>",
"cryptoAmount": "<string>",
"fiatAmount": "<string>",
"fiatRate": "<string>",
"bankAccountId": "<string>",
"clientOrderId": "<string>",
"type": "<string>",
"createTime": 123,
"updateTime": 123,
"errMsg": "<string>",
"tradeFee": "<string>",
"finalFiatAmount": "<string>",
"bankSlipInfo": "<string>",
"promCode": "<string>"
}
}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 thePOST /withdraw/open/otc/api/order/create endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.
Notes
- Authentication uses the standard GatePay signed headers.
- This page documents the standard merchant endpoint.
- For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.
Usage Guidance
- Create the order with a fresh quote token.
- Make sure the bank account used in the request is already approved and available for settlement.
- Store the expected fiat amount, trade fee fields, and final settlement information for reconciliation.
- Use callback plus detail query rather than relying on creation response alone.
Headers
Merchant application client ID used to identify the calling app.
HMAC signature generated from the request according to GatePay signing rules.
Unix timestamp used for replay protection and signature verification.
Random nonce used together with the timestamp to prevent replay attacks.
Body
Quote token returned by the quote API.
Destination bank account ID for fiat settlement.
Cryptocurrency being sold. Currently supported: USDT, USDC.
Fiat currency to be settled out. Currently supported: USD.
Crypto amount for the withdrawal order.
Expected fiat settlement amount.
Order type. Use SELL for off-ramp.
Merchant-defined unique order ID.