签约成功回调通知

更新时间：2025.02.19

一、回调描述

用户在取消签约或者取消服务授权导致服务下签约计划取消后，微信会把相关计划取消签约信息发送给商户，商户需要接收处理，并按照文档规范返回应答。

回调地址设置方式：回调地址通过【创建用户的签约计划】接口中的“notify_url”参数设置，回调地址的设置规范和回调IP列表请参考文档：回调通知注意事项。

注意

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

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

二、回调处理步骤

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.

resource_type 　必填　string(32)

通知的资源数据类型，支付分签约的回调通知为encrypt-resource。

summary 　必填　string(64)

回调摘要

resource 　必填　object

通知资源数据。 json格式，见示例

属性

签约计划成功通知

1{ 
2    "id":"8b33f79f-8869-5ae5-b41b-3c0b59f957d0",
3    "create_time":"2022-10-12T16:54:38+08:00",
4    "resource_type":"encrypt-resource",
5    "event_type":"PAYSCORE.USER_SIGN_PLAN",
6    "summary":"用户签约计划成功",
7    "resource":{
8        "original_type":"payscore",
9        "algorithm":"AEAD_AES_256_GCM",
10        "ciphertext":"xxx",
11        "associated_data":"payscore",
12        "nonce":"j9g1wAzF9Xn1"
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)未应答时，微信支付会按照（60s/次 - 总计11次）的频次重复发送回调通知，直至微信支付接收到商户应答成功，或达到最大发送次数（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

sub_openid 　选填　string(128)

签约计划用户子商户应用下的OpenID

service_id 　必填　string(32)

计划所属服务

mchid 　必填　string(32)

服务商商户号

sub_mchid 　必填　string(32)

子商户商户号

appid 　必填　string(32)

服务商AppID

sub_appid 　选填　string(32)

子商户AppID

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

签约计划明细列表

数组

success_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毫秒。

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

1{
2    "sign_plan_id": "01020033210023606914000000007830",
3    "openid": "oBgbt4sGN3Vl76KF7QgLF37UdjDU",
4    "service_id": "00109000000000169034377913212082",
5    "mchid": "2480262201",
6    "sub_mchid": "2480262211",
7    "appid": "wxa620f17681c6b0c7",
8    "sub_appid": "",
9    "merchant_sign_plan_no": "1693882928726",
10    "merchant_callback_url": "https://payapp.weixin.qq.com/wxvaluetest/common/indirect_bank/2492014071/listennotify",
11    "plan_id": "01000033210032606914000000007983",
12    "going_detail_no": 0,
13    "sign_state": "SIGNED",
14    "cancel_sign_time": "",
15    "cancel_sign_type": "NOT_CANCEL",
16    "cancel_reason": "",
17    "plan_name": "瑜伽课5节",
18    "plan_over_time": "2024-07-02T00:00:00+08:00",
19    "total_origin_price": 1000,
20    "deduction_quantity": 5,
21    "total_actual_price": 500,
22    "signed_detail_list": [
23        {
24            "plan_detail_no": 1,
25            "original_price": 200,
26            "plan_discount_description": "享受五折",
27            "actual_price": 100,
28            "plan_detail_state": "NOT_USED",
29            "order_id": "",
30            "merchant_plan_detail_no": "1693882928727",
31            "plan_detail_name": "服务费1",
32            "actual_pay_price": 0,
33            "use_time": "",
34            "complete_time": "",
35            "cancel_time": ""
36        },
37        {
38            "plan_detail_no": 2,
39            "original_price": 200,
40            "plan_discount_description": "享受五折",
41            "actual_price": 100,
42            "plan_detail_state": "NOT_USED",
43            "order_id": "",
44            "merchant_plan_detail_no": "1693882928728",
45            "plan_detail_name": "服务费2",
46            "actual_pay_price": 0,
47            "use_time": "",
48            "complete_time": "",
49            "cancel_time": ""
50        },
51        {
52            "plan_detail_no": 3,
53            "original_price": 200,
54            "plan_discount_description": "享受五折",
55            "actual_price": 100,
56            "plan_detail_state": "NOT_USED",
57            "order_id": "",
58            "merchant_plan_detail_no": "1693882928729",
59            "plan_detail_name": "服务费3",
60            "actual_pay_price": 0,
61            "use_time": "",
62            "complete_time": "",
63            "cancel_time": ""
64        },
65        {
66            "plan_detail_no": 4,
67            "original_price": 200,
68            "plan_discount_description": "享受五折",
69            "actual_price": 100,
70            "plan_detail_state": "NOT_USED",
71            "order_id": "",
72            "merchant_plan_detail_no": "1693882928730",
73            "plan_detail_name": "服务费4",
74            "actual_pay_price": 0,
75            "use_time": "",
76            "complete_time": "",
77            "cancel_time": ""
78        },
79        {
80            "plan_detail_no": 5,
81            "original_price": 200,
82            "plan_discount_description": "享受五折",
83            "actual_price": 100,
84            "plan_detail_state": "NOT_USED",
85            "order_id": "",
86            "merchant_plan_detail_no": "1693882928731",
87            "plan_detail_name": "服务费5",
88            "actual_pay_price": 0,
89            "use_time": "",
90            "complete_time": "",
91            "cancel_time": ""
92        }
93    ],
94    "sign_time": "2023-09-05T11:03:56+08:00"
95}

文档是否有帮助

更多支持

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