代扣签解约通知

更新时间：2025.02.19

一、回调描述

签约、解约成功后，微信会把相关签约信息或者解约信息发送给商户，商户需要接收处理该消息，并按照文档规范返回应答

回调地址设置方式：签约结果回调地址通过【APP预签约/H5预签约/JSAPI预签约/小程序预签约】接口中的“contract_notify_URL”参数设置，解约结果通知路径为商户配置委托扣款模版时填写的解约回调地址，回调地址的设置规范和回调IP列表请参考文档：回调通知注意事项。

注意

对后台通知交互时，如果微信收到应答不是成功或超时，微信认为通知失败，微信会通过一定的策略定期重新发起通知，尽可能提高通知的成功率，但微信不保证通知最终能成功。

同样的通知可能会多次发送给商户系统。商户系统必须能够正确处理重复的通知。推荐的做法是，当商户系统收到通知进行处理时，首先检查对应业务数据的状态，判断该通知是否已经处理过，如果没有处理过再进行处理，如果处理过直接返回结果成功。在对业务数据进行状态检查和处理之前，要采用数据锁进行并发控制，以避免函数重入造成的数据混乱。
如果在所有通知频率(4小时)后没有收到微信侧回调，商户应调用查询签约接口确认签约状态。

特别提醒：商户系统对于开启结果通知的内容一定要做签名验证，并校验通知的信息是否与商户侧的信息一致，防止数据泄露导致出现“假通知”，造成资金损失。

二、回调处理步骤

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年05月20日13点29分35秒。

event_type 必填 string(32)

通知的类型，签约成功通知的类型为ENTRUST.SIGN。解约成功通知的类型为ENTRUST.TERMINATE

resource_type 必填 string(32)

通知的资源数据类型，为encrypt-resource。

summary 必填 string(64)

回调摘要

resource 必填 object

通知资源数据。

属性

签约成功通知结果

1{
2    "id":"EV-2018022511223320873",
3    "create_time":"2020-06-08T10:34:56+08:00",
4    "resource_type":"encrypt-resource",
5    "event_type":"ENTRUST.SIGN",   
6    "summary": "委托代扣签约通知",
7    "resource" : {                      
8        "original_type":"entrust",
9        "algorithm":"AEAD_AES_256_GCM",
10        "ciphertext": "...",
11        "nonce": "...",
12        "associated_data": ""
13    }
14}

解约成功通知结果

1{
2    "id":"EV-2018022511223320873",
3    "create_time":"2020-06-08T10:34:56+08:00",
4    "resource_type":"encrypt-resource",
5    "event_type":"ENTRUST.TERMINATE",   
6    "summary": "委托代扣解约通知",
7    "resource" : {                      
8        "original_type":"entrust",
9        "algorithm":"AEAD_AES_256_GCM",
10        "ciphertext": "...",
11        "nonce": "...",
12        "associated_data": ""
13    }
14}

2、回调验签与应答

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

2.1、对回调通知进行验签

回调报文的HTTP请求头中会包含报文的签名信息，用于验签，具体如下：

参数	描述
Wechatpay-Serial	验签的微信支付平台证书序列号/微信支付公钥ID
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示例：

1WECHATPAY/SIGNTEST/c0k+ZP6cSbveFpn0U5Bhq1Evz0A0rmmhGyuFXGqAtrlspDr3wrmaeauXJT6YYD4OmnDi767TImhRdV9hdmU0T5ZVfkOB/zka3mYthkxJ9V6UMoI
24QLGogSG1mnYjZGa6zGy1+8WInqosp0+6eBJuul55xwf3oEIpNMxAl4NL0QHr5nLfB0b0PZQSU9rZneOtDjdNtDCGEtcwV6H1eTdLpFrw2wCtiWJDw6tQwR1IfGVtdE4FK
3JQvYmOT7udgR6XfLdvzwbJsifpxvuG9q23OQF1i4PndT7AP8ykhKUEZayTrYGWdobrljFh2nu9Ng7divjg==

2.2、对回调通知进行应答

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

验签通过：商户需告知微信支付接收回调成功，HTTP应答状态码需返回200或204，无需返回应答报文。

验签不通过：商户需告知微信支付接收回调失败，HTTP应答状态码需返回5XX或4XX，同时需返回以下应答报文：

code 选填 string(32)

【返回状态码】错误码，FAIL为回调接收失败。

message 选填 string(256)

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

应答成功示例

200或204

1"无应答包体"

应答失败示例

5XX或4XX

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

2.3、微信支付回调处理机制说明

微信支付接收到商户的应答后，会根据应答结果做对应的逻辑处理：

若商户应答回调接收成功，微信支付将不再重复发送该回调通知。若因网络或其他原因，商户收到了重复的回调通知，请按正常业务流程进行处理并应答。
若商户应答回调接收失败，或超时(5s)未应答时，微信支付会按照（0s/10s/10s/10s/30s/30s/30s/300s/300s/300s/300s/300s/300s/300s/300s/300s/300s/300s/300s/300s/300s/300s/300s/300s/300s/300s/300s/300s/300s/300s）的频次重复发送回调通知，直至微信支付接收到商户应答成功，或达到最大发送次数（30次）

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)

商户侧的签约协议号，商户侧需保证唯一性。只能是数字、大小写字母的组合

contract_display_account 必填 string(64)

签约用户的名称，用于页面展示，在签约时由商户传入。

contract_state 必填 string

委托代扣协议状态，枚举值：
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

contract_expired_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

openid 必填 string(64)

商户AppID下的用户唯一标识

contract_terminate_info 选填 object

协议解约信息，仅当contract_state=TERMINATED时，该值有效。

属性

deduct_schedule 选填 object

预约扣费场景的预约信息，仅当模板类型为预约扣费时，该值有效。

属性

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

1{
2  "appid": "wxd678efh567hg6787",
3  "contract_display_account": "微信代扣用户A",
4  "contract_expired_time": "2021-09-10T13:29:35+08:00",
5  "contract_id": "123124412412423431",
6  "contract_signed_time": "2020-09-10T13:29:35+08:00",
7  "contract_state": "SIGNED",
8  "deduct_schedule": {
9    "deduct_amount": {
10      "currency": "CNY",
11      "total": 1
12    },
13    "deduct_date": "2019-11-22",
14    "estimated_deduct_amount": {
15      "currency": "CNY",
16      "total": 1
17    },
18    "estimated_deduct_date": "2019-11-22",
19    "schedule_state": "PAID",
20    "scheduled_amount": {
21      "currency": "CNY",
22      "total": 1
23    }
24  },
25  "mchid": "1900000109",
26  "openid": "o-MYE42l80oelYMDE34nYD456Xoy",
27  "out_contract_code": "wxwtdk20200910100000",
28  "out_user_code": "用户A",
29  "plan_id": 12535
30}

文档是否有帮助

更多支持

开发文档(服务商)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服