退款结果通知
更新时间:2024.12.10一、回调描述
当商户调用申请退款API接口或通过商户平台申请退款后,微信支付会对订单进行退款,当退款结果出来后,微信支付会通过POST的请求方式,向商户预先设置的回调地址发送回调通知,让商户知晓这笔订单的退款结果。
二、回调处理步骤
1、商户接收回调通知报文
微信支付会通过POST的方式向回调地址发送回调报文,回调报文的HTTP请求头中会包含报文的签名信息,用于后续验签,具体如下:
参数 | 描述 |
---|---|
Wechatpay-Serial | |
Wechatpay-Signature | 验签的签名值 |
Wechatpay-Timestamp | 验签的时间戳 |
Wechatpay-Nonce | 验签的随机字符串 |
回调通知的请求主体中会包含JSON格式的通知参数,具体的通知参数列表如下:
通知参数
Body 包体参数
id 必填 string(36)
【通知ID】
回调通知的唯一编号。
create_time 必填 string(32)
【通知创建时间】回调通知创建的时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。
event_type 必填 string(32)
【通知类型】通知的类型
REFUND.SUCCESS:退款成功通知
REFUND.ABNORMAL:退款异常通知,需商户平台手动处理,参考交易退款方法介绍
REFUND.CLOSED:退款关闭通知。
summary 必填 string(16)
【回调摘要】
微信支付对回调内容的摘要备注。
resource_type 必填 string(32)
【通知数据类型】
通知的资源数据类型,固定为encrypt-resource。
resource 必填 object
通知资源数据
json格式,见示例
属性 | |
退款通知
2、回调验签与应答
商户接收到回调通知报文后,需在5秒内完成对报文的验签,并应答回调通知。
2.1、对回调通知进行验签
验签需使用请求头中的【Wechatpay-Timestamp】、【Wechatpay-Nonce】以及请求主体中JSON格式的通知参数构建出验签串,然后使用【Wechatpay-Serial】对应的微信支付平台证书/微信支付公钥对验签串和【Wechatpay-Signature】进行验签,确保接收的回调内容是来自微信支付。
详细验签步骤请参考:如何验证签名
微信支付会在极少数通知回调中返回以“WECHATPAY/SIGNTEST/”开头的错误【Wechatpay-Signature】,以检测商户系统是否正确验证签名。商户请参考:如何应对签名探测流量进行处理。
2.2、对回调通知进行应答
商户验签后,根据验签结果对回调进行应答:
验签通过:商户需告知微信支付接收回调成功,HTTP应答状态码需返回200或204,无需返回应答报文。
验签不通过:商户需告知微信支付接收回调失败,HTTP应答状态码需返回5XX或4XX,同时需返回以下应答报文:
Body 包体参数
code 选填 string(32)
【返回状态码】
错误码,FAIL为回调接收失败。
message 选填 string(256)
【返回信息】
返回信息,回调接收失败原因。
应答成功示例
200或204
应答失败示例
5XX或4XX
2.3、微信支付回调处理机制说明
微信支付接收到商户的应答后,会根据应答结果做对应的逻辑处理:
若商户应答回调接收成功,微信支付将不再重复发送该回调通知。若因网络或其他原因,商户收到了重复的回调通知,请按正常业务流程进行处理并应答。
若商户应答回调接收失败,或超时(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)。
使用key与回调通知参数resource.nonce和resource.associated_data,对数据密文resource.ciphertext进行解密,最终可得到JSON格式的业务信息。
解密示例代码可参考文档:如何解密回调报文
注意
使用Java进行回调解密,取JSON串内的参数值时,只需取引号内的内容进行解密。例:"nonce":"123",只需取值123,不用取加上引号的"123"。
resource解密后字段
Body 包体参数
mchid 必填 string(32)
【商户号】调用支付分创单接口提交的商户号,商户号需开通支付分产品权限,且与appid有绑定关系,详见直连商户与AppID账号关联管理。
out_trade_no 必填 string(32)
【商户订单号】 支付分轮询扣款时生成的商户订单号。
transaction_id 必填 string(32)
【微信交易订单号】 微信支付分扣款单的唯一标识,非0元结单且支付分渠道扣款成功后支付成功回调和查询支付分订单返回的收款信息明细collection.details中包含该字段。是微信支付下单后,产生的,微信支付内部的原交易单号。
out_refund_no 必填 string(64)
【商户退款单号】 商户申请退款时提交的商户退款单号。
refund_id 必填 string(32)
【微信支付退款号】 微信侧返回的退款单唯一标识,由数字组成,50或52开头。
refund_status 必填 string(32)
【退款状态】退款状态,枚举值:
SUCCESS:退款成功
CLOSED:退款关闭
ABNORMAL:退款异常,退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往【商户平台—>交易中心】,手动处理此笔退款
success_time 选填 string(64)
【退款成功时间】
退款成功时间,退款状态status为SUCCESS退款成功时返回该字段。遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。
user_received_account 必填 string(64)
【退款入账账户】退款单入账方。
取值有以下几种情况
退回银行卡:{银行名称}{卡类型}{卡尾号}
退回支付用户零钱:支付用户零钱退还商户:商户基本账户商户结算银行账户
退回支付用户零钱通:支付用户零钱通
退回支付用户银行电子账户:支付用户银行电子账户
退回支付用户零花钱:支付用户零花钱
退回用户经营账户:用户经营账户
退回支付用户来华零钱包:支付用户来华零钱包
退回企业支付商户:企业支付商户
amount 必填 object
【金额信息】 订单金额信息
属性 | |
对resource对象进行解密后,得到的资源对象示例