Login expired. Please log in again.

Feedback

0/300

Feedback

Submitted successfully

ok

Feedback

Network exception, please try again later

ok

扣款结果通知API

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

扣款完成后,微信会把相关支付结果及用户信息通过数据流的形式发送给商户 。

注意:

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

● 如果在所有通知频率(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,36] 通知的唯一ID
示例值:f7c34059-0f2d-5b32-ba33-a42dks0597c5
通知创建时间 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":"f7c34059-0f2d-5b32-ba33-a42dks0597c5",
	"create_time":"20180225112233",
	"resource_type":"encrypt-resource",
	"event_type":"PAPAY.SIGN",
	"resource" : {
		"algorithm":"AEAD_AES_256_GCM",
		"ciphertext": "...",
		"nonce": "...",
		"associated_data": ""
	}
}

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

{
		"mchid": "10000100",
		"appid": "wx2421b1c4370ec43b",
		"out_trade_no": "20150806125346",
		"transaction_id": "1008450740201411110005820873",
		"attach": "支付测试",
		"trade_type": "AUTH",
		"bank_type": "CCB_DEBIT",
		"success_time": "2018-06-08T10:34:56+08:00",
		"trade_state": "SUCCESS",
		"trade_state_desc": "支付成功",
		"merchant_category_code": "1011",
		"contract_id": "Wx15463511252015071056489715",
		"payer": {
			"openid": "oUpF8uN95-Ptaags6E_roPHg7AG0"
		},
		"amount": {
			"total": 528800,
			"currency": "HKD",
			"payer_total": 518799,
			"payer_currency": "CNY",
			"exchange_rate": {
				"type": "SETTLEMENT_RATE",
				"rate": 8000000
			}
		},
		"promotion_detail": [{
			"promotion_id": "109519",
			"name": "单品惠-6",
			"scope": "SINGLE",
			"type": "DISCOUNT",
			"amount": 1,
			"currency": "HKD",
			"activity_id": "931386",
			"wechatpay_contribute_amount": 1,
			"merchant_contribute_amount": 0,
			"other_contribute_amount": 0,
			"goods_detail": [{
				"goods_id": "iphone6s_16G",
				"goods_remark": "商品备注",
				"quantity": 1,
				"price": 528800
			}]
		}]
}
{
		"sp_mchid": "10000100",
		"sp_appid": "wx2421b1c4370ec43b",
		"sub_mchid": "20000100",
		"out_trade_no": "20150806125346",
		"transaction_id": "1008450740201411110005820873",
		"attach": "支付测试",
		"trade_type": "AUTH",
		"bank_type": "CCB_DEBIT",
		"success_time": "2018-06-08T10:34:56+08:00",
		"trade_state": "SUCCESS",
		"trade_state_desc": "支付成功",
		"merchant_category_code": "1011",
		"contract_id": "Wx15463511252015071056489715",
		"payer": {
			"sp_openid": "oUpF8uN95-Ptaags6E_roPHg7AG0"
		},
		"amount": {
			"total": 528800,
			"currency": "HKD",
			"payer_total": 518799,
			"payer_currency": "CNY",
			"exchange_rate": {
				"type": "SETTLEMENT_RATE",
				"rate": 8000000
			}
		},
		"promotion_detail": [{
			"promotion_id": "109519",
			"name": "单品惠-6",
			"scope": "SINGLE",
			"type": "DISCOUNT",
			"amount": 1,
			"currency": "HKD",
			"activity_id": "931386",
			"wechatpay_contribute_amount": 1,
			"merchant_contribute_amount": 0,
			"other_contribute_amount": 0,
			"goods_detail": [{
				"goods_id": "iphone6s_16G",
				"goods_remark": "商品备注",
				"quantity": 1,
				"price": 528800
			}]
		}]
}

6. 支付成功通知参数

参数名 变量 类型[长度限制] 必填 描述
商户号 mchid string[1,32] 微信支付分配的商户号
注意:仅适用于直连模式
示例值:1900000109
应用ID appid string[1,32] 商户号绑定的appid
注意:仅适用于直连模式
示例值:wxcbda96de0b165486
服务商商户号 sp_mchid string[1,32] 微信支付分配的机构商户号
注意:仅适用于机构模式
示例值:10000098
子商户号 sub_mchid string[1,32] 微信支付分配的子商户号
注意:仅适用于机构模式
示例值:10000097
服务商应用ID sp_appid string[1,32] 服务商绑定的appid
注意:仅适用于机构模式
示例值:wxcbda96de0b165486
子商户应用ID sub_appid string[1,32] 发起签约的子商户号绑定的appid
注意:仅适用于机构模式
示例值:wxcbda96de0b165484
商户订单号 out_trade_no string[1,32] 返回的商户订单号
示例值:1217752501201407033233368018
微信支付订单号 contract_id string[1,32] 微信支付订单号
示例值:1217752501201407033233368018
商户数据 attach string[1,127] 附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据
示例值:自定义数据
交易类型 trade_type string[1,16] 代扣支付
示例值:AUTH
付款银行 bank_type string[1,32] 银行类型
示例值:WPHK:香港钱包支付
支付完成时间 success_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
交易状态 trade_state string[1,16] 枚举值:
SUCCESS:支付成功
REFUND:转入退款
NOTPAY:未支付
CLOSED:已关闭
PAYERROR:支付失败
USERPAYING:用户支付中
示例值:SUCCESS
支付者 payer object Body成功时才返回。支付者信息,详细说明见下文
参数名 变量 类型[长度限制] 必填 描述
用户标识(直连商户) openid string[1,128] 用户在商户appid下的openid
注意:仅适用于直连模式
示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6a
用户标识(服务商) sp_openid string[1,128] 用户在商户sp_appid对应下的唯一标识,需要传sp_appid才有返回
注意:仅适用于机构模式
示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
用户标识(子商户) sub_openid string[1,128] 用户在收单行sub_appid下用户唯一标识,需要传sub_appid才有返回
注意:仅适用于机构模式
示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
订单金额 amount object Body成功时才返回。订单金额信息,详细说明见下文
参数名 变量 类型[长度限制] 必填 描述
订单金额 total int 订单总金额,币种的最小单位,只能为整数,详见交易金额
示例值:888
用户支付金额 payer_total int 用户实际支付金额,币种的最小单位,只能为整数,详见交易金额
示例值:888
订单标价币种 currency string[1,16] 符合ISO 4217标准的三位字母代码
示例值:CNY
用户支付币种 payer_currency string[1,16] 符合ISO 4217标准的三位字母代码
示例值:HKD
汇率信息 exchange_rate object Body汇率信息
参数名 变量 类型[长度限制] 必填 描述
汇率类型 type string[1,16] 枚举值:
SETTLEMENT_RATE:标价币种和结算币种的汇率类型 USERPAYMENT_RATE:标价币种和支付币种的汇率类型
示例值:SETTLEMENT_RATE
汇率值 rate int rate值是兑换比例乘以10的8次方。 如果标价币种和结算币种一致,兑换比例是1,则rate=100000000; 如果标价币种和结算币种不一致,例如美元兑换人民币的比例为6.5,则rate=650000000
示例值:80000000
场景信息 scene_info object Body成功时才返回。场景信息对象,详细说明见下文
参数名 变量 类型[长度限制] 必填 描述
商户端设备 device_id string[1,32] 终端设备号(商户自定义,如门店编号)
示例值:013467007045764
商户端设备IP device_ip string[1,40] 商户侧设备IP,取公网出口IP,支持IPV6
示例值:128.0.0.1
优惠功能 promotion_detail array Body成功时才返回。优惠功能信息,详细说明见下文
参数名 变量 类型[长度限制] 必填 描述
券ID promotion_id string[1,32] 券或者立减优惠id
示例值:109519
优惠名称 name string[1,64] 优惠名称
示例值:单品惠-6
优惠范围 scope string[1,32] GLOBAL:全场代金券
SINGLE:单品优惠
示例值:SINGLE
优惠类型 type string[1,16] COUPON:代金券,需要走结算资金的充值型代金券,(境外商户券币种与支付币种一致)
DISCOUNT:优惠券,不走结算资金的免充值型优惠券,(境外商户券币种与标价币种一致
示例值:COUPON
优惠券面额 amount int 用户享受优惠的金额
示例值:5
优惠币种 currency string[1,16] 符合ISO 4217标准的三位字母代码
示例值:HKD
活动ID activity_id string[1,32] 在微信商户后台配置的批次ID
示例值:931386
微信出资 wxpay_contribute_amount int 特指由微信支付商户平台创建的优惠,出资金额等于本项优惠总金额
示例值:5
商户出资 merchant_contribute_amount int 特指商户自己创建的优惠,出资金额等于本项优惠总金额
示例值:5
其他出资 other_contribute_amount int 其他出资方出资金额
示例值:5
单品列表 goods_detail array 成功时才返回。优惠功能信息,详细说明见下文
参数名 变量 类型[长度限制] 必填 描述
商品编码 goods_id string[1,32] 由半角的大小写字母、数字、中划线、下划线中的一种或几种组成
示例值:124512
商品备注 goods_remark string[1,128] goods_remark为备注字段,按照配置原样返回,字段内容在微信后台配置券时进行设置
示例值:1001
商品优惠金额 discount_amount int 单品的总优惠金额
示例值:100
商品数量 quantity int 用户购买的数量
示例值:1
商品价格 price int 单位为:分。如果商户有优惠,需传输商户优惠后的单价
示例值:528800

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

置顶