支付成功回调通知

更新时间：2024.11.27

微信支付分通过支付成功通知接口将用户主动支付场景下的支付成功消息通知给商户。

注意

同样的通知可能会因为系统重试多次发送给商户系统。商户系统必须能够正确处理重复的通知。推荐的做法是，当商户系统收到通知进行处理时，先检查对应业务数据的状态，并判断该通知是否已经处理。如果未处理，则再进行处理；如果已处理，则直接返回结果成功。在对业务数据进行状态检查和处理之前，要采用数据锁进行并发控制，以避免函数重入造成的数据混乱。
如果在所有通知频率(通知频率为15/15/30/180/1800/1800/1800/1800/3600，单位：秒)后没有收到微信侧回调,商户应调用查询订单接口确认订单状态。

特别提醒：商户系统对于开启结果通知的内容一定要做签名验证，并校验通知的信息是否与商户侧的信息一致，防止数据泄露导致出现假通知，造成资金损失。

接口说明

支持商户：【普通服务商】

请求方式：【POST】

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

通知规则

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

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

通知报文

支付结果通知是以POST 方法访问商户设置的通知URL，通知的数据以JSON 格式通过请求主体（BODY）传输。通知的数据包括了加密的支付结果详情。

注意

由于涉及到回调加密和解密，商户必须先设置好APIv3密钥后才能解密回调通知，APIv3密钥设置文档指引详见APIv3密钥设置指引

步骤说明

步骤一：验证签名

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

步骤二：参数解密

为了保证安全性，微信支付在回调通知，对关键信息进行了AES-256-GCM加密。商户应当按照以下的流程进行解密关键信息，解密的流程：

用商户平台上设置的APIv3密钥【微信服务商平台—>账户设置—>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。微信支付使用的密钥key长度为32个字节，随机串nonce长度12个字节，associated_data长度小于16个字节并可能为空。
Java回调解密Json取值不带引号。

字段说明

通知参数

id 必填 string(36)

【通知ID】
通知的唯一ID。

create_time 必填 string(32)

【通知创建时间】
通知创建的时间，遵循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年5月20日13点29分35秒。

event_type 必填 string(32)

【通知类型】
通知的类型
用户确认成功通知的类型为PAYSCORE.USER_CONFIRM
支付成功通知的类型为PAYSCORE.USER_PAID

resource_type 必填 string(32)

【通知数据类型】
通知的资源数据类型，支付成功通知为encryptresource

resource 必填 object

【通知数据】
通知资源数据
json格式，见示例

属性

algorithm 必填 string(32)

【加密算法类型】
对授权结果数据进行加密的加密算法，目前只支持AEAD_AES_256_GCM

ciphertext 必填 string(1048576)

【数据密文】
Base64编码后的开启/停用结果数据密文

associated_data 选填 string(16)

【附加数据】
附加数据

nonce 必填 string(16)

【随机串】
加密使用的随机串

summary 必填 string(64)

【回调摘要】
回调摘要

支付成功结果通知

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}

resource解密后字段

service_id 必填 string(32)

【服务ID】
调用该接口提交的服务ID

appid 必填 string(32)

【应用ID】
调用接口提交的公众账号ID

mchid 必填 string(32)

【商户号】
调用接口提交的商户号

sub_appid 选填 string(32)

【子商户应用ID】
调用接口传入的子商户公众号ID

sub_mchid 必填 string(32)

【子商户商户号】
调用接口传入的子商户商户号

out_order_no 必填 string(32)

【商户服务订单号】
调用接口提交的商户申请绑定单号

openid 选填 string(128)

【服务商公众号下的用户标识】
微信用户在商户对应AppID下的唯一标识。（传了sub_appid的情况下则只返回sub_openid）

sub_openid 选填 string(128)

【子商户公众号下的用户标识】
微信用户在商户对应AppID下的唯一标识。（传了sub_appid的情况下则只返回sub_openid）

state 必填 string(32)

【服务订单状态】
表示当前单据状态。
枚举值：
DOING：服务订单进行中

service_introduction 必填 string(20)

【服务信息】
服务信息，用于介绍本订单所提供的服务，不超过20个字符，超出报错处理

total_amount 选填 int64

【商户收款总金额】
总金额，大于等于0的数字，单位为分，只能为整数，详见支付金额。
需满足：总金额=付费项目金额之和-商户优惠项目金额之和<=订单风险金额
未使用服务，取消订单时，该字段必须填0.

post_payments 必填 array

【后付费项目】
付费项目列表，最多包含100条付费项目

数组

name 选填 string(20)

【付费项目名称】
当参数长度超过20个字符时，报错处理

amount 选填 int64

【金额】
此付费项目总金额，大于等于0，单位为分，等于0时代表不需要扣费，只能为整数，详见支付金额。

description 选填 string(30)

【计费说明】
描述计费规则，当参数长度超过30个字符时，报错处理

count 选填 int

【付费数量】
付费项目的数量，大于等于1且小于等于100，不填默认为1

post_discounts 选填 array

【商户优惠】
商户优惠列表，最多包含5条商户优惠

数组

name 选填 string(20)

【优惠名称】
优惠名称说明

description 选填 string(30)

【优惠说明】
大于等于0的数字，单位为分

amount 选填 int64

【优惠金额】
优惠金额，只能为整数，详见支付金额。

risk_fund 必填 object

【订单风险金】
订单风险金信息

属性

name 必填 string[1,64]

【风险名称】
枚举值：
1、押金：DEPOSIT 2、预付款：ADVANCE
3、保证金：CASH_DEPOSIT
4、预估订单费用：ESTIMATE_ORDER_COST

amount 必填 int64

【风险金额】
1、整数，必须>0（单位：分）
2、风险金额≤每个服务ID的风险金额上限。
3、当商户优惠字段为空时，付费项目总金额≤风险金额（未填写金额的付费项目，视为该付费项目金额为0）

description 选填 string(30)

【风险说明】
风险说明，不超过30个字符

time_range 必填 object

服务使用时间范围

属性

start_time 必填 string(14)

【服务开始时间】
支持两种格式：“yyyyMMddHHmmss”和“yyyyMMdd”。
1、传入20091225091010表示2009年12月25日9点10分10秒
2、传入20091225默认时间为2009年12月25日
根据传入时间精准度进行校验
1、若传入时间精准到秒，则校验精准到秒。
2、若传入时间精准到日，则校验精准到日。

start_time_remark 选填 string(20)

【服务开始时间备注】
服务开始时间备注说明。
1、服务开始时间有填时，可填写服务开始时间备注，不超过20个字符，超出报错处理。

end_time 选填 string(14)

【服务结束时间】
支持两种格式：yyyyMMddHHmmss和yyyyMMdd
传入20091225091010表示2009年12月25日9点10分10秒
传入20091225默认时间为2009年12月25日
根据传入时间精准度进行校验
1、若传入时间精准到秒，则校验精准到秒。
2、若传入时间精准到日，则校验精准到日。

end_time_remark 选填 string(20)

【服务结束时间备注】
服务结束时间备注说明。
1、服务结束时间有填时，可填写服务结束时间备注，不超过20个字符，超出报错处理。

location 选填 object

服务使用位置信息

属性

start_location 选填 string(20)

【服务开始地点】
开始使用服务的地点，当参数长度超出20个字符时，报错处理。

end_location 选填 string(20)

【服务结束位置】
预计服务结束的地点，用户下单时未确认服务结束地点时，可不填写。当参数长度超出20个字符时，报错处理

attach 选填 string(256)

【商户数据包】
商户数据包可存放本订单所需信息，需要先urlencode后传入。
当商户数据包总长度超出256字符时，报错处理。

order_id 选填 string(64)

【微信支付服务订单号】
微信支付服务订单号，每个微信支付服务订单号与商户号下对应的商户服务订单号一一对应。

need_collection 选填 bool

【是否需要收款】
是否需要收款。
true：微信支付分代收款
false：无需微信支付分代收款

collection 选填 object

【收款信息】
收款信息，非0元完结后返回

属性

state 必填 string(32)

【收款状态】
枚举值：
USER_PAYING：待支付
USER_PAID：已支付

total_amount 必填 int64

【总收款金额】
总金额，大于等于0的数字，单位为分，只能为整数，详见支付金额。
此参数需满足：总金额=付费项目金额之和-商户优惠项目金额之和，且小于等于订单风险金额。取消订单时，该字段必须为0。

paying_amount 必填 int64

【待收金额】
等待用户付款金额，只能为整数，详见支付金额。

paid_amount 必填 int64

【已收金额】
用户已付款的金额，只能为整数，详见支付金额。

details 选填 array

【收款明细列表】
收款明细列表

数组

seq 选填 int

【收款序号】
从1开始递增

amount 必填 int64

【单笔收款金额】
单笔收款动作的金额，只能为整数，详见支付金额。

paid_type 选填 string(32)

【收款成功渠道】
收款成功渠道
NEWTON：微信支付分
MCH：商户渠道

paid_time 必填 string(14)

【收款成功时间】
支持两种格式:yyyyMMddHHmmss和yyyyMMdd
传入20091225091010表示2009年12月25日9点10分10秒
传入20091225默认时间为2009年12月25日0点0分0秒

transaction_id 选填 string(200)

【微信支付交易单号】
结单交易单号，等于普通支付接口中的transaction_id，可以使用该订单号在App支付->API列表->查询订单、申请退款。只有单据状态为USER_PAID，且收款成功渠道为支付分渠道，收款金额大于0，才会返回结单交易单号。

promotion_detail 选填 array

【优惠功能】
优惠功能
注：针对2020年5月27日10:00:00以后完结的订单生效。

数组

coupon_id 必填 string(32)

【券ID】
券ID

name 选填 string(64)

【优惠名称】
优惠名称

scope 选填 string(12)

【优惠范围】
GLOBAL：全场代金券；
SINGLE：单品优惠

type 选填 string(12)

【优惠类型】
枚举值：CASH：充值；
NOCASH：免充值。

amount 必填 int64

【优惠券面额】
优惠券面额

stock_id 选填 string(32)

【活动ID】
活动ID，批次ID

wechatpay_contribute 选填 int64

【微信出资】
微信出资

merchant_contribute 选填 int64

【商户出资】
商户出资

other_contribute 选填 int64

【其他出资】
其他出资

currency 选填 string(16)

【优惠币种】
CNY：人民币，境内商户号仅支持人民币

goods_detail 选填 array

【单品列表】
单品列表

数组

goods_id 必填 string(32)

【商品编码】
商品编码

quantity 选填 int

【商品数量】
商品数量

unit_price 选填 int64

【商品价格】
商品价格

discount_amount 选填 int64

【商品优惠金额】
商品优惠金额

goods_remark 选填 string(128)

【商品备注】
商品备注

对resource对象进行解密后，得到的资源对象示例

1{
2    "service_id": "500001", 
3    "appid": "wxd678efh567hg6787", 
4    "mchid": "1230000109", 
5    "sub_appid": "wxd678efh567hg6999",
6    "sub_mchid": "1900000109",
7    "out_order_no": "1234323JKHDFE1243252", 
8    "sub_openid": "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o",
9    "state": "DONE", 
10    "service_introduction": "嗨客餐厅用餐",
11    "total_amount": "40000", 
12    "post_payments": [
13        {
14            "name": "服务费", 
15            "amount": 40000, 
16            "description": "每分钟1元"
17        }
18    ], 
19    "post_discounts": [
20        {
21            "name": "满20减1元", 
22            "amount": 1, 
23            "description": "不与其他优惠叠加"
24        }
25    ], 
26    "risk_fund": {
27        "name": "预估订单费用", 
28        "amount": 10000, 
29        "description": "就餐的预估费用"
30    }, 
31    "time_range": {
32        "start_time": "20091225091010", 
33        "start_time_remark": "xxx",
34        "end_time": "20091225091210",
35        "end_time_remark": "xxx"
36    }, 
37    "location": {
38        "start_location": "嗨客时尚主题展餐厅", 
39        "end_location": "嗨客时尚主题展餐厅"
40    }, 
41    "attach": "attach", 
42    "order_id": "165461131",
43    "need_collection": true, 
44    "collection": {
45        "state": "", 
46        "total_amount": 40000, 
47        "paying_amount": 40000, 
48        "paid_amount": 0, 
49        "details": [
50            { 
51            "seq": 1, 
52            "amount": 10000, 
53            "paid_type": "MCH", 
54            "paid_time": "20091225091210", 
55            "transaction_id": "15646546545165651651", 
56            "promotion_detail":[
57                {
58                  "coupon_id": "123456", 
59                  "name": "单品优惠-6", 
60                  "scope": "GLOBAL", 
61                  "type": "CASH", 
62                  "amount": 100, 
63                  "stock_id": "activity_id", 
64                  "wechatpay_contribute": 100, 
65                  "merchant_contribute": 100, 
66                  "other_contribute": 0, 
67                  "currency": "CNY", 
68                  "goods_detail": [
69                        {
70                          "goods_id": "M1006", 
71                          "quantity": 1, 
72                          "unit_price": 1, 
73                          "discount_amount": 0, 
74                          "goods_remark": "商品备注信息", 
75                        }
76                  ]
77                }
78            ]
79              }
80        ]
81    }
82}

通知应答

接收成功： HTTP应答状态码需返回200或204，无需返回应答报文。

接收失败： HTTP应答状态码需返回5XX或4XX，同时需返回应答报文，格式如下：

BODY 包体参数

code 必填 string(32)

【返回状态码】错误码，SUCCESS为清算机构接收成功，其他错误码为失败。

message 选填 string(256)

【返回信息】返回信息，如非空，为错误原因。

应答示例

1{  
2    "code": "FAIL",
3    "message": "失败"
4}

文档是否有帮助

更多支持

开发文档(商户)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服