Login expired. Please log in again.

Feedback

0/300

Feedback

Submitted successfully

ok

Feedback

Network exception, please try again later

ok

签约与解约结果回调API

最新更新时间:2021.08.20 版本说明

签约、解约成功后(不成功不通知),微信会把相关签约、解约信息异步通知给商户。

注意:

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

● 如果在所有通知频率(4小时)后没有收到微信侧回调,商户应调用查询订单接口确认订单状态。

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

1. 接口说明

适用对象: 直连模式 机构模式

请求URL:签约结果通知路径为签约接口商户上传的success_notify_url字段,解约结果通知路径为商户申请代扣权限与代扣模板ID时提供的解约回调地址。必须为https协议。如果链接无法访问,商户将无法接收到微信通知。通知url必须为直接可访问的url,不能携带参数。示例:success_notify_url:“http://pay.weixin.qq.com/wxpay/pay.action”

请求方式:POST


2. 通知规则

签约、解约成功后(不成功不通知),微信会把相关签约、解约信息异步通知给商户。 商户需要接收处理,并返回应答。出于安全的考虑,我们对通知结果数据进行了加密,商户需要先对通知数据进行解密,才能得到结果数据。

对后台通知交互时,如果微信收到商户的应答不是成功或超时,微信认为通知失败,微信会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但微信不保证通知最终能成功。(通知频率为15/15/30/180/1800/1800/1800/1800/3600,单位:秒)



3. 通知报文

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

下面详细描述证书解密的流程

1、从商户平台上获取商户的密钥,记为“key”。
2、针对resource.algorithm中描述的算法(目前为AEAD_AES_256_GCM),取得对应的参数nonce和associated_data。
3、使用key、nonce和associated_data,对数据密文resource.ciphertext进行解密,得到JSON形式的资源对象

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


4. 请求参数

参数名 变量 类型[长度限制] 必填 描述
通知ID id string[1,32] 通知的唯一ID
示例值:EV-2018022511223320873
通知创建时间 create_time string[1,64] 通知创建的时间,格式为rfc3339格式,如2018-06-08T10:34:56+08:00 代表北京时间2018年06月08日10时34分56秒
示例值:2018-06-08T10:34:56+08:00
通知类型 event_type string[1,32] 通知的类型
签约成功通知的类型为:PAPAY.SIGN
解约通知类型为:PAPAY.TERMINATE
示例值:PAPAY.SIGN
通知数据类型 resource_type string[1,32] 通知的资源数据类型,支付成功通知为encrypt-resource
示例值:encrypt-resource
通知数据 resource object 通知资源数据
参数名 变量 类型[长度限制] 必填 描述
加密算法类型 algorithm string[1,32] 对支付结果数据进行加密的加密算法,目前只支持AEAD_AES_256_GCM
示例值:AEAD_AES_256_GCM
数据密文 ciphertext string[1,1048576] Base64编码后的支付结果数据密文
附加数据 associated_data string[1,16] 加密使用的附加数据
随机串 nonce string[1,32] 加密使用的随机串

5. 通知签名

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

{
		"id":"EV-2018022511223320873",
		"create_time":"20180225112233",
		"resource_type":"encrypt-resource",
		"event_type":"PAPAY.SIGN",
		"resource" : {
			"algorithm":"AEAD_AES_256_GCM",
			"ciphertext": "...",
			"nonce": "...",
			"associated_data": ""
		}
}

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

{
		"mchid": "10000091",
		"out_contract_code": "100001256",
		"plan_id": 123,
		"contract_id": "Wx15463511252015071056489715",
		"appid": "wxcbda96de0b165486",
		"openid": "ouFhd5X9s9WteC3eWRjXV3lea123",
		"contract_termination_mode": "USER",
		"operate_time ": "2015-09-01T10: 00: 00+08: 00 "
}
{
		"sp_mchid": "10000091",
		"sub_mchid": "10000097",
		"out_contract_code": "100001256",
		"plan_id": 123,
		"contract_id": "Wx15463511252015071056489715",
		"sp_appid": "wxcbda96de0b165486",
		"openid": "ouFhd5X9s9WteC3eWRjXV3lea123",
		"contract_termination_mode": "USER",
		"operate_time": "2015-09-01T10:00:00+08:00"
}

6. 签约与解约结果参数

参数名 变量 类型[长度限制] 必填 描述
商户号 mchid string[1,32] 微信支付分配的商户号
注意:仅适用于直连模式
示例值:1900000109
APPID appid string[1,32] 商户在微信开放平台申请移动应用对应的APPID
注意:仅适用于直连模式
示例值:wx8888888888888888
机构商户号 sp_mchid string[1,32] 微信支付分配的机构商户号
注意:仅适用于机构模式
示例值:1900000100
子商户号 sub_mchid string[1,32] 微信支付分配的子商户商户号
注意:仅适用于机构模式
示例值:1900000109
机构APPID sp_appid string[1,32] 机构在微信公众平台申请服务号对应的APPID
注意:仅适用于机构模式
示例值:wx8888888888888888
子商户APPID sub_appid string[1,32] 子商户在微信开放平台申请移动应用对应的APPID
付款码支付/扫码支付/公众号支付使用商户公众号appid
小程序支付使用商户小程序appid
APP支付使用商户APP应用appid
注意:仅适用于机构模式
示例值:wx8888888888888888
签约协议号 out_contract_code string[1,32] 商户请求签约时传入的签约协议号,商户侧须唯一
示例值:1023658866
委托代扣协议ID contract_id string[1,64] 签约成功后,微信返回的委托代扣协议id
示例值:100005698
模板ID plan_id int 商户向微信支付申请代扣权限时,微信支付将会为商户分配一个唯一的代扣模板ID
示例值:123
用户标识 openid string[1,128] 用户在商户appid对应下的唯一标识,需要传appid才有返回
示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
协议解约方式 contract_termination_mode string[1,64] 解约方式
USER:用户解约
MERCHANT:商户解约
PLATFORM:商户平台解约
示例值:USER
协议到期时间 contract_expire_time string[1,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

操作时间 operate_time string[1,32]

操作时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。
示例值:2015-09-01T10:00:00+08:00


7. 通知应答

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

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

注意:重试过多会导致微信支付端积压过多通知而堵塞,影响其他正常通知。


参数名 变量 类型 必填 描述
返回状态码 code string[1,32] 详见下面返回状态码说明
示例值:SUCCESS
返回信息 message string[1,256] 返回信息,为错误原因
示例值:系统错误


200
{
	"code": "SUCCESS",
	"message": "OK"
}
{
    "code": "SYSTEM_ERROR",
    "message": "系统失败"
}
    页面导航

版本说明

关闭
V1.0
2021年8月20日
1. 签约与解约结果回调API上线

About  WeChat  Pay

Powered By Tencent & Tenpay Copyright©

2005-2024 Tenpay All Rights Reserved.

Contact Us
Wechat Pay Global

WeChat Pay Global

置顶