Skip to main content
WEBHOOK

概述

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

说明

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

触发情形

  • 批量转账订单状态发生改变时,GatePay 向商户注册时配置的 callback URL 发送通知
  • 若通知投递失败,重试规则见 通知概览
适用范围:批量转账 / 批量奖励类订单(bizTypePAY_BATCH)。

消息结构

消息结构示例

bizStatus 枚举值

data 字段说明

batchItemList 子项字段

回调示例

批量转账完成(bizStatus=PAID

请求体

application/json
bizType
enum<string>
必填

业务类型,固定为 PAY_BATCH

可用选项:
PAY_BATCH
bizId
string
必填

批量订单 ID,对应 batchTransferModel.getBatchId()

bizStatus
enum<string>
必填

批量订单状态,对应 batchTransferModel.getStatus()。按当前发送链路,示例值为 PAID

可用选项:
PAID
data
string
必填

业务数据 JSON 字符串,值来自 JSON.toJSONString(batchOrderNotify),解析后结构见 batchTransferData

client_id
string

创建订单的商户 client_id

batchTransferData
object

data 解析后的奖励分发批量通知内容。

description
any

响应

200 - application/json

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

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

returnCode
string
必填

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

returnMessage
string | null

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