普通服务商委托代扣签解约通知API

更新时间：2025.02.18

微信支付通过签解约通知接口将协议签解约结果通知给商户。

注意

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

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

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

接口说明

支持商户：【普通服务商】

请求方式：【POST】

回调URL：该链接是通过委托代扣受理扣款接口中的请求参数“transaction_notify_url”来设置的，要求必须为HTTPS地址。请确保回调URL是外部可正常访问的，且不能携带后缀参数，否则可能导致商户无法接收到微信的回调通知信息。回调URL示例："https://pay.weixin.qq.com/wxpay/pay.action"

通知规则

用户支付完成后，微信会把相关支付结果和用户信息发送给商户，商户需要接收处理该消息，并返回应答。

对后台通知交互时，如果微信收到商户的应答不符合规范或超时，微信认为通知失败，微信会通过一定的策略定期重新发起通知，尽可能提高通知的成功率，但微信不保证通知最终能成功。（通知频率为15s/15s/30s/3m/10m/20m/30m/30m/30m/60m/3h/3h/3h/6h/6h - 总计 24h4m）

通知报文

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

注意

由于涉及到回调加密和解密，商户必须先设置好APIv3密钥后才能解密回调通知，APIv3密钥设置文档指引详见APIv3密钥设置指引

参数解密

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

用商户平台上设置的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个字节并可能为空。
Java回调解密Json取值不带引号

字段说明

通知参数

BODY 包体参数

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

通知资源数据。

属性

algorithm 必填 string(32)

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

ciphertext 必填 string(1,1048576)

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

associated_data 选填 string(16)

附加数据。

nonce 必填 string(16)

加密使用的随机串。

original_type 必填 string(16)

原始回调类型，为entrust

签约成功通知结果

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}

通知签名

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

签约、解约通知参数

BODY 包体参数

contract_id 必填 string(32)

委托代扣协议的主键，唯一定义此资源的标识

sp_mchid 必填 string(32)

普通服务商商户号，微信支付分配的商户号

sp_appid 必填 string(32)

服务商申请的公众号或移动应用AppID。

sub_mchid 必填 string(32)

子商户号，微信支付分配的商户号

sub_appid 必填 string(32)

子商户的AppID，商户在微信申请的公众号或移动应用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

sp_openid 必填 string(64)

商户AppID下的用户唯一标识

sub_openid 必填 string(64)

子商户AppID对应的用户OpenID，商户AppID下的用户唯一标识

contract_terminate_info 选填 object

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

属性

contract_termination_mode 必填 string

协议解约方式，枚举值：
USER_TERMINATE: 用户发起的解约
MCH_API_TERMINATE: 商户通过API发起的解约
WEPAY_WEB_TERMINATE: 商户在商户平台发起的解约
CUSTOMER_SERVICE_TERMINATE: 用户联系微信支付客服发起的解约
SYSTEM_TERMINATE: 微信支付系统主动发起的解约

contract_terminated_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-10-10T13:29:35+08:00

contract_termination_remark 选填 string(256)

解约原因的备注说明，如：签约信息有误，须重新签约。

deduct_schedule 选填 object

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

属性

estimated_deduct_date 必填 string(32)

预约扣费场景下有效，预签约时指定的预计扣费的日期，遵循rfc3339标准格式，格式为yyyy-MM-DD，yyyy-MM-DD表示年月日，例如：2015-05-20表示，北京时间2015年5月20日

estimated_deduct_amount 必填 object

预约扣费场景下有效，预签约时指定的预计的扣费金额。

属性

amount 必填 int

总金额，单位为分，只能为整数。

currency 选填 string

枚举类型，符合ISO 4217标准的三位字母代码，默认为CNY，目前只支持CNY

schedule_state 必填 string

扣费预约状态。枚举值：
NO_SCHEDULED：未进行预约。
SCHEDULED：已预约成功，未发起扣费或已发起扣费但扣费失败。
PAID：已发起扣费且扣费成功。
EXPIRED：超过预计扣费时间且没有扣费成功。此时商户无法再进行预约或扣费。

scheduled_amount 选填 object

已预约的扣费金额信息，当状态为已预约或已扣费时有返回。

属性

amount 必填 int

总金额，单位为分，只能为整数。

currency 选填 string

枚举类型，符合ISO 4217标准的三位字母代码，默认为CNY，目前只支持CNY

deduct_amount 选填 object

实际扣费金额，当状态为已扣费时有返回。

属性

amount 必填 int

总金额，单位为分，只能为整数。

currency 选填 string

枚举类型，符合ISO 4217标准的三位字母代码，默认为CNY，目前只支持CNY

deduct_date 选填 string(32)

实际扣费的日期，遵循rfc3339标准格式，格式为yyyy-MM-DD，yyyy-MM-DD表示年月日，例如：2015-05-20表示，北京时间2015年5月20日

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

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

通知应答

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

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

code 必填 string(32)

错误码，SUCCESS为商户接收成功，其他错误码为失败。

message 必填 string(64)

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

应答示例

1{  
2    "code": "SUCCESS",
3    "message": "成功"
4}

文档是否有帮助

更多支持

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