回调通知-支付成功
通知规则
支付完成后,微信会把相关支付结果和订单信息发送给商户,商户需要接收处理该消息,并返回应答。
对后台通知交互时,如果微信收到商户的应答不符合规范或超时,微信认为通知失败,微信会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但微信不保证通知最终能成功。 (通知频率为15/15/30/180/1800/1800/1800/1800/3600,单位:秒)
注意:
- 同样的通知可能会多次发送给商户系统。商户系统必须能够正确处理重复的通知。推荐的做法是,当收到通知进行处理时,首先检查对应业务数据的状态,判断该通知是否已经处理过,如果没有处理过再进行处理,如果处理过直接返回结果成功。在对业务数据进行状态检查和处理之前,要采用数据锁进行并发控制,以避免函数重入造成的数据混乱。
- 如果在所有通知频率(4小时)后没有收到微信侧回调,商户应调用查询智慧零售订单接口确认订单状态。
特别提醒:商户系统对于开启结果通知的内容一定要做签名验证,并校验通知的信息是否与商户侧的信息一致,防止数据泄露导致出现“假通知”,造成资金损失。
接口链接
该链接是通过[商户配置] 提交pay_notify_url设置,必须为https协议。如果链接无法访问,商户将无法接收到微信通知。
通知url必须为直接可访问的url,不能携带参数。示例: “http://pay.weixin.qq.com/wxpay/pay.action”
通知报文
支付结果通知是以POST方法访问商户设置的通知url,先享后付和智慧零售的通知的数据以JSON格式通过请求主体(BODY)传输。免押租借和免押速住的通知的数据以XML格式通过请求主体(BODY)传输。通知的数据包括了加密的开启结果详情。(以下是先享后付和智慧零售的回调参数,免押租借和免押速住的以实际回调为准)
下面详细描述对通知数据进行解密的流程
- 用商户平台上设置的APIv3密钥(微信商户平台(pay.weixin.qq.com)-账户设置-API安全-设置APIv3密钥),记为key
- 针对resource.algorithm中描述的算法(目前为AEAD_AES_256_GCM),取得对应的参数nonce和associated_data。
- 使用key、nonce和associated_data,对数据密文resource.ciphertext进行解密,得到JSON形式的资源对象
注: AEAD_AES_256_GCM算法的接口细节,请参考rfc5116。微信支付使用的密钥key长度为32个字节,随机串nonce长度12个字节,associated_data长度小于16个字节并可能为空。
通知参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
通知ID | id | 是 | String(32) | EV-2018022511223320873 | 通知的唯一ID |
通知创建时间 | create_time | 是 | String(16) | 20180225112233 | 通知创建的时间,格式为yyyyMMddHHmmss |
通知类型 | event_type | 是 | String(32) | PAYSCORE.USER_OPEN_SERVICE | 通知的类型,开启成功通知的类型为PAYSCORE.USER_PAID |
通知数据类型 | resource_type | 是 | String(32) | encrypt-resource | 通知的资源数据类型,开启成功通知为encrypt-resource |
通知数据 | resource | 是 | Object | 通知资源数据 json格式,见示例 |
|
加密算法类型 | resource.algorithm | 是 | String(32) | AEAD_AES_256_GCM | 对开启结果数据进行加密的加密算法,目前只支持AEAD_AES_256_GCM |
数据密文 | resource.ciphertext | 是 | String(1048576) | Base64编码后的开启结果数据密文 | |
附加数据 | resource.associated_data | 否 | String(16) | 附加数据 | |
随机串 | resource.nonce | 是 | String(16) | fdasflkja484w | 加密使用的随机串 |
通知签名
加密不能保证通知请求来自微信。微信会对发送给商户的通知进行签名,并将签名值放在通知的HTTP头Wechatpay-Signature。商户应当验证签名,以确认请求来自微信,而不是其他的第三方。签名验证的算法请参考 《微信支付API v3签名验证》。
通知应答
商户后台在正确处理回调之后,需要返回200或者204的HTTP状态码。其他的状态码,微信支付均认为通知失败,并按照前述的策略定期发起通知。注意,当商户后台应答失败时,微信支付将记录下应答的报文,建议商户按照以下格式返回。
{
"code": "ERROR_NAME",
"message": "ERROR_DESCRIPTION",
}
回调示例
微信发送给商户的开启结果通知
{
"id":"EV-2018022511223320873",
"create_time":"20180225112233",
"resource_type":"encrypt-resource",
"event_type":"PAYSCORE.USER_OPEN_SERVICE",
"resource" : {
"algorithm":"AEAD_AES_256_GCM",
"ciphertext": "...",
"nonce": "...",
"associated_data": "",
}
}
商户对resource对象进行解密后,得到的资源对象示例
{
"appid": "wxd678efh567hg6787",
"mchid": "1230000109",
"out_order_no": "1234323JKHDFE1243252",
"service_id": "500001",
"state": "PAYSCORE.USER_PAID",
"finish_type": 2,
"service_start_time": "20091225091010",
"service_end_time": "20091225091210",
"real_service_start_time": "20091225091010",
"real_service_end_time": "20091225091210",
"service_start_location": "嗨客时尚主题展餐厅",
"service_end_location": "嗨客时尚主题展餐厅",
"real_service_end_location": "嗨客时尚主题展餐厅",
"service_introduction":"嗨客餐厅用餐",
"fees": [{
"fee_name": "服务费",
"fee_amount": 40000,
"fee_desc": "每分钟1元"
}],
"discounts": [{
"discount_name": "满20减1元",
"discount_amount": 1,
"discount_desc": "不与其他优惠叠加"
}],
"risk_amount": 100000,
"total_amount": "40000",
"attach": "attach",
"finish_transaction_id":"165461131"
}
支付成功通知商户订单信息字段
变量名 | 类型 | 必填 | 示例 | 描述 |
---|---|---|---|---|
appid | string(32) | 是 | wxd678efh567hg6787 | 调用接口提交的公众账号ID |
mchid | string(32) | 是 | 1230000109 | 调用接口提交的商户号 |
out_order_no | string(32) | 是 | 1234323JKHDFE1243252 | 调用接口提交的商户服务订单号 |
service_id | string(32) | 是 | 500001 | 调用该接口提交的服务ID |
state | string(32) | 是 | PAYSCORE.USER_PAID | 表示当前单据状态. CREATED:商户下单已受理 USER_ACCEPTED:用户成功使用服务 FINISHED:商户完结订单 USER_PAID:用户订单支付成功 REVOKED:商户撤销订单 EXPIRED:订单已失效. “商户下单已受理”状态超过1小时未变动,则订单失效 |
finish_type | int | 否 | 2 | 标识用户订单使用情况: 1 未使用服务,取消订单; 2 完成服务使用,结束订单 |
service_start_time | string(16) | 是 | 20091225091010 | 支持两种格式:yyyyMMddHHmmss和yyyyMMdd 传入20091225091010表示2009年12月25日9点10分10秒 传入20091225默认时间为2009年12月25日0点0分0秒 |
service_end_time | string(16) | 否 | 20091225091210 | 支持两种格式:yyyyMMddHHmmss和yyyyMMdd 传入20091225091010表示2009年12月25日9点10分10秒 传入20091225默认时间为2009年12月25日23点59分59秒 |
real_service_start_time | string(16) | 否 | 20091225091010 | 支持两种格式:yyyyMMddHHmmss和yyyyMMdd 传入20091225091010表示2009年12月25日9点10分10秒 传入20091225默认时间为2009年12月25日0点0分0秒 |
real_service_end_time | string(16) | 否 | 20091225091210 | 支持两种格式:yyyyMMddHHmmss和yyyyMMdd 传入20091225091010表示2009年12月25日9点10分10秒 传入20091225默认时间为2009年12月25日23点59分59秒 |
pay_succ_time | string(16) | 是 | 20091225091210 | 支持两种格式:yyyyMMddHHmmss和yyyyMMdd 传入20091225091010表示2009年12月25日9点10分10秒 传入20091225默认时间为2009年12月25日0点0分0秒 |
service_start_location | string(20) | 是 | 嗨客时尚主题展餐厅 | 开始使用服务的地点. 不超过20个字符,超出报错处理 |
service_end_location | string(20) | 否 | 嗨客时尚主题展餐厅 | 预计服务结束的地点,用户下单时未确认服务结束地点时,可不填写. 不超过20个字符,超出报错处理 |
real_service_end_location | string(20) | 否 | 嗨客时尚主题展餐厅 | 服务结束的地点 不超过20个字符,超出报错处理 |
service_introduction | string(20) | 是 | 嗨客餐厅用餐 | 服务信息,用于介绍本订单所提供的服务 不超过20个字符,超出报错处理 |
fees | array | 是 | none | 付费项目列表,最多包含100条付费项目 参见Fee表格说明 |
discounts | array | 否 | none | 商户优惠列表,最多包含5条商户优惠 参见Discount表格说明 |
risk_amount | int | 是 | 100000 | 大于0的数字,单位为分 当填写了【优惠金额】字段时,订单风险金额需满足:付费项目金额之和-优惠项目金额之和<订单风险金额 订单风险金额不能超出每个服务ID的风险金额上限 |
total_amount | int | 否 | 40000 | 大于等于0的数字,单位为分 需满足:总金额=付费项目金额之和-商户优惠项目金额之和<=订单风险金额 未使用服务,取消订单时,该字段必须填0. |
attach | string(200) | 否 | attach | 商户数据包,可存放本订单所需信息. 需要先urlencode后传入. 总长度不大于200字符,超出报错处理. |
finish_transaction_id | string(200) | 否 | 165461131 | 结单交易单号,可以使用该订单号在APP支付->API列表->查询订单进行查询订单、申请退款,只有单据状态为USER_PAID才会返回结单交易单号 |
变量名 | 类型 | 必填 | 示例 | 描述 |
---|---|---|---|---|
fee_name | string | 是 | 阿萨姆瓶装奶茶 | 不超过20个字符,超出报错处理 |
fee_count | int | 否 | 2 | 数量,付费项目数量,大于等于1且小于等于100,不填默认为1 |
fee_amount | int | 否 | 800 | 此付费项目总金额,大于等于0,单位为分,等于0时代表不需要扣费 |
fee_desc | string | 否 | 每分钟1元 | 描述计费规则,不超过30个字符,超出报错处理 |
变量名 | 类型 | 必填 | 示例 | 描述 |
---|---|---|---|---|
discount_name | int | 否 | 满20减1元 | 不超过20个字符,超出报错处理 |
discount_amount | int | 否 | 1 | 大于等于0的数字,单位为分 |
discount_desc | int | 否 | 不与其他优惠叠加 | 不超过30个字符,超出报错处理 |