Skip to main content
WEBHOOK

概述

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

说明

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

触发情形

  • 订单状态发生改变时(如支付成功、超出支付时间、订单取消或关闭等),GatePay 向商户注册时配置的 callback URL 发送通知
  • 若通知投递失败,重试规则见 通知概览
适用范围:通过托管收银台、Web/客户端拉起等方式下单,用户通过 Gate 支付账户 完成付款的场景(bizTypePAY)。接入说明见 支付

消息结构

消息结构示例

bizStatus 枚举值

data 字段说明

回调示例

支付成功(bizStatus=PAY_SUCCESS

订单关闭(bizStatus=PAY_CLOSE

支付异常(bizStatus=PAY_ERROR

请求体

application/json
bizType
enum<string>
必填

业务类型,固定为 PAY(非地址支付订单状态变更)。

可用选项:
PAY
bizId
string
必填

预付单 ID(订单 ID)。

bizStatus
enum<string>
必填

订单状态:PAY_SUCCESS 支付成功;PAY_CLOSE 订单超时或商户关闭;PAY_ERROR 支付错误。

可用选项:
PAY_SUCCESS,
PAY_ERROR,
PAY_CLOSE
data
string
必填

订单数据 JSON 字符串,解析后结构见 gatePaymentData

client_id
string

创建订单的商户 client_id

gatePaymentData
object

data 解析后的订单明细。非地址支付场景请使用 orderAmount 判断支付金额。

description
any

响应

200 - application/json

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

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

returnCode
string
必填

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

returnMessage
string | null

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