二级商户充值结果通知
更新时间:2024.10.21微信支付通过该接口将二级商户的充值结果通知给平台商户的系统
注意
对后台通知交互时,如果微信收到应答不是成功或超时,微信认为通知失败,微信会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但微信不保证通知最终能成功
- 同样的通知可能会多次发送给商户系统。商户系统必须能够正确处理重复的通知。 推荐的做法是,当商户系统收到通知进行处理时,先检查对应业务数据的状态,并判断该通知是否已经处理。如果未处理,则再进行处理;如果已处理,则直接返回结果成功。在对业务数据进行状态检查和处理之前,要采用数据锁进行并发控制,以避免函数重入造成的数据混乱。
- 如果在所有通知频率后没有收到微信侧回调。商户应调用查询订单接口确认订单状态。
特别提醒: 商户系统对于开启结果通知的内容一定要做签名验证,并校验通知的信息是否与商户侧的信息一致,防止数据泄露导致出现“假通知”,造成资金损失。
# 接口说明
支持商户: 【平台商户】
请求方式: 【POST】
回调URL: 该链接是通过“申请充值”接口中的请求参数“notify_url”来设置的,要求必须为HTTPS地址。请确保回调URL是外部可正常访问的,且不能携带后缀参数,否则可能导致商户无法接收到微信的回调通知信息。 回调URL示例:"https://pay.weixin.qq.com/wxpay/pay.action (opens new window)"
# 通知规则
商家充值完成后,微信会把相关充值结果和二级商户信息发送给平台,平台商户的系统需要接收处理该消息,并返回应答。以下几种情况,微信会发送通知:
- 充值成功。如商家使用微信扫码、银行转账充值成功
- 关闭充值。如平台主动关闭充值单、系统自动关闭超时充值单等
对后台通知交互时,如果微信收到商户的应答不符合规范或超时,微信认为通知失败,微信会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但微信不保证通知最终能成功。(通知频率为15s/15s/15s/15s/15s/15s/15s/15s/60s/60s/60s/60s/10m/10m/1h/1h - 总计 2h26m)
# 通知报文
充值结果通知是以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取值不带引号。
# 字段说明
# 充值结果通知
参数说明
- 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年05月20日13点29分35秒。 - event_type 必填通知的类型。
- 充值成功: RECHARGE.SUCCESS
- 关闭充值: RECHARGE.CLOSED - resource_type 必填通知的资源数据类型,支付成功通知为encrypt-resource。
- resource 必填通知资源数据。
- 属性
- summary 必填回调摘要
参数示例
1{2 "id":"EV-2018022511223320873",3 "create_time":"2015-05-20T13:29:35+08:00",4 "resource_type":"encrypt-resource",5 "event_type":"RECHARGE.SUCCESS",6 "resource" : {7 "algorithm":"AEAD_AES_256_GCM",8 "ciphertext": "...",9 "nonce": "...",10 "associated_data": ""11 },12 "summary": "充值成功"13}
# resource解密后结果
参数说明
- sp_mchid 必填【平台商户号】 微信支付分配的商户号
- sub_mchid 必填【二级商户号】 微信支付分配的商户号
- out_recharge_no 必填【商户充值单号】 商户系统内部的充值单号,只能由数字、大小写字母组成,在平台商户系统内部唯一
- recharge_id 必填【微信支付充值单号】 微信支付充值单号
- recharge_channel 必填【充值渠道】 充值渠道
可选取值:
-BANK_TRANSFER
: 银行转账
-QR_RECHARGE
: 扫码充值 - account_type 必填【充值入账账户】 仅支持保证金账户
可选取值:
-DEPOSIT
: 保证金账户 - recharge_scene 必填【充值场景】 仅支持电商平台充值保证金
可选取值:
-ECOMMERCE_DEPOSIT
: 电商平台充值保证金 - recharge_state 必填【充值状态】 充值状态
可选取值:
-SUCCESS
: 充值成功
-RECHARGING
: 充值中
-CLOSED
: 已关闭 - recharge_state_desc 选填【充值状态描述】 展示充值状态、关闭充值原因等描述
- recharge_amount 必填【充值金额】 单位为分,仅支持CNY。
- 属性
- remark 选填【备注】 备注
- bank_transfer_info 选填【银行转账信息】 包括充值附言、银行流水单号等内容
- 属性
- qr_recharge_info 选填【扫码充值信息】 包括充值用户openid
- 属性
- accept_time 必填【受理充值时间】 使用rfc3339标准格式
- success_time 选填【充值成功时间】 当状态为“充值成功”时返回,使用rfc3339标准格式
- close_time 选填【关闭充值时间】 当状态为“已关闭”时返回,使用rfc3339标准格式
参数示例
充值成功(扫码):
1{2 "sp_mchid": "1900001109",3 "sub_mchid": "1900001121",4 "out_recharge_no": "cz202407181234",5 "recharge_id": "100000202405180012345678",6 "recharge_scene": "ECOMMERCE_DEPOSIT",7 "account_type": "DEPOSIT",8 "recharge_channel": "QR_RECHARGE",9 "recharge_amount": {10 "amount": 500000,11 "currency": "CNY"12 }, 13 "recharge_state": "SUCCESS",14 "recharge_state_desc": "充值成功",15 "accept_time": "2015-05-19T13:29:35+08:00",16 "success_time": "2015-05-20T14:29:35+08:00",17 "remark": "备注",18 "qr_recharge_info":{19 "employee_type": "STAFF",20 "openid": "owYiu0WOJdGCYxoHrPabGhI39uT4"21 }22}
充值成功(银行转账):
1{2 "sp_mchid": "1900001109",3 "sub_mchid": "1900001121",4 "out_recharge_no": "cz202407181234",5 "recharge_id": "100000202405180012345678",6 "recharge_scene": "ECOMMERCE_DEPOSIT",7 "account_type": "DEPOSIT",8 "recharge_channel": "BANK_TRANSFER",9 "recharge_amount": {10 "amount": 500000,11 "currency": "CNY"12 },13 "recharge_state": "SUCCESS",14 "recharge_state_desc": "充值成功",15 "accept_time": "2015-05-19T13:29:35+08:00",16 "success_time": "2015-05-20T14:29:35+08:00",17 "remark": "备注",18 "bank_transfer_info": {19 "bill_no": "111111",20 "memo": "转账充值附言",21 "bank_name": "中国银行",22 "bank_card_tail": "0722"23 }24}
关闭充值
1{2 "sp_mchid": "1900001109",3 "sub_mchid": "1900001121",4 "out_recharge_no": "cz202407181234",5 "recharge_id": "100000202405180012345678",6 "recharge_scene": "ECOMMERCE_DEPOSIT",7 "account_type": "DEPOSIT",8 "recharge_channel": "BANK_TRANSFER",9 "recharge_amount": {10 "amount": 500000,11 "currency": "CNY"12 },13 "recharge_state": "CLOSED",14 "recharge_state_desc": "平台商户主动关闭充值单",15 "accept_time": "2015-05-19T13:29:35+08:00",16 "close_time": "2015-05-20T14:29:35+08:00",17 "remark": "备注"18}
# 通知应答
接收成功: HTTP应答状态码需返回200或204,无需返回应答报文。
接收失败: HTTP应答状态码需返回5XX或4XX,同时需返回应答报文,格式如下:
应答参数
- code 必填【返回状态码】
错误码,SUCCESS为接收成功,其他错误码为失败。 - message 必填【返回信息】
返回信息,如非空,为错误原因。示例值:失败
应答示例
1{ 2 "code": "FAIL",3 "message": "失败"4}