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

注意

对后台通知交互时，如果微信收到应答不是成功或超时，微信认为通知失败，微信会通过一定的策略定期重新发起通知，尽可能提高通知的成功率，但微信不保证通知最终能成功

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

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

接口说明

支持商户：【普通商户】

请求方式：【POST】

回调URL：该链接是通过基础下单接口中的请求参数“notify_url”来设置的，要求必须为HTTPS地址。请确保回调URL是外部可正常访问的，且不能携带后缀参数，否则可能导致商户无法接收到微信的回调通知信息。回调URL示例："https://pay.weixin.qq.com/wxpay/pay.action"

通知规则

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

对后台通知交互时，如果微信收到商户的应答不符合规范或超时，微信认为通知失败，微信会通过一定的策略定期重新发起通知，尽可能提高通知的成功率，但微信不保证通知最终能成功。（通知频率为15s/15s/30s/3m/10m/20m/30m/30m/30m/60m/3h/3h/3h/6h/6h - 总计 24h4m）

通知报文

支付结果通知是以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取值不带引号。

字段说明

通知参数

BODY 包体参数

id 必填 string(36)

通知的唯一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年05月20日13点29分35秒。

event_type 必填 string(32)

通知的类型，支付成功通知的类型为TRANSACTION.SUCCESS。

resource_type 必填 string(32)

通知的资源数据类型，支付成功通知为encrypt-resource。

resource 必填 object

通知资源数据。

属性

algorithm 必填 string(32)

对开启结果数据进行加密的加密算法，目前只支持AEAD_AES_256_GCM。

ciphertext 必填 string(1,1048576)

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

associated_data 选填 string(16)

附加数据。

original_type 必填 string(16)

原始回调类型，为transaction。

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": "TRANSACTION.SUCCESS",
6    "summary": "支付成功",
7    "resource": {
8        "original_type": "transaction",
9        "algorithm": "AEAD_AES_256_GCM",
10        "ciphertext": "",
11        "associated_data": "",
12        "nonce": ""
13    }
14}

resource解密后字段

body 包体参数

appid 必填 string(32)

直连商户申请的公众号或移动应用AppID。

mchid 必填 string(32)

商户的商户号，由微信支付生成并下发。

out_trade_no 必填 string(32)

商户系统内部订单号，可以是数字、大小写字母_-*的任意组合且在同一个商户号下唯一。

transaction_id 必填 string(32)

微信支付系统生成的订单号。

trade_type 必填 string(16)

交易类型，枚举值：
JSAPI：公众号支付
NATIVE：扫码支付
App：App支付
MICROPAY：付款码支付
MWEB：H5支付
FACEPAY：刷脸支付

trade_state 必填 string(32)

交易状态，枚举值：
SUCCESS：支付成功
REFUND：转入退款
NOTPAY：未支付
CLOSED：已关闭
REVOKED：已撤销（付款码支付）
USERPAYING：用户支付中（付款码支付）
PAYERROR：支付失败(其他原因，如银行返回失败)

trade_state_desc 必填 string(256)

交易状态描述。

bank_type 必填 string(32)

银行类型，采用字符串类型的银行标识。银行标识请参考《银行类型对照表》。

attach 选填 string(128)

附加数据，在查询API和支付通知中原样返回，可作为自定义参数使用，实际情况下只有支付完成状态才会返回该字段。

success_time 必填 string(64)

支付完成时间，遵循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秒。

payer 必填 object

支付者信息

属性

openid 必填 string(128)

用户在直连商户AppID下的唯一标识。

amount 必填 object

订单金额信息

属性

total 必填 int

订单总金额，单位为分。

payer_total 必填 int

用户支付金额，单位为分。

currency 必填 string(16)

CNY：人民币，境内商户号仅支持人民币。

payer_currency 必填 string(16)

用户支付币种。

scene_info 选填 object

支付场景信息描述

属性

device_id 选填 string(32)

终端设备号（门店号或收银设备ID）。

promotion_detail 选填 array

优惠功能，享受优惠时返回该字段

数组

coupon_id 必填 string(32)

券ID。

name 选填 string(32)

优惠名称。

scope 选填 string(32)

优惠范围，枚举值：
GLOBAL：全场代金券
SINGLE：单品优惠。

type 选填 string(32)

优惠类型，枚举值：
CASH：充值型代金券
NOCASH：免充值型代金券

amount 必填 int

优惠券面额。

stock_id 选填 string(32)

活动ID。

wechatpay_contribute 选填 int

微信出资，单位为分。

merchant_contribute 选填 int

商户出资，单位为分。

other_contribute 选填 int

其他出资，单位为分。

currency 选填 string(16)

CNY：人民币，境内商户号仅支持人民币。

goods_detail 选填 array

单品列表信息

数组

goods_id 必填 string(32)

商品编码。

quantity 必填 int

用户购买的数量。

unit_price 必填 int

商品单价，单位为分。

discount_amount 必填 int

商品优惠金额。

goods_remark 选填 string(128)

商品备注信息。

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

1{
2    "transaction_id":"1217752501201407033233368018",
3    "amount":{
4        "payer_total":100,
5        "total":100,
6        "currency":"CNY",
7        "payer_currency":"CNY"
8    },
9    "mchid":"1230000109",
10    "trade_state":"SUCCESS",
11    "bank_type":"CMC",
12    "promotion_detail":[
13        {
14            "amount":100,
15            "wechatpay_contribute":0,
16            "coupon_id":"109519",
17            "scope":"GLOBAL",
18            "merchant_contribute":0,
19            "name":"单品惠-6",
20            "other_contribute":0,
21            "currency":"CNY",
22            "stock_id":"931386",
23            "goods_detail":[
24                {
25                    "goods_remark":"商品备注信息",
26                    "quantity":1,
27                    "discount_amount":1,
28                    "goods_id":"M1006",
29                    "unit_price":100
30                },
31                {
32                    "goods_remark":"商品备注信息",
33                    "quantity":1,
34                    "discount_amount":1,
35                    "goods_id":"M1006",
36                    "unit_price":100
37                }
38            ]
39        },
40        {
41            "amount":100,
42            "wechatpay_contribute":0,
43            "coupon_id":"109519",
44            "scope":"GLOBAL",
45            "merchant_contribute":0,
46            "name":"单品惠-6",
47            "other_contribute":0,
48            "currency":"CNY",
49            "stock_id":"931386",
50            "goods_detail":[
51                {
52                    "goods_remark":"商品备注信息",
53                    "quantity":1,
54                    "discount_amount":1,
55                    "goods_id":"M1006",
56                    "unit_price":100
57                },
58                {
59                    "goods_remark":"商品备注信息",
60                    "quantity":1,
61                    "discount_amount":1,
62                    "goods_id":"M1006",
63                    "unit_price":100
64                }
65            ]
66        }
67    ],
68    "success_time":"2018-06-08T10:34:56+08:00",
69    "payer":{
70        "openid":"oUpF8uMuAJO_M2pxb1Q9zNjWeS6o"
71    },
72    "out_trade_no":"1217752501201407033233368018",
73    "AppID":"wxd678efh567hg6787",
74    "trade_state_desc":"支付成功",
75    "trade_type":"MICROPAY",
76    "attach":"自定义数据",
77    "scene_info":{
78        "device_id":"013467007045764"
79    }
80}

通知应答

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

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

body 包体参数

code 必填 string(32)

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

message 选填 string(256)

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

应答示例

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