取消签约回调通知
更新时间：2025.02.19一、回调描述
商户创建签约计划后，拉起支付分签约页，用户会在该页面完成计划签约，完成计划签约后微信会把相关计划签约成功信息发送给商户，商户需要接收处理，并按照文档规范返回应答。
回调地址设置方式： 回调地址通过【创建用户的签约计划API】接口中的“notify_url”参数设置，回调地址的设置规范和回调IP列表请参考文档：回调通知注意事项。
|
对后台通知交互时，如果微信收到应答不是成功或超时，微信认为通知失败，微信会通过一定的策略定期重新发起通知，尽可能提高通知的成功率，但微信不保证通知最终能成功。（通知频率为60s/次 - 总计11次 ）
二、回调处理步骤
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)
支付分签约回调通知类型，枚举值：
PAYSCORE.USER_CANCEL_SIGN_PLAN：取消签约
resource_type 必填 string(32)
通知的资源数据类型，支付分签约的回调通知为encrypt-resource。
summary 必填 string(64)
回调摘要
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)
【返回状态码】错误码，FAIL为回调接收失败。
message 选填 string(256)
【返回信息】返回信息，回调接收失败原因。
应答成功示例
200或204
应答失败示例
5XX或4XX
2.3、微信支付回调处理机制说明
微信支付接收到商户的应答后，会根据应答结果做对应的逻辑处理：
若商户应答回调接收成功，微信支付将不再重复发送该回调通知。若因网络或其他原因，商户收到了重复的回调通知，请按正常业务流程进行处理并应答。
若商户应答回调接收失败，或超时(5s)未应答时，微信支付会按照（60s/次）的频次重复发送回调通知，直至微信支付接收到商户应答成功，或达到最大发送次数（11次）
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解密后字段
sign_plan_id 必填 string(32)
签约计划的主键，唯一定义此资源的标识
openid 选填 string(128)
签约计划用户直连商户应用下的OpenID
service_id 必填 string(32)
计划所属服务
mchid 必填 string(32)
直连商户号
appid 必填 string(32)
与商户号绑定的公众号ID
merchant_sign_plan_no 必填 string(32)
商户系统内部签约计划单号，只能是数字、大小写字母_-* 且在同一个商户号下唯一
merchant_callback_url 必填 string(1024)
签约事件通知回调地址，用于接收用户签约计划成功后和主动取消签约计划的通知
plan_id 必填 string(32)
签约所属计划ID
going_detail_no 必填 int
序号从1开始，顺序按照创建计划时传入的计划详情顺序，0代表无任何详情开始使用
sign_state 必填 string
计划签约状态,枚举值:
UNSIGNED
cancel_sign_time 选填 string(32)
取消计划时间，使用 rfc3339 所定义的 date-time 格式，使用北京时间（+08:00），格式为yyyy-MM-DDTHH:mm:ss:sss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss:sss表示时分秒毫秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC8小时，即北京时间）。例如：2021-05-20T13:29:35:120+08:00表示，北京时间2021年5月20日 13点29分35秒120毫秒。
cancel_sign_type 选填 string
签约计划取消类型，枚举值
NOT_CANCEL：未取消
USER：用户取消已签约的协议
MERCHANT：商户取消已签约的协议
REVOKE_SERVICE：用户解除服务授权时取消服务下的已签约协议
cancel_reason 选填 string(128)
签约计划取消原因
plan_name 必填 string(20)
签约计划的名称
plan_over_time 必填 string(32)
签约计划过期时间，使用 rfc3339 所定义的 date-time 格式，使用北京时间（+08:00），格式为yyyy-MM-DDTHH:mm:ss:sss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss:sss表示时分秒毫秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC8小时，即北京时间）。例如：2021-05-20T13:29:35:120+08:00表示，北京时间2021年5月20日 13点29分35秒120毫秒。
total_origin_price 必填 int
签约计划原总金额(单位分)
deduction_quantity 必填 uint
签约计划扣费次数
total_actual_price 必填 int
签约计划实际总金额（单位分）
signed_detail_list 必填 array
签约计划明细列表
| 数组 |
商户对resource中ciphertext对象进行解密后，得到的资源对象示例
