签约成功回调通知
更新时间:2024.05.13注意
- 同样的通知可能会多次发送给商户系统。商户系统必须能够正确处理重复的通知。 推荐的做法是,当商户系统收到通知进行处理时,先检查对应业务数据的状态,并判断该通知是否已经处理。如果未处理,则再进行处理;如果已处理,则直接返回结果成功。在对业务数据进行状态检查和处理之前,要采用数据锁进行并发控制,以避免函数重入造成的数据混乱。
特别提醒:商户系统对于开启结果通知的内容一定要做签名验证,并校验通知的信息是否与商户侧的信息一致,防止数据泄露导致出现假通知,造成资金损失。
# 接口说明
支持商户: 【普通商户】
请求URL: 该链接是通过【创建用户的签约计划API】提交notify_url参数设置,必须为HTTPS协议。如果链接无法访问,商户将无法接收到微信通知。 通知URL必须为直接可访问的URL,不能携带参数。示例:https://pay.weixin.qq.com/wxpay/pay.action
# 通知规则
商户创建签约计划后,拉起支付分签约页,用户会在该页面完成计划签约,完成计划签约后微信会把相关计划签约成功信息发送给商户,商户需要接收处理,并按照文档规范返回应答。出于安全的考虑,我们对支付结果数据进行了加密,商户需要先对通知数据进行解密,才能得到支付结果数据。
对后台通知交互时,如果微信收到应答不是成功或超时,微信认为通知失败,微信会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但微信不保证通知最终能成功。(通知频率为60s/次 - 总计11次 )
# 通知报文
签约结果通知是以POST 方法访问商户设置的通知URL,通知的数据以JSON 格式通过请求主体(BODY)传输。通知的数据包括了加密的支付结果详情。
注意
由于涉及到回调加密和解密,商户必须先设置好APIv3密钥后才能进行回调通知解密,APIv3密钥设置文档指引详见APIv3密钥设置指引 (opens new window)
# 步骤说明
# 步骤一:验证签名
微信支付会对发送给商户的通知进行签名,并将签名值放在通知的HTTP头Wechatpay-Signature。商户应当验证签名,以确认请求来自微信,而不是其他的第三方。签名验证的算法请参考 《微信支付API v3签名验证》。
# 步骤二:参数解密
为了保证安全性,微信支付在回调通知,对关键信息进行了AES-256-GCM加密。商户应当按照以下的流程进行解密关键信息,解密的流程:
- 用商户平台上设置的APIv3密钥【微信商户平台 (opens new window)—>账户设置—>API安全—>设置APIv3密钥】,记为key;
- 获取resource.algorithm中描述的算法(目前为AEAD_AES_256_GCM),以及resource.nonce和resource.associated_data;
- 使用key、nonce和associated_data,对数据密文resource.ciphertext进行解密,得到JSON形式的资源对象。
注意
- AEAD_AES_256_GCM算法的接口细节,请参考rfc5116 (opens new window)。微信支付使用的密钥key长度为32个字节,随机串nonce长度12个字节,associated_data长度小于16个字节并可能为空。
- Java回调解密Json取值不带引号。
# 通知签名
加密不能保证通知请求来自微信。微信会对发送给商户的通知进行签名,并将签名值放在通知的HTTP头Wechatpay-Signature。商户应当验证签名,以确认请求来自微信,而不是其他的第三方。签名验证的算法请参考《微信支付API v3签名验证》。
# 字段说明
# 通知参数
- id 必填通知的唯一ID。
- create_time 必填通知创建的时间,遵循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 必填支付分签约回调通知类型,枚举值: PAYSCORE.USER_SIGN_PLAN:签约成功
- resource_type 必填通知的资源数据类型,支付分签约的回调通知为encrypt-resource。
- summary 必填回调摘要
- resource 必填通知资源数据。 json格式,见示例
- 属性
# 签约成功通知参数
- sign_plan_id 必填签约计划的主键,唯一定义此资源的标识
- openid 选填签约计划用户服务商应用下的OpenID
- service_id 必填计划所属服务
- mchid 必填服务商商户号
- appid 必填服务商AppID
- merchant_sign_plan_no 必填商户系统内部签约计划单号,只能是数字、大小写字母_-* 且在同一个商户号下唯一
- merchant_callback_url 必填签约成功事件通知回调地址,用于接收用户签约计划成功后的通知
- plan_id 必填签约所属计划ID
- going_detail_no 必填序号从1开始,顺序按照创建计划时传入的计划详情顺序,0代表无任何详情开始使用
- sign_state 必填计划签约状态,枚举值: UNSIGNED
- cancel_sign_time 选填取消计划时间,使用 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 选填签约计划取消类型,枚举值NOT_CANCEL:未取消USER:用户取消已签约的协议MERCHANT:商户取消已签约的协议REVOKE_SERVICE:用户解除服务授权时取消服务下的已签约协议
- cancel_reason 选填签约计划取消原因
- plan_name 必填签约计划的名称
- plan_over_time 必填签约计划过期时间,使用 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 必填签约计划原总金额(单位分)
- deduction_quantity 必填签约计划扣费次数
- total_actual_price 必填签约计划实际总金额(单位分)
- signed_detail_list 必填签约计划明细列表
- 数组
- sign_time 选填签约时间,使用 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毫秒。
# 通知应答
接收成功: HTTP应答状态码需返回200或204,无需返回应答报文。
接收失败: HTTP应答状态码需返回5XX或4XX,同时需返回应答报文,格式如下:
- code 必填错误码,SUCCESS为接收成功,其他错误码为失败。
- message 必填返回信息,如非空,为错误原因。
# 签约计划成功通知
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}
# 商户对resource对象进行解密后,得到的资源对象示例
1{2 "sign_plan_id": "01020033210023606914000000007830",3 "openid": "oBgbt4sGN3Vl76KF7QgLF37UdjDU",4 "service_id": "00109000000000169034377913212082",5 "mchid": "2480262201",6 "appid": "wxa620f17681c6b0c7",7 "merchant_sign_plan_no": "1693882928726",8 "merchant_callback_url": "https://payapp.weixin.qq.com/wxvaluetest/common/indirect_bank/2492014071/listennotify",9 "plan_id": "01000033210032606914000000007983",10 "going_detail_no": 0,11 "sign_state": "SIGNED",12 "cancel_sign_time": "",13 "cancel_sign_type": "NOT_CANCEL",14 "cancel_reason": "",15 "plan_name": "瑜伽课5节",16 "plan_over_time": "2024-07-02T00:00:00+08:00",17 "total_origin_price": 1000,18 "deduction_quantity": 5,19 "total_actual_price": 500,20 "signed_detail_list": [21 {22 "plan_detail_no": 1,23 "original_price": 200,24 "plan_discount_description": "享受五折",25 "actual_price": 100,26 "plan_detail_state": "NOT_USED",27 "order_id": "",28 "merchant_plan_detail_no": "1693882928727",29 "plan_detail_name": "服务费1",30 "actual_pay_price": 0,31 "use_time": "",32 "complete_time": "",33 "cancel_time": ""34 },35 {36 "plan_detail_no": 2,37 "original_price": 200,38 "plan_discount_description": "享受五折",39 "actual_price": 100,40 "plan_detail_state": "NOT_USED",41 "order_id": "",42 "merchant_plan_detail_no": "1693882928728",43 "plan_detail_name": "服务费2",44 "actual_pay_price": 0,45 "use_time": "",46 "complete_time": "",47 "cancel_time": ""48 },49 {50 "plan_detail_no": 3,51 "original_price": 200,52 "plan_discount_description": "享受五折",53 "actual_price": 100,54 "plan_detail_state": "NOT_USED",55 "order_id": "",56 "merchant_plan_detail_no": "1693882928729",57 "plan_detail_name": "服务费3",58 "actual_pay_price": 0,59 "use_time": "",60 "complete_time": "",61 "cancel_time": ""62 },63 {64 "plan_detail_no": 4,65 "original_price": 200,66 "plan_discount_description": "享受五折",67 "actual_price": 100,68 "plan_detail_state": "NOT_USED",69 "order_id": "",70 "merchant_plan_detail_no": "1693882928730",71 "plan_detail_name": "服务费4",72 "actual_pay_price": 0,73 "use_time": "",74 "complete_time": "",75 "cancel_time": ""76 },77 {78 "plan_detail_no": 5,79 "original_price": 200,80 "plan_discount_description": "享受五折",81 "actual_price": 100,82 "plan_detail_state": "NOT_USED",83 "order_id": "",84 "merchant_plan_detail_no": "1693882928731",85 "plan_detail_name": "服务费5",86 "actual_pay_price": 0,87 "use_time": "",88 "complete_time": "",89 "cancel_time": ""90 }91 ],92 "sign_time": "2023-09-05T11:03:56+08:00"93}
# 应答示例
1{ 2 "code": "FAIL",3 "message": "失败"4}