支付成功回调通知API

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


微信支付分通过支付成功通知接口将用户支付成功消息通知给商户

注意:

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

• 如果在所有通知频率(通知频率为0s/15s/15s/30s/180s/1800s/1800s/1800s/1800s/3600s )后没有收到微信侧回调,商户应调用查询订单接口确认订单状态。


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

接口说明

适用对象:直连商户

请求URL:该链接是通过商户[创建支付分订单]提交notify_url参数,必须为https协议。如果链接无法访问,商户将无法接收到微信通知。 通知url必须为直接可访问的url,不能携带参数。示例: “https://pay.weixin.qq.com/wxpay/pay.action”

接口规则:https://wechatpay-api.gitbook.io/wechatpay-api-v3

通知规则

支付完成后,微信会把相关支付结果和订单信息发送给商户,商户需要接收处理该消息,并返回应答。

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

通知报文

支付结果通知是以POST 方法访问商户设置的通知url,通知的数据以JSON 格式通过请求主体(BODY)传输。通知的数据包括了加密的支付结果详情。
(注:由于涉及到回调加密和解密,商户必须先设置好apiv3秘钥后才能解密回调通知,apiv3秘钥设置文档指引详见APIv3秘钥设置指引


下面详细描述对通知数据进行解密的流程:

  1. 1、用商户平台上设置的APIv3密钥【微信商户平台—>账户设置—>API安全—>设置APIv3密钥】,记为apiv3 key;
  2. 2、针对resource.algorithm中描述的算法(目前为AEAD_AES_256_GCM),取得对应的参数nonce和associated_data;
  3. 3、使用apiv3 key、nonce和associated_data,对数据密文resource.ciphertext进行解密,得到JSON形式的资源对象;

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

通知参数

参数名 变量 类型[长度限制] 必填 描述
通知ID id string[1,36] 通知的唯一ID
示例值:EV-2018022511223320873
通知创建时间 create_time string[1,16] 通知创建的时间,格式为yyyyMMddHHmmss(标准iso8601时间格式)
遵循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秒。
示例值:2015-05-20T13:29:35+08:00
通知类型 event_type string[1,32] 通知的类型,
授权成功通知的类型为PAYSCORE.USER_OPEN_SERVICE
解除授权成功通知的类型为PAYSCORE.USER_CLOSE_SERVICE
用户确认成功通知的类型为PAYSCORE.USER_CONFIRM
支付成功通知的类型为PAYSCORE.USER_PAID
示例值:PAYSCORE.USER_PAID
通知数据类型 resource_type string[1,32] 通知的资源数据类型,授权/解除授权成功通知为encryptresource
示例值:encrypt-resource
+通知数据 resource object 通知资源数据
json格式,见示例
参数名 变量 类型[长度限制] 必填 描述
加密算法类型 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,16] 加密使用的随机串
示例值:fdasflkja484w
回调摘要 summary string[1,64] 回调摘要
示例值:支付成功

通知签名

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

回调示例

支付成功结果通知


{
    "id":"EV-2018022511223320873",
    "create_time":"2015-05-20T13:29:35+08:00",
    "resource_type":"encrypt-resource",
    "event_type":"PAYSCORE.USER_PAID",
    "resource" : {
        "algorithm":"AEAD_AES_256_GCM",
        "ciphertext": "...",
        "nonce": "...",
        "associated_data": ""
    },
	"summary": "支付成功"
}

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


{
    "appid": "wxd678efh567hg6787", 
    "mchid": "1230000109", 
    "out_order_no": "1234323JKHDFE1243252", 
    "service_id": "500001", 
    "openid": "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o",
    "state": "DONE", 
    "total_amount": "40000", 
    "service_introduction": "嗨客餐厅用餐",
    "post_payments": [
        {
            "name": "服务费", 
            "amount": 40000, 
            "description": "每分钟1元"
        }
    ], 
    "post_discounts": [
        {
            "name": "满20减1元", 
            "amount": 1, 
            "description": "不与其他优惠叠加"
        }
    ], 
    "risk_fund": {
        "name": "ESTIMATE_ORDER_COST", 
        "amount": 10000, 
        "description": "就餐的预估费用"
    }, 
    "time_range": {
        "start_time": "20091225091010", 
        "end_time": "20091225091210"
    }, 
    "location": {
        "start_location": "嗨客时尚主题展餐厅", 
        "end_location": "嗨客时尚主题展餐厅"
    }, 
    "attach": "attach", 
    "notify_url": "https://api.test.com",
    "order_id": "165461131",
    "need_collection": true, 
    "collection": {
        "state": "USER_PAID", 
        "total_amount": 40000, 
        "paying_amount": 40000, 
        "paid_amount": 0, 
        "details": [
          { 
			"seq": 1, 
			"amount": 10000, 
			"paid_type": "MCH", 
			"paid_time": "20091225091210", 
			"transaction_id": "15646546545165651651", 
			"promotion_detail":[
			    {
				  "coupon_id": "123456", 
				  "name": "单品优惠-6", 
				  "scope": "GLOBAL", 
				  "type": "CASH", 
				  "amount": 100, 
				  "stock_id": "activity_id", 
				  "wechatpay_contribute": 100, 
				  "merchant_contribute": 100, 
				  "other_contribute": 0, 
				  "currency": "CNY", 
				  "goods_detail": [
						{
						  "goods_id": "M1006", 
						  "quantity": 1, 
						  "unit_price": 1, 
						  "discount_amount": 0, 
						  "goods_remark": "商品备注信息", 
						}
				  ]
				}
			]
			  }
        ]
    }
}

支付成功通知参数

参数名 变量 类型[长度限制] 必填 描述
公众账号ID appid string[1,32] 调用接口提交的公众账号ID
示例值:wxd678efh567hg6787
商户号 mchid string[1,32] 调用接口提交的商户号
示例值:1230000109
商户服务订单号 out_order_no string[1,32] 调用接口提交的商户服务订单号
示例值:1234323JKHDFE1243252
服务ID service_id string[1,32] 调用该接口提交的服务ID
示例值:500001
用户标识 openid string[1,128] 微信用户在商户对应appid下的唯一标识。
示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
服务订单状态 state string[1,32] 表示当前单据状态。
1、DONE:服务订单完成
示例值:DONE
订单状态说明 state_description string[1,32] 对服务订单"进行中"状态的附加说明:
USER_CONFIRM:用户确认
MCH_COMPLETE:商户完结
示例值:MCH_COMPLETE
商户收款总金额 total_amount int64 总金额,大于等于0的数字,单位为分,只能为整数,详见支付金额
此参数需满足:总金额=后付费项目金额之和-后付费商户优惠项目金额之和,且小于等于订单风险金额。取消订单时,该字段必须为0。
示例值:40000
服务信息 service_introduction string[1,20] 服务信息,用于介绍本订单所提供的服务
不超过20个字符,超出报错处理
示例值:嗨客餐厅用餐
+后付费项目 post_payments array 付费项目列表,最多包含100条付费项目
参数名 变量 类型[长度限制] 必填 描述
付费项目名称 name string[1,20] 当参数长度超过20个字符时,报错处理
示例值:服务费
金额 amount int64 此付费项目总金额,大于等于0,单位为分,等于0时代表不需要扣费,只能为整数,详见支付金额
示例值:40000
计费说明 description string[1,30] 描述计费规则,当参数长度超过30个字符时,报错处理
示例值:每分钟一元
付费数量 count int 付费项目的数量,大于等于1且小于等于100,不填默认为1
示例值:1
+后付费商户优惠 post_discounts array 商户优惠列表,最多包含5条商户优惠
参数名 变量 类型[长度限制] 必填 描述
优惠名称 name string[1,20] 优惠名称说明
示例值:满20减1元
优惠说明 description string[1,30] 大于等于0的数字,单位为分
示例值:1
优惠金额 amount int64 优惠金额,只能为整数,详见支付金额
示例值:100
+订单风险金 risk_fund object 订单风险金信息
参数名 变量 类型[长度限制] 必填 描述
风险金名称 name string[1,64] 枚举值:
1、押金:DEPOSIT
2、预付款:ADVANCE
3、保证金:CASH_DEPOSIT
4、预估订单费用:ESTIMATE_ORDER_COST
示例值:ESTIMATE_ORDER_COST
风险金额 amount int64 1、整数,必须>0(单位:分)
2、风险金额≤每个服务ID的风险金额上限。
3、当商户优惠字段为空时,付费项目总金额≤风险金额 (未填写金额的付费项目,视为该付费项目金额为0)
示例值:10000
风险说明 description string[1,30] 风险说明,不超过30个字符
示例值:就餐的预估费用
+服务时间段 time_range object 服务使用时间范围
参数名 变量 类型[长度限制] 必填 描述
服务开始时间 start_time string[1,14] 支持两种格式:“yyyyMMddHHmmss”和“yyyyMMdd”。
1、传入20091225091010表示2009年12月25日9点10分10秒
2、传入20091225默认认为时间为2009年12月25日
根据传入时间精准度进行校验
1、若传入时间精准到秒,则校验精准到秒。
2、若传入时间精准到日,则校验精准到日。
示例值:20091225091010
服务开始时间备注 start_time_remark string[1,20] 服务开始时间备注说明。
1、服务开始时间有填时,可填写服务开始时间备注,不超过20个字符,超出报错处理。
示例值:开始租借日期
服务结束时间 end_time string[1,14] 支持两种格式:yyyyMMddHHmmss和yyyyMMdd
  1. 传入20091225091010表示2009年12月25日9点10分10秒
  2. 传入20091225默认认为时间为2009年12月25日
根据传入时间精准度进行校验
1、若传入时间精准到秒,则校验精准到秒。
2、若传入时间精准到日,则校验精准到日。
示例值:20091225121010
服务结束时间备注 end_time_remark string[1,20] 服务结束时间备注说明。
1、服务结束时间有填时,可填写服务结束时间备注,不超过20个字符,超出报错处理。
示例值:结束租借日期
+服务位置 location object 服务使用位置信息
参数名 变量 类型[长度限制] 必填 描述
服务开始地点 start_location string[1,20] 开始使用服务的地点,当参数长度超出20个字符时,报错处理;
示例值:嗨客时尚主题展餐厅
服务结束位置 end_location string[1,20] 预计服务结束的地点,用户下单时未确认服务结束地点时,可不填写。当参数长度超出20个字符时,报错处理
示例值:嗨客时尚主题展餐厅
商户数据包 attach string[1,200] 商户数据包可存放本订单所需信息,需要先urlencode后传入。
当商户数据包总长度超出256字符时,报错处理。
示例值:attach
商户回调地址 notify_url string[1,255] query商户接收用户确认订单和付款成功回调通知的地址。
示例值:https://api.test.com
微信支付服务订单号 order_id string[1,64] 微信支付服务订单号,每个微信支付服务订单号与商户号下对应的商户服务订单号一一对应
示例值:15646546545165651651
是否需要收款 need_collection bool 是否需要收款,非0元完结后返回
true:微信支付分代收款
false:无需微信支付分代收款
示例值:false
+收款信息 collection object 收款信息,非0元完结后返回
参数名 变量 类型[长度限制] 必填 描述
收款状态 state string[1,32] USER_PAYING:待支付
USER_PAID:已支付
示例值:USER_PAID
总收款金额 total_amount int64 总金额,大于等于0的数字,单位为分,只能为整数,详见支付金额
此参数需满足:总金额=付费项目金额之和-商户优惠项目金额之和,且小于等于订单风险金额 。取消订单时,该字段必须为0。
示例值:10000
待收金额 paying_amount int64 等待用户付款金额,只能为整数,详见支付金额
示例值:10000
已收金额 paid_amount int64 用户已付款的金额,只能为整数,详见支付金额
示例值:0
+收款明细列表 details array 收款明细列表
参数名 变量 类型[长度限制] 必填 描述
收款序号 seq int 从1开始递增
示例值:1
单笔收款金额 amount int64 单笔收款动作的金额,只能为整数,详见支付金额
示例值:10000
收款成功渠道 paid_type string[1,32] 收款成功渠道
NEWTON:微信支付分
MCH:商户渠道
示例值:MCH
收款成功时间 paid_time string[1,14] 支持两种格式:yyyyMMddHHmmss和yyyyMMdd
  1. 传入20091225091010表示2009年12月25日9点10分10秒
  2. 传入20091225默认认为时间为2009年12月25日0点0分0秒
示例值:20091225091210
微信支付交易单号 transaction_id string[1,200] 结单交易单号,等于普通支付接口中的transaction_id,可以使用该订单号在APP支付->API列表->查询订单申请退款。只有单据状态为USER_PAID,且收款成功渠道为支付分渠道,收款金额大于0,才会返回结单交易单号。
示例值:15646546545165651651
+ 优惠功能 promotion_detail array 优惠功能
注:针对2020年5月27日10:00:00以后完结的订单生效
参数名 变量 类型[长度限制] 必填 描述
券ID coupon_id string[1,32] 券ID
示例值:123456
优惠名称 name string[1,64] 优惠名称
示例值:单品优惠-6
优惠范围 scope string[1,12] GLOBAL:全场代金券;
SINGLE:单品优惠
示例值:GLOBAL
优惠类型 type string[1,12] 枚举值:CASH:充值;
NOCASH:免充值。
示例值:CASH
优惠券面额 amount int64 优惠券面额
示例值:100
活动ID stock_id string[1,32] 活动ID,批次ID
示例值:activity_id
微信出资 wechatpay_contribute int64 微信出资
示例值:100
商户出资 merchant_contribute int64 商户出资
示例值:100
其他出资 other_contribute int64 其他出资
示例值:0
优惠币种 currency string CNY:人民币,境内商户号仅支持人民币
示例值:CNY
+ 单品列表 goods_detail array 单品列表
参数名 变量 类型[长度限制] 必填 描述
商品编码 goods_id string[1,32] 商品编码
示例值:M1006
商品数量 quantity uint32 商品数量
示例值:1
商品价格 unit_price int64 商品价格
示例值:1
商品优惠金额 discount_amount int64 商品优惠金额
示例值:0
商品备注 goods_remark string[1,128] 商品备注
示例值:商品备注信息

通知应答

商户后台在正确处理回调之后,需要返回200或者204的HTTP状态码。其他的状态码,微信支付均认为通知失败,并按照前述的策略定期发起通知。

注意:当商户后台应答失败时,微信支付将记录下应答的报文,建议商户按照以下格式返回。


参数名 变量 类型[长度限制] 必填 描述
返回状态码 code string[1,32] 错误码,SUCCESS为接收成功,其他错误码为失败。
示例值:SUCCESS
返回信息 message string[1,256] 返回信息,如非空,为错误原因。
示例值:系统错误


{
 "code": "ERROR_NAME",
  "message": "ERROR_DESCRIPTION",
}



版本说明

关闭
V1.4
2020.05.25
1. 支付成功回调通知接口新增返回收款优惠信息(promotion_detail)字段
V1.3
2020.04.22
1. 新增参数返回条件:need_collection,条件返回,非0元完结后返回;collection,条件返回,非0元完结后返回
V1.2
2020.03.05
1. 服务订单状态,枚举值:EXPIRED “状态超过1小时未变动,则订单失效”调整为“ED 状态超过30天未变动,则订单失效”
V1.1
2019.12.27
1. 支付成功回调通知新加notify_url、服务时间备注字段

技术咨询

反馈有奖