Skip to main content
WEBHOOK
otcCallbackWebhook
{
  "bizType": "OTC",
  "bizId": "71347515709194240",
  "bizStatus": "RECHARGE_SUCCESS",
  "clientId": "merchant_client_id",
  "data": "{\"orderId\":\"71347515709194240\",\"clientOrderId\":\"merchant_order_20260413001\",\"fiatRate\":\"1.005\",\"type\":\"BUY\",\"fiatCurrency\":\"USD\",\"fiatAmount\":\"100.00\",\"cryptoCurrency\":\"USDT\",\"cryptoAmount\":\"99.50\",\"updateTime\":\"1712989200\"}"
}

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 webhook otcCallbackWebhook. The full schema, parameters, and examples are rendered from the linked OpenAPI or webhook definition above. Webhook callback for OTC on-ramp and off-ramp order status notifications.

​
Notes

  • Always verify callback signatures before trusting the payload.
  • Return HTTP 200 only after the message has been accepted by your backend.
  • Use idempotent processing keyed by business identifiers such as bizId or clientOrderId.
  • The data field in off-ramp callbacks may include bankSlipInfo to represent bank receipt or slip information.
  • If downstream systems are temporarily unavailable, persist the callback first and retry processing asynchronously.
  • For business-flow interpretation of OTC status progression, read this page together with the OTC guide.

Body

application/json
​
bizType
string
required

Fixed OTC business type.

​
bizId
string
required

OTC order ID.

​
bizStatus
enum<string>
required

OTC callback business status.

Available options:
RECHARGE_SUCCESS,
RECHARGE_FAIL,
WITHDRAW_SUCCESS,
WITHDRAW_FAIL,
WITHDRAW_DISPATCHED
​
data
string
required

JSON string containing the order detail snapshot, typically including orderId, clientOrderId, fiatRate, type, fiatCurrency, fiatAmount, cryptoCurrency, cryptoAmount, and updateTime. Off-ramp callbacks may also include tradeFee, finalFiatAmount, and bankSlipInfo.

Example:

"{\"orderId\":\"2016768770965639168\",\"clientOrderId\":\"7490324045\",\"fiatRate\":\"0.9981\",\"type\":\"SELL\",\"fiatCurrency\":\"USD\",\"fiatAmount\":\"9800\",\"cryptoCurrency\":\"USDT\",\"cryptoAmount\":\"10000\",\"updateTime\":\"1769670300606\",\"tradeFee\":\"10.00\",\"finalFiatAmount\":\"9790.00\",\"bankSlipInfo\":\"bank_receipt_20260418.pdf\"}"

​
clientId
string

Merchant client ID.

​
client_id
string

Alternate merchant client ID field used by some integrations.

Response

200

Return HTTP 200 after successful receipt of the callback.