支付成功回调
更新时间:2024.09.27# 一、回调描述
用户使用微信支付分服务,当商户调用完结支付分订单API后,微信支付会轮询向用户发起扣款,当扣款成功时,微信支付会通过POST的请求方式,向商户预先设置的回调地址发送回调通知,让商户知晓用户已完成支付。
回调地址设置方式: 回调地址通过【创建支付分订单】接口中的“notify_url”参数设置,回调地址的设置规范和回调IP列表请参考文档:回调通知注意事项 (opens new window)。
# 二、回调处理步骤
# 1、商户接收回调通知报文
微信支付会通过POST的方式向回调地址发送回调报文,回调报文的HTTP请求头中会包含报文的签名信息,用于后续验签,具体如下:
参数 | 描述 |
---|---|
Wechatpay-Serial | 验签的“微信支付平台证书”所对应的平台证书序列号 |
Wechatpay-Signature | 验签的签名值 |
Wechatpay-Timestamp | 验签的时间戳 |
Wechatpay-Nonce | 验签的随机字符串 |
回调通知的请求主体中会包含JSON格式的通知参数,具体的通知参数列表如下:
通知参数
- id 必填【通知ID】回调通知的唯一编号。
- create_time 必填【通知创建时间】回调通知创建的时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。
- event_type 必填【通知类型】微信支付分回调通知的类型,支付分订单支付成功通知为PAYSCORE.USER_PAID。
- resource_type 必填【通知数据类型】通知的资源数据类型,固定为encrypt-resource。
- resource 必填【通知资源数据】json格式,见示例
- 属性
- summary 必填【回调摘要】微信支付对回调内容的摘要备注。
支付成功结果通知
1{2 "id":"EV-2018022511223320873",3 "create_time":"2015-05-20T13:29:35+08:00",4 "resource_type":"encrypt-resource",5 "event_type":"PAYSCORE.USER_PAID",6 "resource" : {7 "algorithm":"AEAD_AES_256_GCM",8 "ciphertext": "...",9 "nonce": "...",10 "associated_data": ""11 },12 "summary": "支付成功"13}
# 2、回调验签与应答
商户接收到回调通知报文后,需在5秒内完成对报文的验签,并应答回调通知。
# 2.1、对回调通知进行验签
验签需使用请求头中的【Wechatpay-Timestamp】、【Wechatpay-Nonce】以及请求主体中JSON格式的通知参数构建出验签串,然后使用【Wechatpay-Serial】对应的“微信支付平台证书 (opens new window)”对验签串和【Wechatpay-Signature】进行验签,确保接收的回调内容是来自微信支付。
详细验签步骤请参考:非文件/图片下载如何验证签名 (opens new window)
微信支付会在极少数通知回调中返回以“WECHATPAY/SIGNTEST/”开头的错误【Wechatpay-Signature】,以检测商户系统是否正确验证签名。商户请参考:如何应对签名探测流量 (opens new window) 进行处理。
# 2.2、对回调通知进行应答
商户验签后,根据验签结果对回调进行应答:
验签通过:商户需告知微信支付接收回调成功,HTTP应答状态码需返回200或204,无需返回应答报文。
验签不通过:商户需告知微信支付接收回调失败,HTTP应答状态码需返回5XX或4XX,同时需返回以下应答报文:
- code 必填【返回状态码】
错误码,FAIL为回调接收失败。 - message 选填【返回信息】
返回信息,回调接收失败原因。
应答示例
1{ 2 "code": "FAIL",3 "message": "失败"4}
微信支付接收到商户的应答后,会根据应答结果做对应的逻辑处理:
若商户应答回调接收成功,微信支付后续不再发送该回调内容。若因网络或其他原因,商户收到了重复的回调通知,按正常业务流程应答即可。
若商户应答回调接收失败,或超时(5s)未应答时,微信支付会按照(15s/15s/30s/3m/10m/20m/30m/30m/30m/60m/3h/3h/3h/6h/6h)的频次重复发送回调通知,最多发送15次。
# 3、对回调通知内容进行解密
为了保证业务信息的安全性,微信支付将业务信息进行了AES-256-GCM加密,并通过参数resource将加密信息回调给商户,商户需要进行解密后才能获取到业务信息。
解密步骤如下:
- 获取商户平台上设置的APIv3密钥,记为key;
- 通过回调通知参数resource.algorithm确认加密算法(目前仅支持AEAD_AES_256_GCM,算法的接口细节,请参考:rfc5116 (opens new window))。
- 使用key与回调通知参数resource.nonce和resource.associated_data,对数据密文resource.ciphertext进行解密,最终可得到JSON格式的业务信息。
解密示例代码可参考文档:如何解密回调报文 (opens new window)
注意
- 使用Java进行回调解密,取JSON串内的参数值时,只需取引号内的内容进行解密。例:"nonce":"123",只需取值123,不用取加上引号的"123"。
resource解密后字段
- appid 必填【公众账号ID】是微信开放平台和微信公众平台为开发者的应用程序(APP、小程序、公众号)提供的一个唯一标识。 开发者需要先在微信开放平台或微信公众平台中申请ID,然后在商户平台中绑定,详见直连商户与AppID账号关联管理
。完结订单和取消订单需要和创单传入的appid保持一致。 - mchid 必填【商户号】调用支付分创单接口提交的商户号,商户号需开通支付分产品权限,且与appid有绑定关系,详见直连商户与AppID账号关联管理
。 - out_order_no 必填【商户服务订单号】 商户系统内部服务订单号,商户在创建支付分接口中填入的out_order_no参数,调用支付分查单接口时out_order_no字段和query_id字段必填一个(不允许都填写或都不填写)。
- service_id 必填【支付分服务ID】商户支付分服务的唯一标识,由32位数字组成。支付分产品权限审核通过后,微信支付运营会向商户提供该ID。
- openid 必填【用户标识】用户在商户对应appid下的唯一标识。
- state 必填
- total_amount 选填【总金额】 订单最终收款总金额,整型,单位为分,商户调用完结订单接口和修改订单金额接口传入,受服务ID风险金额上限影响,服务ID风险金额上限具体请与BD确认。
先免模式:total_amount<=创单risk_fund.amount(押金金额)<=服务ID风险金额上限。
先享模式:total_amount<=服务ID风险金额上限。
需满足计算条件:total_amount = 后付费项目金额(post_payments.amount总和) - 优惠项目金额(post_discounts.amount总和),例如商户后付费项目金额总和为10元,优惠项目金额总和为2元,则订单收款总金额为8元。 - service_introduction 必填【服务信息】用于介绍本订单所提供的服务 ,长度不能超过20个字符(汉字、数字、字母、特殊符号都按照1个字符计算)。
- post_payments 必填【后付费项目】用于展示订单后付费项目明细,商户需要按照所属行业规程传参,详见post_payments(后付费项目)字段传参说明
- 数组
- post_discounts 选填【商户优惠】用于展示订单优惠项目明细,最多30条,完结订单时传的收款总金额需满足计算条件(收款总金额=后付费项目amount和-优惠项目amount和)
- 数组
- risk_fund 必填【服务风险金】本笔订单的风险金额描述
- 属性
- time_range 必填【服务时间段】用于描述订单的服务开始和结束时间。
- 属性
- location 选填【服务位置】用于描述用户使用服务的地理位置
- 属性
- attach 选填【商户数据包】商户在创建订单时传入的自定义数据包,用户不可见。用于存放订单的商户自定义数据,需要先进行urlencode编码,总长度不超过256字符。确认订单回调和支付成功回调时会回传该字段给商户。
- order_id 选填【微信服务单号】 支付分订单在微信侧的唯一标识,31位数字,开头由1000000000+年月日组成。
- need_collection 选填【是否需要收款】订单是否需要收款,固定返回true需收款。
- notify_url 必填【商户回调地址】 商户接收确认订单成功回调和支付成功回调的地址。
- collection 选填【收款信息】订单收款信息,仅在调用完结订单后返回(若完结订单 total_amount 等于 0 元,则不返回此字段)。
- 属性
商户对resource对象进行解密后,得到的资源对象示例
1{2 "appid": "wxd678efh567hg6787", 3 "mchid": "1230000109", 4 "out_order_no": "1234323JKHDFE1243252", 5 "service_id": "500001", 6 "openid": "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o",7 "state": "DONE", 8 "total_amount": "40000", 9 "service_introduction": "嗨客餐厅用餐",10 "post_payments": [11 {12 "name": "服务费", 13 "amount": 40000, 14 "description": "每分钟1元"15 }16 ], 17 "post_discounts": [18 {19 "name": "满20减1元", 20 "amount": 1, 21 "description": "不与其他优惠叠加"22 }23 ], 24 "risk_fund": {25 "name": "ESTIMATE_ORDER_COST", 26 "amount": 10000, 27 "description": "就餐的预估费用"28 }, 29 "time_range": {30 "start_time": "20091225091010", 31 "end_time": "20091225091210"32 }, 33 "location": {34 "start_location": "嗨客时尚主题展餐厅", 35 "end_location": "嗨客时尚主题展餐厅"36 }, 37 "attach": "attach", 38 "notify_url": "https://api.test.com",39 "order_id": "165461131",40 "need_collection": true, 41 "collection": {42 "state": "USER_PAID", 43 "total_amount": 40000, 44 "paying_amount": 40000, 45 "paid_amount": 0, 46 "details": [47 { 48 "seq": 1, 49 "amount": 10000, 50 "paid_type": "MCH", 51 "paid_time": "20091225091210", 52 "transaction_id": "15646546545165651651", 53 "promotion_detail":[54 {55 "coupon_id": "123456", 56 "name": "单品优惠-6", 57 "scope": "GLOBAL", 58 "type": "CASH", 59 "amount": 100, 60 "stock_id": "activity_id", 61 "wechatpay_contribute": 100, 62 "merchant_contribute": 100, 63 "other_contribute": 0, 64 "currency": "CNY", 65 "goods_detail": [66 {67 "goods_id": "M1006", 68 "quantity": 1, 69 "unit_price": 1, 70 "discount_amount": 0, 71 "goods_remark": "商品备注信息"72 }73 ]74 }75 ]76 }77 ]78 }79}