签约、解约结果通知

更新时间：2025.02.19

1、签约、解约（包含用户主动解约）成功后，微信会把相关签约、解约信息异步通知给商户。
2、商户需要在接收处理该消息后返回应答。

注意：

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

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

特别提醒：商户系统对于结果通知的内容一定要做签名验证，并校验返回的商户协议号和用户openid信息是否一致，防止数据泄露导致出现“假通知”，造成业务或者资金受损。

接口说明

支持商户：【平台商户】

请求URL：签约结果通知路径为【APP方式预签约】接口商户上传的notify_url字段，解约结果通知路径为商户配置委托扣款模板时填写的解约回调地址，均必须为https协议。如果链接无法访问，商户将无法接收到微信通知。通知url必须为直接可访问的url，不能携带参数。示例： “http://pay.weixin.qq.com/wxpay/pay.action”

通知规则

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

对后台通知交互时，如果微信收到商户的应答不符合规范或超时，微信认为通知失败，微信会通过一定的策略定期重新发起通知，尽可能提高通知的成功率，但微信不保证通知最终能成功。（通知频率为：0/10/10/10/30/30/30/300/300/300/300/300/300/300/300/300/300/300/300/300/300/300/300/300/300/300/300/300/300/300（单位：秒））

通知报文

签约、解约结果通知是以POST 方法访问商户设置的通知url，通知的数据以JSON 格式通过请求主体（BODY）传输。通知的数据包括了加密的支付结果详情。

下面详细描述对通知数据进行解密的流程：

用商户平台上设置的APIv3密钥【微信商户平台—>账户设置—>API安全—>设置APIv3密钥】，记为key。
针对resource.algorithm中描述的算法（目前为AEAD_AES_256_GCM），取得对应的参数nonce和associated_data。
使用key、nonce和associated_data，对数据密文resource.ciphertext进行解密，得到JSON形式的资源对象。

注意：

AEAD_AES_256_GCM算法的接口细节，请参考rfc5116。微信支付使用的密钥key长度为32个字节，随机串nonce长度12个字节，associated_data长度小于16个字节并可能为空。

验证签名

微信支付会对发送给商户的通知进行签名，并将签名值放在通知的HTTP头Wechatpay-Signature。商户应当验证签名，以确认请求来自微信，而不是其他的第三方。签名验证的算法请参考《微信支付API v3签名验证》。

回调通知的请求主体中会包含JSON格式的通知参数，具体的通知参数列表如下：

通知参数

BODY 包体参数

id 必填 string(32)

通知的唯一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)

通知的类型：
ECOMMERCE_ENTRUST.SIGN：签约
ECOMMERCE_ENTRUST.TERMINATE：解约

resource_type 必填 string(32)

通知的资源数据类型，签约/解约成功通知为encrypt-resource

resource 必填 object

通知资源数据。

属性

algorithm 必填 string(32)

对开启结果数据进行加密的加密算法，目前只支持AEAD_AES_256_GCM。

ciphertext 必填 string(1,1048576)

Base64编码后的开启/停用结果数据密文。

associated_data 选填 string(16)

附加数据。

nonce 必填 string(16)

加密使用的随机串。

微信发送给商户的签约成功结果通知

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

微信发送给商户的解约结果通知

1{
2    "id":"EV-2018022511223320873",
3    "create_time":"2020-06-08T10:34:56+08:00",
4    "resource_type":"encrypt-resource",
5    "event_type":"ECOMMERCE_ENTRUST.TERMINATE",
6    "resource" : {
7        "algorithm":"AEAD_AES_256_GCM",
8        "ciphertext": "...",
9        "nonce": "...",
10        "associated_data": ""
11    }
12}

签约/解约通知参数

body 包体参数

mchid 必填 string(32)

微信支付分配的商户号

out_contract_code 必填 string(32)

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

plan_id 必填 int

委托代扣协议模板Id

contract_id 必填 string(32)

签约成功后，微信返回的委托代扣协议id。

appid 必填 string(32)

appid是电商服务商在微信公众平台或开发平台申请的移动应用成功后分配的账号ID

openid 必填 string(64)

商户appid下的用户唯一标识

contract_termination_mode 选填 string(32)

协议解约方式
USER_TERMINATE：用户主动解约
MCH_API_TERMINATE：商户API解约
WEPAY_WEB_TERMINATE：商户平台解约
CUSTOM_SERVICE_TERMINATE：客服解约
SYSTEM_TERMINATE：系统解约
解约回调通知时返回该字段

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年05月20日13点29分35秒
签约回调通知时返回该字段

operate_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秒

对resource对象进行解密后，得到的资源对象示例（签约结果通知）

1{
2  "mchid": "1230000109",
3  "out_contract_code": "wxwtdk20200910100000",
4  "plan_id": 12535,
5  "appid": "wxd678efh567hg6787",
6  "openid" : "o-MYE42l80oelYMDE34nYD456Xoy",
7  "contract_expired_time":"2021-05-20T13:29:35.120+08:00",
8  "operate_time":"2020-05-20T13:29:35.120+08:00"
9}

对resource对象进行解密后，得到的资源对象示例（解约结果通知）

1{
2  "mchid": "1230000109",
3  "out_contract_code": "wxwtdk20200910100000",
4  "plan_id": 12535,
5  "appid": "wxd678efh567hg6787",
6  "openid" : "o-MYE42l80oelYMDE34nYD456Xoy",
7  "contract_termination_mode": "MCH_API_TERMINATE",
8  "operate_time":"2020-05-20T13:29:35.120+08:00"
9}

通知应答

接收成功： HTTP应答状态码需返回200或204，无需返回应答报文。

接收失败： HTTP应答状态码需返回5XX或4XX，同时需返回应答报文，格式如下：

code 必填 string(32)

【返回状态码】
错误码，SUCCESS为清算机构接收成功，其他错误码为失败。

message 必填 string(64)

【返回信息】
返回信息，如非空，为错误原因。

应答示例

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

文档是否有帮助

更多支持

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