Skip to main content
WEBHOOK

概述

本页说明 webhook addressPaymentNotify。完整的参数、响应结构与示例由上方关联的 OpenAPI 或 webhook 定义渲染。 地址支付订单状态或资金流转变更时,GatePay 向商户配置的 callback URL 发送异步通知(bizTypePAY_ADDRESSTRANSFER_ADDRESSCHAIN_ADDRESS)。

说明

  • 建议基于 merchantTradeNobizId 做幂等处理。
  • 验签、重试、data 解析与成功应答见 通知概览;签名规则见 安全与签名

触发情形

  • 订单由创建状态转为支付完成状态
  • 订单由创建状态转为过期状态
  • 用户在有效期内支付足够金额,但截止订单过期时间链上未确认完毕,进入 PROCESS 状态
  • 订单结束(过期或完成)前,每次检测到成功的支付记录后向商户余额账户转入对应金额;有效期内累计某笔付款总金额达到订单金额后将订单状态改为完成
  • 订单结束后,订单地址检测到新的到账,确认完毕后转入商户余额账户
  • 订单结束后,闪兑订单地址检测到新的到账
  • 动态地址支付场景下,链上充值交易同步、合规验证、确认完成等生命周期节点(CHAIN_ADDRESS

消息结构

bizType 枚举值

bizStatus 枚举值(bizType=PAY_ADDRESS

闪兑地址支付单还可能使用 PAY_EXPIRED_IN_EXCHANGE_FLUCTUATION 等状态(以实际回调为准)。

bizStatus 枚举值(bizType=TRANSFER_ADDRESS

bizStatus 枚举值(bizType=CHAIN_ADDRESS

仅作为记录链上交易与验证过程中的状态,不能等同于订单终态

data 字段说明(bizType=PAY_ADDRESS,非闪兑)

data 字段说明(bizType=PAY_ADDRESS,闪兑)

除上表部分字段外,还可能包含:

data 字段说明(bizType=TRANSFER_ADDRESS

data 字段说明(bizType=CHAIN_ADDRESS

回调示例

订单状态变更(bizType=PAY_ADDRESS,支付成功)

订单状态变更(bizType=PAY_ADDRESS,闪兑)

资金流转(bizType=TRANSFER_ADDRESS

链上交易与验证状态(bizType=CHAIN_ADDRESS

请求体

application/json
bizType
enum<string>
必填

通知类别:PAY_ADDRESS 订单状态变更;TRANSFER_ADDRESS 订单资金流转;CHAIN_ADDRESS 链上交易与验证状态通知。

可用选项:
PAY_ADDRESS,
TRANSFER_ADDRESS,
CHAIN_ADDRESS
bizId
string
必填

订单 ID。

bizStatus
string
必填

业务状态,因 bizType 而异。PAY_ADDRESS 常见:PAY_SUCCESSPAY_ERRORPAY_CLOSEPAY_EXPIRED_IN_PROCESS 等;TRANSFER_ADDRESS 常见:TRANSFERRED_ADDRESS_IN_TERMTRANSFERRED_ADDRESS_DELAYCONVERT_ADDRESS_PAY_DELAYCHAIN_ADDRESS 常见:PAY_PASSED(链上交易合规验证通过)、PAY_CONFIRMING(链上交易开始同步)、PAY_DONE(链上交易已确认)。

data
string
必填

业务数据 JSON 字符串,解析后结构见 addressPaymentData

client_id
string

创建订单的商户 client_id

addressPaymentData
object

data 解析后的对象;非闪兑/闪兑、PAY_ADDRESS/TRANSFER_ADDRESS/CHAIN_ADDRESS 下字段可能不同。

description
any

响应

200 - application/json

返回 HTTP 200 表示商户已成功接收通知。

商户接收通知后的响应体。

returnCode
string
必填

返回状态码,SUCCESS 表示成功。

returnMessage
string | null

返回说明,成功时可为空。