跳转到主要内容

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.

​
概述

订单状态变更时，GatePay 会向商户配置的回调地址发送异步通知，包括：
  • 支付成功
  • 订单超时
  • 订单取消
如需查看当前版本更完整、按业务类型拆分的回调说明，请优先参考 Guide 中的 通知 页面。本页保留为 API Reference 的通知总览。

​
重试机制

通知失败时按以下间隔重试：15 秒、30 秒、3 分钟、10 分钟、20 分钟、30 分钟、60 分钟、3 小时、6 小时。

​
消息结构

字段说明
bizType业务类型
bizId业务 ID
bizStatus业务状态
client_id应用 ClientId
dataJSON 格式业务数据

​
消息结构示例

{
  "bizType": "PAY",
  "bizId": "xxx",
  "bizStatus": "PAY_SUCCESS",
  "client_id": "xxx",
  "data": "{...}"
}

​
bizType 枚举值

值说明
PAY支付
PAY_REFUND支付退款
PAY_BATCH批量支付
TRANSFER_ADDRESS地址划转
PAY_GIFT_BATCH礼品卡批量支付
WITHDRAW提现
PAY_ADDRESS地址支付
PAY_FIXED_ADDRESS固定地址支付

​
bizStatus 枚举值

值说明
PAY_SUCCESS支付成功
PAY_ERROR支付异常
PAY_CLOSE支付关闭
PAY_BLOCK支付阻塞
REFUND_SUCCESS退款成功
REFUND_PROCESS退款处理中
REFUND_REJECTED退款拒绝
PAY_EXPIRED_IN_PROCESS有效期内已达金额但存在未确认链上记录
TRANSFERRED_ADDRESS_IN_TERM有效期内地址划转入账
TRANSFERRED_ADDRESS_DELAY延迟地址划转入账
CONVERT_ADDRESS_PAY_DELAY换币地址支付延迟
TRANSFERRED_ADDRESS_BLOCK地址划转阻塞
PAID已支付

​
bizType 对应的 Data 结构

​
PAY / TRANSFER_ADDRESS 类型字段

字段类型说明
orderIdstring订单 ID
merchantTradeNostring商户订单号
bizStatusstring业务状态
orderAmountstring订单金额
payAmountstring支付金额
currencystring币种

​
refundInfo 类型

字段类型说明
refundIdstring退款 ID
refundRequestIdstring商户退款请求号
refundAmountstring退款金额
refundStatusstring退款状态

​
batchItemList 类型

字段类型说明
orderIdstring订单 ID
merchantTradeNostring商户订单号
statusstring状态

​
回调示例

​
TRANSFER_ADDRESS 阻塞

{
  "bizType": "TRANSFER_ADDRESS",
  "bizId": "xxx",
  "bizStatus": "TRANSFERRED_ADDRESS_BLOCK",
  "client_id": "xxx",
  "data": "{\"orderId\":\"xxx\",\"merchantTradeNo\":\"xxx\",\"bizStatus\":\"TRANSFERRED_ADDRESS_BLOCK\",...}"
}

​
PAY 支付成功

{
  "bizType": "PAY",
  "bizId": "xxx",
  "bizStatus": "PAY_SUCCESS",
  "client_id": "xxx",
  "data": "{\"orderId\":\"xxx\",\"merchantTradeNo\":\"xxx\",\"bizStatus\":\"PAY_SUCCESS\",\"orderAmount\":\"100\",\"payAmount\":\"100\",\"currency\":\"USDT\",...}"
}

​
TRANSFER_ADDRESS 有效期内入账

{
  "bizType": "TRANSFER_ADDRESS",
  "bizId": "xxx",
  "bizStatus": "TRANSFERRED_ADDRESS_IN_TERM",
  "client_id": "xxx",
  "data": "{\"orderId\":\"xxx\",\"merchantTradeNo\":\"xxx\",\"bizStatus\":\"TRANSFERRED_ADDRESS_IN_TERM\",...}"
}

​
TRANSFER_ADDRESS 延迟入账

{
  "bizType": "TRANSFER_ADDRESS",
  "bizId": "xxx",
  "bizStatus": "TRANSFERRED_ADDRESS_DELAY",
  "client_id": "xxx",
  "data": "{\"orderId\":\"xxx\",\"merchantTradeNo\":\"xxx\",\"bizStatus\":\"TRANSFERRED_ADDRESS_DELAY\",...}"
}

​
PAY_REFUND 退款

{
  "bizType": "PAY_REFUND",
  "bizId": "xxx",
  "bizStatus": "REFUND_SUCCESS",
  "client_id": "xxx",
  "data": "{\"refundInfo\":{\"refundId\":\"xxx\",\"refundRequestId\":\"xxx\",\"refundAmount\":\"100\",\"refundStatus\":\"REFUND_SUCCESS\"},...}"
}

​
PAY_BATCH 批量支付

{
  "bizType": "PAY_BATCH",
  "bizId": "xxx",
  "bizStatus": "PAID",
  "client_id": "xxx",
  "data": "{\"batchItemList\":[{\"orderId\":\"xxx\",\"merchantTradeNo\":\"xxx\",\"status\":\"PAID\"}],...}"
}

​
PAY_ADDRESS 地址支付

{
  "bizType": "PAY_ADDRESS",
  "bizId": "xxx",
  "bizStatus": "PAY_SUCCESS",
  "client_id": "xxx",
  "data": "{\"orderId\":\"xxx\",\"merchantTradeNo\":\"xxx\",\"bizStatus\":\"PAY_SUCCESS\",...}"
}

​
PAY_FIXED_ADDRESS 固定地址支付

{
  "bizType": "PAY_FIXED_ADDRESS",
  "bizId": "xxx",
  "bizStatus": "PAY_SUCCESS",
  "client_id": "xxx",
  "data": "{\"orderId\":\"xxx\",\"merchantTradeNo\":\"xxx\",\"bizStatus\":\"PAY_SUCCESS\",...}"
}

​
PAY_GIFT_BATCH 礼品卡批量支付

{
  "bizType": "PAY_GIFT_BATCH",
  "bizId": "xxx",
  "bizStatus": "PAID",
  "client_id": "xxx",
  "data": "{\"batchItemList\":[...],...}"
}

​
OTC 专属回调说明

对于本套 OTC 文档，商户回调地址还会接收 OTC 业务通知。 常见 OTC 回调状态包括：
bizStatus说明
RECHARGE_SUCCESSOTC 入金成功
RECHARGE_FAILOTC 入金失败
WITHDRAW_DISPATCHEDOTC 出金已出款
WITHDRAW_SUCCESSOTC 出金成功
WITHDRAW_FAILOTC 出金失败
典型 OTC 回调消息体如下： 
{
  "bizType": "OTC",
  "bizId": "2016768770965639168",
  "bizStatus": "WITHDRAW_DISPATCHED",
  "clientId": "merchant_client_id",
  "data": "{\"orderId\":\"2016768770965639168\",\"clientOrderId\":\"7490324045\",\"type\":\"SELL\",\"fiatCurrency\":\"USD\",\"fiatAmount\":\"9800\",\"cryptoCurrency\":\"USDT\",\"cryptoAmount\":\"10000\"}"
}