商家转账批次回调通知
更新时间:2025.02.19一、回调描述
微信支付系统通过商家转账回调通知接口通知商户系统单据处理到终态。包含批次处理完成通知、批次关单通知。
商家转账批次单据到终态后(批次完成或者批次关闭,对应批次状态batch_status的值为FINISHED和CLOSED),微信支付会把批次单据的信息发送给商户,商户需要接收处理该消息,并返回应答。
|
二、回调处理步骤
1、商户接收回调通知报文
微信支付会通过POST的方式向回调地址发送回调报文,回调通知的请求主体中会包含JSON格式的通知参数,具体的通知参数列表如下:
通知参数
id 必填 String(36)
【通知ID】通知的唯一ID
create_time 必填 String(32)
遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒。
event_type 必填 String(32)
【通知类型】商家转账批次回调通知的类型。
MCHTRANSFER.BATCH.FINISHED:转账批次处理完成
MCHTRANSFER.BATCH.CLOSED:转账批次关闭
resource_type 必填 String(32)
【通知数据类型】通知的资源数据类型,商家转账通知为encrypt-resource
resource 必填 object
【通知数据】json格式
Click here to expand... | |
summary 必填 String(64)
【回调摘要】回调摘要
通知报文示例
header
resource示例
2、回调验签与应答
商户接收到回调通知报文后,需在5秒内完成对报文的验签,并应答回调通知。
2.1、对回调通知进行验签
回调报文的HTTP请求头中会包含报文的签名信息,用于验签,具体如下:
参数 | 描述 |
---|---|
Wechatpay-Serial | |
Wechatpay-Signature | 验签的签名值 |
Wechatpay-Timestamp | 验签的时间戳 |
Wechatpay-Nonce | 验签的随机字符串 |
验签需使用请求头中的【Wechatpay-Timestamp】、【Wechatpay-Nonce】以及请求主体中JSON格式的通知参数构建出验签串,然后使用【Wechatpay-Serial】对应的微信支付平台证书/微信支付公钥对验签串和【Wechatpay-Signature】进行验签,确保接收的回调内容是来自微信支付。
商户可通过HTTP头"Wechatpay-Serial"中的证书序列号判断选择对应的证书验签,微信支付公钥的序列号固定采用"PUB_KEY_ID_数字串"格式(例如:PUB_KEY_ID_3000000001),若请求头中的序列号不符合该格式,则应使用平台证书进行验签。
详细验签步骤请参考:如何验证签名
微信支付会在极少数通知回调中返回以“WECHATPAY/SIGNTEST/”开头的错误【Wechatpay-Signature】,以检测商户系统是否正确验证签名。商户请参考:如何应对签名探测流量进行处理。
签名探测流量HTTP头中的Wechatpay-Signature示例:
2.2、对回调通知进行应答
商户验签后,根据验签结果对回调进行应答:
验签通过:商户需告知微信支付接收回调成功,HTTP应答状态码需返回200或204,无需返回应答报文。
验签不通过:商户需告知微信支付接收回调失败,HTTP应答状态码需返回5XX或4XX,同时需返回以下应答报文:
code 选填 string(32)
【返回状态码】错误码,FAIL为回调接收失败。
message 选填 string(256)
【返回信息】返回信息,回调接收失败原因。
应答成功示例
200或204
应答失败示例
5XX或4XX
2.3、微信支付回调处理机制说明
微信支付接收到商户的应答后,会根据应答结果做对应的逻辑处理:
若商户应答回调接收成功,微信支付将不再重复发送该回调通知。若因网络或其他原因,商户收到了重复的回调通知,请按正常业务流程进行处理并应答。
若商户应答回调接收失败,或超时(5s)未应答时,微信支付会按照(0s/15s(10次)/300s(10次)/1800s(44次))的频次重复发送回调通知,直至微信支付接收到商户应答成功,或达到最大发送次数(65次)
3、对回调通知内容进行解密
为了保证业务信息的安全性,微信支付将业务信息进行了AES-256-GCM加密,并通过参数resource将加密信息回调给商户,商户需要进行解密后才能获取到业务信息。
解密步骤如下:
获取商户平台上设置的APIv3密钥,设置APIv3密钥可参考文档:APIv3密钥设置方法;
通过回调通知参数resource.algorithm确认加密算法(目前仅支持AEAD_AES_256_GCM,算法的接口细节,请参考:rfc5116)。
使用APIv3密钥与回调通知参数resource.nonce和resource.associated_data,对数据密文resource.ciphertext进行解密,最终可得到JSON格式的业务信息。
解密示例代码可参考文档:如何解密回调报文
注意
使用Java进行回调解密,取JSON串内的参数值时,只需取引号内的内容进行解密。例:"nonce":"123",只需取值123,不用取加上引号的"123"。
resource中ciphertext解密后字段
当 event_type为MCHTRANSFER.BATCH.FINISHED时,数据密文ciphertext解密之后的内容
ObjectBatchFinished json结构:
out_batch_no 必填 String(32)
【商家批次单号】商户系统内部的商家批次单号,在商户系统内部唯一
batch_id 必填 String(64)
【微信批次单号】微信批次单号,微信商家转账系统返回的唯一标识
batch_status 必填 String(32)
【批次状态】
WAIT_PAY: 待付款确认。需要付款出资商户在商家助手小程序或服务商助手小程序进行付款确认
ACCEPTED:已受理。批次已受理成功,若发起批量转账的30分钟后,转账批次单仍处于该状态,可能原因是商户账户余额不足等。商户可查询账户资金流水,若该笔转账批次单的扣款已经发生,则表示批次已经进入转账中,请再次查单确认
PROCESSING:转账中。已开始处理批次内的转账明细单
FINISHED:已完成。批次内的所有转账明细单都已处理完成
CLOSED:已关闭。可查询具体的批次关闭原因确认
total_num 必填 integer
【批次总笔数】转账总笔数。
total_amount 必填 integer
【批次总金额】转账总金额,单位为“分”。
success_amount 必填 integer
【转账成功金额】转账成功的金额,单位为“分”。当批次状态为“PROCESSING”(转账中)时,转账成功金额随时可能变化
success_num 必填 integer
【转账成功笔数】转账成功的笔数。当批次状态为“PROCESSING”(转账中)时,转账成功笔数随时可能变化
fail_amount 必填 integer
【转账失败金额】转账失败的金额,单位为“分”
fail_num 必填 integer
【转账失败笔数】转账失败的笔数
update_time 必填 String(64)
【批次更新时间】
遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒。
对resource中ciphertext进行解密后,得到的资源对象示例
当 event_type 为MCHTRANSFER.BATCH.CLOSED时,数据密文ciphertext解密之后的内容
ObjectBatchClosed, json结构:
mchid 必填 String(32)
【商户号】微信支付分配的商户号
out_batch_no 必填 String(32)
【商家批次单号】商户系统内部的商家批次单号,在商户系统内部唯一
batch_id 必填 String(64)
【微信批次单号】微信批次单号,微信商家转账系统返回的唯一标识
batch_status 必填 String(32)
【批次状态】
WAIT_PAY: 待付款确认。需要付款出资商户在商家助手小程序或服务商助手小程序进行付款确认
ACCEPTED:已受理。批次已受理成功,若发起批量转账的30分钟后,转账批次单仍处于该状态,可能原因是商户账户余额不足等。商户可查询账户资金流水,若该笔转账批次单的扣款已经发生,则表示批次已经进入转账中,请再次查单确认
PROCESSING:转账中。已开始处理批次内的转账明细单
FINISHED:已完成。批次内的所有转账明细单都已处理完成
CLOSED:已关闭。可查询具体的批次关闭原因确认
total_num 必填 integer
【批次总笔数】转账总笔数。
total_amount 必填 integer
【批次总金额】转账总金额,单位为“分”。
close_reason 必填 String(64)
【批次关闭原因】
如果批次单状态为“CLOSED”(已关闭),则有关闭原因
可选取值:
OVERDUE_CLOSE:系统超时关闭,可能原因账户余额不足或其他错误
TRANSFER_SCENE_INVALID:付款确认时,转账场景已不可用,系统做关单处理
update_time 必填 String(64)
【批次更新时间】
遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒。