退款结果回调通知
更新时间:2024.12.23一、回调描述
用户支付完成后,服务商可根据需求发起退款。当退款单状态发生变更时(变更为退款成功/退款关闭/退款异常),微信支付会通过POST的请求方式,向服务商预先设置的退款回调地址(申请退款传入的notfiy_url)发送回调通知,让服务商知晓退款单的处理结果。
注意: 服务商侧对微信支付回调IP有防火墙策略限制的,需要对微信回调IP段开通白名单,详情参考回调处理逻辑注意事项。
二、回调处理步骤
1、服务商接收回调通知报文
微信支付会通过POST的方式向回调地址发送回调报文,回调报文的HTTP请求头中会包含报文的签名信息,用于后续验签,具体如下:
参数 | 描述 |
---|---|
Wechatpay-Serial | |
Wechatpay-Signature | 验签的签名值 |
Wechatpay-Timestamp | 验签的时间戳 |
Wechatpay-Nonce | 验签的随机字符串 |
回调通知的请求主体中会包含JSON格式的通知参数,具体的通知参数列表如下:
通知参数
Body 包体参数
id 必填 string(36)
【通知ID】回调通知的唯一编号。
create_time 必填 string(32)
【通知创建时间】
1、定义:本次回调通知创建的时间。
2、格式:遵循rfc3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE
。yyyy-MM-DD
表示年月日;T
字符用于分隔日期和时间部分;HH:mm:ss
表示具体的时分秒;TIMEZONE
表示时区(例如,+08:00
对应东八区时间,即北京时间)。
示例: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
通知资源数据
属性 | |
退款通知
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)
【返回信息】返回信息,回调接收失败原因。
应答示例
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 包体参数
sp_mchid 必填 string(32)
【服务商户号】服务商下单时传入的服务商商户号sp_mchid。
sub_mchid 必填 string(32)
【子商户号(也叫特约商户号)】服务商下单时传入的子商户号sub_mchid。
out_trade_no 必填 string(32)
【商户订单号】 服务商下单时传入的服务商系统内部订单号。
transaction_id 必填 string(32)
【微信支付订单号】 微信支付侧订单的唯一标识。
out_refund_no 必填 string(64)
【商户退款单号】 服务商申请退款时传的服务商系统内部退款单号。
refund_id 必填 string(32)
【微信支付退款订单号】申请退款受理成功时,该笔退款单在微信支付侧生成的唯一标识。
status 必填 string
【退款状态】退款单的退款处理状态。
SUCCESS
: 退款成功CLOSED
: 退款关闭PROCESSING
: 退款处理中ABNORMAL
: 退款异常,退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往服务商平台-交易中心,手动处理此笔退款,可参考: 退款异常的处理,或者通过发起异常退款接口进行处理。
注:状态流转说明请参考状态流转图
success_time 选填 string(64)
【退款成功时间】
1、定义:退款成功的时间,该字段在退款状态status为SUCCESS(退款成功)时返回。
2、格式:遵循rfc3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE
。yyyy-MM-DD
表示年月日;T
字符用于分隔日期和时间部分;HH:mm:ss
表示具体的时分秒;TIMEZONE
表示时区(例如,+08:00
对应东八区时间,即北京时间)。
示例:2015-05-20T13:29:35+08:00
表示北京时间2015年5月20日13点29分35秒。
user_received_account 必填 string(64)
【退款入账账户】 取当前退款单的退款入账方,有以下几种情况:
1)退回银行卡:{银行名称}{卡类型}{卡尾号}
2)退回支付用户零钱:支付用户零钱
3)退还商户:商户基本账户商户结算银行账户
4)退回支付用户零钱通:支付用户零钱通
5)退回支付用户银行电子账户:支付用户银行电子账户
6)退回支付用户零花钱:支付用户零花钱
7)退回用户经营账户:用户经营账户
8)退回支付用户来华零钱包:支付用户来华零钱包
9)退回企业支付商户:企业支付商户
amount 必填 object
【退款金额】订单退款金额信息
属性 | |
对resource对象进行解密后,得到的资源对象示例