个人收款-结算回调通知
更新时间:2024.11.08# 一、回调描述
当用户确认结算收款后,微信支付会发起结算,结算结果会通过POST的请求方式,向商户发起结算传入的回调地址发送回调通知,让商户知晓结算结果。
回调地址设置方式: 回调地址通过申请批量结算接口中的“notify_url”参数设置,回调地址的设置规范和回调IP列表请参考文档:回调通知注意事项 (opens new window)。
# 二、回调处理步骤
# 1、商户接收回调通知报文
微信支付会通过POST的方式向回调地址发送回调报文,回调报文的HTTP请求头中会包含报文的签名信息,用于后续验签,具体如下:
参数 | 描述 |
---|---|
Wechatpay-Serial | 验签的“微信支付平台证书”所对应的平台证书序列号 |
Wechatpay-Signature | 验签的签名值 |
Wechatpay-Timestamp | 验签的时间戳 |
Wechatpay-Nonce | 验签的随机字符串 |
回调通知的请求主体中会包含JSON格式的通知参数,具体的通知参数列表如下:
通知参数
- id 必填通知的唯一ID。
- create_time 必填通知创建的时间,使用rfc3339所定义的格式。使用北京时间(+08:00)
- event_type 必填通知的类型,结算成功通知的类型为SETTLEMENT.SUCCESS。
- resource_type 必填通知的资源数据类型,交易结算成功通知为encrypt-resource
- summary 必填回调摘要
- resource 必填通知资源数据。
- 属性
结算成功结果通知
1{2 "id": "EV-2018022511223320873",3 "create_time": "2015-05-20T13:29:35+08:00",4 "resource_type": "encrypt-resource",5 "event_type": "SETTLEMENT.SUCCESS",6 "summary": "个人收款结算成功",7 "resource": {8 "algorithm": "AEAD_AES_256_GCM",9 "ciphertext": "",10 "original_type": "",11 "associated_data": "",12 "nonce": ""13 }14}
# 2、回调验签与应答
商户接收到回调通知报文后,需在5秒内完成对报文的验签,并应答回调通知。
# 2.1、对回调通知进行验签
验签需使用请求头中的【Wechatpay-Timestamp】、【Wechatpay-Nonce】以及请求主体中JSON格式的通知参数构建出验签串,然后使用【Wechatpay-Serial】对应的“微信支付平台证书 (opens new window)”对验签串和【Wechatpay-Signature】进行验签,确保接收的回调内容是来自微信支付。
详细验签步骤请参考:非文件/图片下载如何验证签名 (opens new window)
微信支付会在极少数通知回调中返回以“WECHATPAY/SIGNTEST/”开头的错误【Wechatpay-Signature】,以检测商户系统是否正确验证签名。商户请参考:如何应对签名探测流量 (opens new window) 进行处理。
# 2.2、对回调通知进行应答
商户验签后,根据验签结果对回调进行应答:
验签通过:商户需告知微信支付接收回调成功,HTTP应答状态码需返回200或204,无需返回应答报文。
验签不通过:商户需告知微信支付接收回调失败,HTTP应答状态码需返回5XX或4XX,同时需返回以下应答报文:
- code 必填【返回状态码】
错误码,FAIL为回调接收失败。 - message 选填【返回信息】
返回信息,回调接收失败原因。
应答示例
1{ 2 "code": "FAIL",3 "message": "失败"4}
微信支付接收到商户的应答后,会根据应答结果做对应的逻辑处理:
若商户应答回调接收成功,微信支付后续不再发送该回调内容。若因网络或其他原因,商户收到了重复的回调通知,按正常业务流程应答即可。
若商户应答回调接收失败,或超时(5s)未应答时,微信支付会按照(15s/15s/30s/3m/10m/20m/30m/30m/30m/60m/3h/3h/3h/6h/6h)的频次重复发送回调通知,最多发送15次。
# 3、对回调通知内容进行解密
为了保证业务信息的安全性,微信支付将业务信息进行了AES-256-GCM加密,并通过参数resource将加密信息回调给商户,商户需要进行解密后才能获取到业务信息。
解密步骤如下:
- 获取商户平台上设置的APIv3密钥,记为key;
- 通过回调通知参数resource.algorithm确认加密算法(目前仅支持AEAD_AES_256_GCM,算法的接口细节,请参考:rfc5116 (opens new window))。
- 使用key与回调通知参数resource.nonce和resource.associated_data,对数据密文resource.ciphertext进行解密,最终可得到JSON格式的业务信息。
解密示例代码可参考文档:如何解密回调报文 (opens new window)
注意
- 使用Java进行回调解密,取JSON串内的参数值时,只需取引号内的内容进行解密。例:"nonce":"123",只需取值123,不用取加上引号的"123"。
resource解密后字段
- out_settle_batch_no 必填【商户结算批次单号】 商户结算批次单号
- settle_batch_no 必填【微信支付结算批次单号】 微信支付系统内部生成的结算批次单号,全局唯一对应一条商户结算批次单号。
- individual_auth_id 必填【商品单个人收款方受理授权ID】 标识一个微信用户在该平台用于个人收款的微信支付账户,平台邀请微信用户完成个人收款授权后获得此id,详见 查询个人收款方授权结果
- description 必填【收款方描述】 收款方描述
- state 必填【批次状态】 批次状态,枚举值:
ACCEPTED:已受理
PROCESSING:结算处理中
FAILED:结算异常
SUCCESS:结算完成
RECEIVED:结算已入账 - trade_scenario 必填【交易场景】 交易场景,枚举值:
RECOMMERCE:二手电商 - create_time 必填【批次创建时间】 批次创建时间,遵循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秒。 - finish_time 选填【批次完成时间】 仅在批次状态为【结算成功】的时候有值。
遵循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秒。 - error_message 选填【结算异常原因】 在批次状态为【结算异常】的时候有具体错误描述,其他状态为ok
对resource对象进行解密后,得到的资源对象示例
1{2 "out_settle_batch_no": "123699878455555",3 "settle_batch_no": "123688554855555666",4 "individual_auth_id": "1236996544852212445",5 "description": "共计2笔订单,订单金额xxx元,平台服务费xxx元,合计收款xxx元",6 "state": "SUCCESS",7 "trade_scenario": "RECOMMERCE",8 "create_time": "2024-06-08T10:34:56+08:00",9 "finish_time": "2024-06-08T10:34:56+08:00",10 "error_message": "个人收款受理授权id已失效"11}