跳转到主要内容
WEBHOOK
subscriptionOrderNotifyWebhook
{
  "bizId": "82285581939245166",
  "bizStatus": "CANCELLED",
  "bizType": "SUBSCRIPTION_ORDER_STATUS",
  "data": {
    "authorizedAmount": "0.01",
    "chain": "USDC",
    "createTime": 1774942804115,
    "cryptoAmount": "0.01",
    "cryptoCurrency": "USDT",
    "endTime": 1806478803644,
    "interval": 2,
    "lastPayTime": 0,
    "merchantId": "1627288",
    "merchantSubscriptionOrderNo": "4322055233",
    "orderStatus": "CANCELLED",
    "paidCount": 0,
    "paymentChannel": "WEB3",
    "period": "MONTH",
    "planDesc": "计划描述",
    "planName": "plan001",
    "planNo": "82285581939245065",
    "productName": "测试商品",
    "productNo": "79367222528049209",
    "subscriptionOrderNo": "82285581939245166",
    "totalPaidAmount": "0",
    "totalPayCount": 2,
    "trialDays": 0,
    "updateTime": 1775031195787,
    "userAddress": ""
  }
}
{
  "returnCode": "SUCCESS",
  "returnMessage": ""
}

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.

概述

本页说明 webhook subscriptionOrderNotifyWebhook。完整的参数、响应结构与示例由上方关联的 OpenAPI 或 webhook 定义渲染。

说明

  • 该页描述的是 GatePay 主动投递的回调载荷,不是商户主动发起的请求。
  • 收到回调后请先完成签名校验,再进行幂等处理与业务更新。
  • 如需查看按业务场景拆分的回调说明,请结合 Guide 中的通知章节一并阅读。
  • 通用签名规则请参见 /api-reference/version/100/cn/common/securityAndSignature

请求体

application/json

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

bizType
string

业务类型:SUBSCRIPTION_ORDER_STATUS

bizStatus
enum<string>

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

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

响应

200 - application/json

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

returnCode
string

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

returnMessage
string

响应描述,成功时为空