代扣解约问询

更新时间:2024.12.16

一、回调描述

当用户解约时,委托代扣会通过该接口访问鸿蒙,这个协议是否可以解约。

回调地址的设置规范和回调IP列表请参考文档:回调通知注意事项

二、回调处理步骤

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)

【通知类型】固定的字符串,ENTRUST.TERMINATE_INQUIRY


resource_type 必填 string(32)

【通知数据类型】通知的资源数据类型,固定为encrypt-resource。


resource 必填 object

【通知资源数据】
json格式,见示例

属性

summary 必填 string(64)

【回调摘要】微信支付对回调内容的摘要备注。

解约问询

1{
2    "id":"EV-2018022511223320873",
3    "create_time":"2015-05-20T13:29:35+08:00",
4    "resource_type":"encrypt-resource",
5    "event_type":"ENTRUST.TERMINATE_INQUIRY",
6    "resource" : {
7        "algorithm":"AEAD_AES_256_GCM",
8        "ciphertext": "...",
9        "nonce": "...",
10        "associated_data": ""
11    },
12  "summary": "支付成功"
13}

2、回调验签与应答

商户接收到回调通知报文后,需在5秒内完成对报文的验签,并应答回调通知。

2.1、对回调通知进行验签

验签需使用请求头中的【Wechatpay-Timestamp】、【Wechatpay-Nonce】以及请求主体中JSON格式的通知参数构建出验签串,然后使用【Wechatpay-Serial】对应的微信支付平台证书/微信支付公钥对验签串和【Wechatpay-Signature】进行验签,确保接收的回调内容是来自微信支付。

详细验签步骤请参考:如何验证签名

微信支付会在极少数通知回调中返回以“WECHATPAY/SIGNTEST/”开头的错误【Wechatpay-Signature】,以检测商户系统是否正确验证签名。商户请参考:如何应对签名探测流量进行处理。

2.2、对回调通知进行应答

商户验签后,根据验签结果对回调进行应答:

验签通过商户需告知微信支付接收回调成功,HTTP应答状态码需返回200,同时返回以下应答报文以确认该协议可以解约。

Body 包体参数

code 必填 string(32)

【返回状态码】
返回码,SUCCESS为回调接收成功。


message 必填 string(256)

【返回信息】
返回信息,回调接收失败原因。


mchid 必填 string(32)

【商户号】

商户平台分配的商户号


appid 必填 string(32)

【商户AppId】

AppID是商户在微信申请公众号或移动应用成功后分配的账号ID,登录平台为mp.weixin.qq.com或open.weixin.qq.com


openid 必填 string(128)

【用户OpenId】

商户AppId下的用户唯一标识


plan_id 必填 Integer

【委托代扣模版ID】

该协议所属的模版


out_contract_code 必填 string(32)

【商户签约协议号】

商户侧的签约协议号,商户侧需要保证唯一性。


out_user_code 必填 string(64)

【商户侧用户标识】

一个用户微信账号可能会在商户系统中存在多个账号,并开通多个签约协议。商户可以使用商户侧用户标识区分商户系统中的不同用户账号。

应答示例

1{  
2    "code": "SUCCESS",
3    "message": "",
4  	"mchid": "1900000109",
5  	"appid": "wxd678efh567hg6787",
6  	"openid": "o-MYE42l80oelYMDE34nYD456Xoy",
7  	"plan_id": 123345,
8  	"out_contract_code": "wxwtdk20200910100000",
9  	"out_user_code": "wxwtdk20200910100000"
10}

 

验签不通过或者认为不可以解约商户需告知微信支付接收回调失败,HTTP应答状态码需返回5XX或4XX,同时返回以下应答报文:

Body 包体参数

code 必填 string(32)

【返回状态码】
返回码,FAIL为回调接收失败。


message 必填 string(256)

【返回信息】
返回信息,回调接收失败原因。

 

应答示例

1{  
2    "code": "FAIL",
3    "message": "失败原因"
4}

微信支付接收到商户的应答是成功,则会继续解约;如果收到商户的应答是失败,则不会解约,同时会告知用户咨询华为客服具体无法解决的原因。

3、对回调通知内容进行解密

为了保证业务信息的安全性,微信支付将业务信息进行了AES-256-GCM加密,并通过参数resource将加密信息回调给商户,商户需要进行解密后才能获取到业务信息。

解密步骤如下:

  1. 获取商户平台上设置的APIv3密钥,记为key;

  2. 通过回调通知参数resource.algorithm确认加密算法(目前仅支持AEAD_AES_256_GCM,算法的接口细节,请参考:rfc5116)。

  3. 使用key与回调通知参数resource.nonce和resource.associated_data,对数据密文resource.ciphertext进行解密,最终可得到JSON格式的业务信息。

解密示例代码可参考文档:如何解密回调报文

注意

  • 使用Java进行回调解密,取JSON串内的参数值时,只需取引号内的内容进行解密。例:"nonce":"123",只需取值123,不用取加上引号的"123"。

resource解密后字段

Body 包体参数

mchid 必填 string(32)

【商户号】调用支付分创单接口提交的商户号,商户号需开通支付分产品权限,且与appid有绑定关系,详见直连商户与AppID账号关联管理


appid 必填 string(32)

【公众账号ID】是微信开放平台和微信公众平台为开发者的应用程序(APP、小程序、公众号)提供的一个唯一标识。 开发者需要先在微信开放平台或微信公众平台中申请ID,然后在商户平台中绑定,详见直连商户与AppID账号关联管理。完结订单和取消订单需要和创单传入的appid保持一致。


openid 必填 string(128)

【用户标识】用户在商户对应appid下的唯一标识。


plan_id 必填 Integer

【委托代扣模版ID】

该协议所属的模版


out_contract_code 必填 string(32)

【商户签约协议号】

商户侧的签约协议号,商户侧需要保证唯一性。


 

contract_id 必填 string(32)

【委托代扣协议ID】

微信支付内部分配的委托代扣协议的唯一标识


contract_display_account 必填 string(32)

【用户账户展示名称】

签约用户的名称,用于页面展示,参数值不支持UTF8非3字节编码的字符,例如表情符号,所以请勿传微信昵称到该字段


out_user_code 必填 string(64)

【商户侧用户标识】

一个用户微信账号可能会在商户系统中存在多个账号,并开通多个签约协议。商户可以使用商户侧用户标识区分商户系统中的不同用户账号。


contract_state 必填 string(32)

【委托代扣协议状态】

字符串枚举

SIGNED : 签约生效中

TERMINATED : 生效的签约协议已被解约。此时协议已经到达终态,该协议无法再次进行签约;可更换协议号再发起签约。


contract_signed_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秒示例值:2020-09-10T13:29:35+08:00

 

商户对resource对象进行解密后,得到的资源对象示例

1{
2  	"mchid": "1230000109", 
3    "appid": "wxd678efh567hg6787", 
4    "openid": "o-MYE42l80oelYMDE34nYD456Xoy",
5	"plan_id": 123456,
6  	"out_contract_code": "wxwtdk20200910100000",
7  	"contract_id": "123124412412423431",
8  	"contract_display_account": "商户用户A",
9  	"out_user_code": "wxwtdk20200910100000",
10  	"contract_state": "SIGNED",
11  	"contract_signed_time": "2020-09-10T13:29:35+08:00"
12}