获取解约挽留信息
更新时间:2024.08.19一、回调描述
当用户关闭协议时,协议所关联的模板在获取范围内,则主动的获取挽留信息。
回调地址设置方式: 回调地址通过商户配置委托扣款模版时填写的解约回调地址设置,回调地址的设置规范和回调IP列表请参考文档:回调通知注意事项。
|
二、回调处理步骤
1、商户接收回调通知报文
微信支付会通过POST的方式向回调地址发送回调报文,回调通知的请求主体中会包含JSON格式的通知参数,具体的通知参数列表如下:
通知参数
id 必填 string(36)
获取的唯一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年5月20日13点29分35秒。
event_type 必填 string(32)
获取类型,枚举值:
ENTRUST.TERMINATE_RETENTION:解约挽留信息
resource_type 必填 string(32)
获取的资源数据类型固定为encrypt-resource。
summary 必填 object
获取摘要
resource 必填 object
获取资源数据。 json格式,见示例
属性 | |
获取信息
2、回调验签与应答
商户接收到回调通知报文后,需在5秒内完成对报文的验签,并应答回调通知。
2.1、对回调通知进行验签
回调报文的HTTP请求头中会包含报文的签名信息,用于验签,具体如下:
参数 | 描述 |
---|---|
Wechatpay-Serial | |
Wechatpay-Signature | 验签的签名值 |
Wechatpay-Timestamp | 验签的时间戳 |
Wechatpay-Nonce | 验签的随机字符串 |
验签需使用请求头中的【Wechatpay-Timestamp】、【Wechatpay-Nonce】以及请求主体中JSON格式的通知参数构建出验签串,然后使用【Wechatpay-Serial】对应的微信支付平台证书/微信支付公钥对验签串和【Wechatpay-Signature】进行验签,确保接收的回调内容是来自微信支付。
商户可通过HTTP头"Wechatpay-Serial"中的证书序列号判断选择对应的证书验签,微信支付公钥的序列号固定采用"PUB_KEY_ID_数字串"格式(例如:PUB_KEY_ID_3000000001),若请求头中的序列号不符合该格式,则应使用平台证书进行验签。
详细验签步骤请参考:如何验证签名
微信支付会在极少数通知回调中返回以“WECHATPAY/SIGNTEST/”开头的错误【Wechatpay-Signature】,以检测商户系统是否正确验证签名。商户请参考:如何应对签名探测流量进行处理。
签名探测流量HTTP头中的Wechatpay-Signature示例:
2.2、对回调通知进行应答
商户验签后,根据验签结果对回调进行应答:
验签通过:商户需告知微信支付接收回调成功,HTTP应答状态码需返回200或204,无需返回应答报文。
验签不通过:商户需告知微信支付接收回调失败,HTTP应答状态码需返回5XX或4XX,同时需返回以下应答报文:
code 必填 string(32)
错误码,SUCCESS为接收成功,其他错误码为失败。
message 必填 string(64)
返回信息,如非空,为错误原因。
retention_type 必填 string(64)
挽留类型,枚举值:
COUPON:代金券
coupon_info 必填 object
代金券信息
属性 | |
应答示例
2.3、微信支付回调处理机制说明
微信支付接收到商户的应答后,会根据应答结果做对应的逻辑处理:
若商户应答回调接收成功,微信支付将不再重复发送该回调通知。若因网络或其他原因,商户收到了重复的回调通知,请按正常业务流程进行处理并应答。
3、对回调通知内容进行解密
为了保证业务信息的安全性,微信支付将业务信息进行了AES-256-GCM加密,并通过参数resource将加密信息回调给商户,商户需要进行解密后才能获取到业务信息。
解密步骤如下:
获取商户平台上设置的APIv3密钥,设置APIv3密钥可参考文档:APIv3密钥设置方法;
通过回调通知参数resource.algorithm确认加密算法(目前仅支持AEAD_AES_256_GCM,算法的接口细节,请参考:rfc5116)。
使用APIv3密钥与回调通知参数resource.nonce和resource.associated_data,对数据密文resource.ciphertext进行解密,最终可得到JSON格式的业务信息。
解密示例代码可参考文档:如何解密回调报文
注意
使用Java进行回调解密,取JSON串内的参数值时,只需取引号内的内容进行解密。例:"nonce":"123",只需取值123,不用取加上引号的"123"。
resource中ciphertext解密后字段
mchid 必填 string(32)
微信支付分配的商户号
contract_id 必填 string(32)
委托代扣协议的主键,唯一定义此资源的标识
appid 必填 string(32)
商户在微信申请的公众号或移动应用AppID
plan_id 必填 int
委托代扣协议模板ID
out_contract_code 必填 string(32)
商户侧的签约协议号,商户侧需保证唯一性。只能是数字、大小写字母的组合
openid 必填 string(64)
商户AppID下的用户唯一标识
商户对resource中ciphertext对象进行解密后,得到的资源对象示例