个人收款-退款结果通知
更新时间:2024.09.29# 一、回调描述
当商户调用申请退款API接口或通过商户平台申请退款 (opens new window)后,微信支付会对订单进行退款,当退款结果出来后,微信支付会通过POST的请求方式,向商户预先设置的回调地址发送回调通知,让商户知晓这笔订单的退款结果。
回调地址设置方式: 回调地址可以通过【申请退款API】接口中的“notify_url”参数设置,也可以在商户平台(交易中心>退款管理>退款配置)设置,优先对接口设置的回调地址进行回调。回调地址的设置规范和回调IP列表请参考文档:回调通知注意事项 (opens new window)。
# 二、回调处理步骤
# 1、商户接收回调通知报文
微信支付会通过POST的方式向回调地址发送回调报文,回调报文的HTTP请求头中会包含报文的签名信息,用于后续验签,具体如下:
参数 | 描述 |
---|---|
Wechatpay-Serial | 验签的“微信支付平台证书”所对应的平台证书序列号 |
Wechatpay-Signature | 验签的签名值 |
Wechatpay-Timestamp | 验签的时间戳 |
Wechatpay-Nonce | 验签的随机字符串 |
回调通知的请求主体中会包含JSON格式的通知参数,具体的通知参数列表如下:
通知参数
- id 必填通知的唯一ID。
- 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秒。 - event_type 必填通知的类型:REFUND.SUCCESS:退款成功通知REFUND.ABNORMAL:退款异常通知REFUND.CLOSED:退款关闭通知
- summary 必填通知简要说明
- resource_type 必填通知的资源数据类型,退款成功通知为encrypt-resource
- resource 必填通知资源数据 json格式,见示例
- 属性
退款通知
1{2 "id":"EV-2018022511223320873",3 "create_time":"2018-06-08T10:34:56+08:00",4 "resource_type":"encrypt-resource",5 "event_type":"REFUND.SUCCESS",6 "summary":"退款成功",7 "resource" : {8 "algorithm":"AEAD_AES_256_GCM",9 "original_type": "refund",10 "ciphertext": "...",11 "nonce": "...",12 "associated_data": ""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解密后字段
- sp_mchid 必填微信支付分配给电商平台的商户号
- individual_auth_id 必填个人收款的微信支付账户,微信用户在该平台的标志
- out_trade_no 必填返回的商户订单号
- transaction_id 必填微信支付订单号
- out_refund_no 必填商户退款单号
- refund_id 必填微信退款单号
- refund_status 必填退款状态,枚举值:SUCCESS:退款成功CLOSE:退款关闭ABNORMAL:退款异常,退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可使用发起异常退款API处理此笔退款
- success_time 选填1、退款成功时间,遵循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年5月20日13点29分35秒。2、当退款状态为退款成功时返回此参数。 - user_received_account 必填取当前退款单的退款入账方。退回银行卡:{银行名称}{卡类型}{卡尾号}退回支付用户零钱: 支付用户零钱退还商户: 商户基本账户、商户结算银行账户退回支付用户零钱通:支付用户零钱通退回用户经营账户:用户经营账户退回支付用户银行电子账户:支付用户银行电子账户退回支付用户零花钱:支付用户零花钱退回支付用户来华零钱包:支付用户来华零钱包退回企业支付商户:企业支付商户
- amount 必填金额信息
- 属性
对resource对象进行解密后,得到的资源对象示例
1{2 "sp_mchid": "1900000100",3 "individual_auth_id": "1900000102",4 "transaction_id": "1009660380201506130728806387",5 "out_trade_no": "20150806125346",6 "refund_id": "50000000382019052709732678859",7 "out_refund_no": "20150806125346",8 "refund_status": "SUCCESS",9 "success_time": "2018-06-08T10:34:56+08:00",10 "user_received_account": "招商银行信用卡0403",11 "amount" : {12 "total": 999,13 "refund": 999,14 "payer_total": 999,15 "payer_refund": 99916 }17}