Skip to main content
WEBHOOK

概述

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

说明

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

触发情形

  • 订阅订单状态发生变更(授权、运行、取消、关闭等)时,GatePay 向商户注册时配置的 callback URL 发送通知
  • 顶层 bizStatus 与解析 data 后的 orderStatus 取值一致
  • bizStatus=CREATED 时不会发送通知
  • 若通知投递失败,重试规则见 通知概览

消息结构

消息结构示例

bizStatus / orderStatus 枚举值

data 字段说明

解析 data JSON 字符串后,常见字段如下:

回调示例

运行中(bizStatus=RUNNING

订单取消(bizStatus=CANCELLED

请求体

application/json

订阅订单状态更新通知入参 POST方式

bizType
string

业务类型:SUBSCRIPTION_ORDER_STATUS

bizStatus
enum<string>

业务状态:订阅订单状态码,与 data.orderStatus 取值一致。

可用选项:
AUTHORIZED,
CONFIRMING,
TRIAL,
RUNNING,
UNPAID,
COMPLETED,
CANCELLED,
CLOSED,
BLOCKED
data
string

订阅订单明细 JSON 字符串。

bizId
string

订阅订单编号(通常与 data.subscriptionOrderNo 一致)。

响应

200 - application/json

返回 HTTP 200 表示已收到回调通知。

returnCode
string

响应码,SUCCESS表示成功 FAIL标识失败

returnMessage
string

响应描述,成功时为空