商家转账回调通知
更新时间:2024.12.18微信支付系统通过商家转账回调通知接口通知商户系统单据处理到终态。
|
一、回调描述
商家转账单据到终态后(转账完成或者转账失败,对应单据状态status的值为SUCCESS、CANCELLED和FAIL),微信支付会把单据的信息发送给商户,商户需要接收处理该消息,并返回应答。
回调地址设置方式: 该链接是通过商家转账的请求参数“notify_url”来设置的,要求必须为HTTPS地址。请确保回调URL是外部可正常访问的,且不能携带后缀参数,否则可能导致商户无法接收到微信的回调通知信息。回调URL示例:https://pay.weixin.qq.com/wxpay/pay.action
二、回调处理步骤
1、商户接收回调通知报文
微信支付会通过POST的方式向回调地址发送回调报文,回调报文的HTTP请求头中会包含报文的签名信息,用于后续验签,具体如下:
参数 | 描述 |
---|---|
Wechatpay-Serial | 验签的“微信支付平台证书”所对应的平台证书序列号 |
Wechatpay-Signature | 验签的签名值 |
Wechatpay-Timestamp | 验签的时间戳 |
Wechatpay-Nonce | 验签的随机字符串 |
回调通知的请求主体中会包含JSON格式的通知参数,具体的通知参数列表如下:
通知参数
Body 包体参数
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)
【通知类型】通知的资源数据类型,商家转账通知为encrypt-resource
resource
必填 object
【通知数据】json格式
属性 | |
summary
必填 string(64)
【回调摘要】回调摘要
通知应答
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)
【返回状态码】错误码,SUCCESS为接收成功,其他错误码为失败
message
必填 string(64)
【返回信息】返回信息,如非空,为错误原因
应答示例
对后台通知交互时,如果微信收到商户的应答不符合规范或超时,微信认为通知失败,微信会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但微信不保证通知最终能成功。(通知频率为0s/15s(尝试10次)/300s(尝试10次)/1800s(尝试44次))
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 包体参数
out_bill_no
必填 string(32)
【商户单号】商户系统内部的商家单号,在商户系统内部唯一
transfer_bill_no
必填 string(64)
【商家转账订单号】微信单号,微信商家转账系统返回的唯一标识
state
必填 string(32)
【单据状态】微信单号,微信商家转账系统返回的唯一标识
ACCEPTED:单据已受理
PROCESSING:单据处理中,转账结果尚未明确,如一直处于此状态,建议检查账户余额是否足够
WAIT_USER_CONFIRM:待收款用户确认,可拉起微信收款确认页面进行收款确认
TRANSFERING:转账中,转账结果尚未明确,可拉起微信收款确认页面再次重试确认收款
SUCCESS: 转账成功
FAIL: 转账失败
CANCELING: 撤销中
CANCELLED: 已撤销
mch_id
必填 string(32)
【商户号】微信支付分配的商户号
transfer_amount
必填 integer
【转账金额】转账总金额,单位为“分”
openid
必填 string(64)
【收款用户OpenID】商户AppID下,某用户的OpenID
fail_reason
选填 string(256)
【失败原因】订单已失败或者已退资金时,返回失败原因
create_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秒。
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秒。
解密后单据信息