核销事件回调通知

更新时间：2024.08.21

注意

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

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

# 接口说明

支持商户： 【普通商户】

请求方式： 【POST】

回调URL： 该链接是通过设置代金券消息通知地址提交notify_url设置，必须为HTTPS协议。如果链接无法访问，商户将无法接收到微信通知。通知URL必须为直接可访问的URL，不能携带参数。示例："https://pay.wechatpay.cn/wxpay/pay.action"

# 通知规则

用户使用券后，微信会把相关核销券信息发送给商户，商户需要接收处理，并按照文档规范返回应答。出于安全的考虑，我们对核销券信息数据进行了加密，商户需要先对通知数据进行解密，才能得到核销券信息数据。

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

# 通知报文

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

注意

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

# 步骤说明

# 步骤一：验证签名

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

# 步骤二：参数解密

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

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

# 字段说明

# 通知参数

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)

通知的类型，代金券用券回调通知的类型为COUPON.USE。

resource_type 必填 string(32)

通知的资源数据类型，代金券用券回调通知为encrypt-resource。

summary 必填 string(64)

回调摘要

resource 必填 object

通知资源数据

属性

核销券成功结果通知

1{ 
2     "id":"EV-2018022511223320873", 
3     "create_time":"2015-05-20T13:29:35+08:00", 
4     "resource_type":"encrypt-resource", 
5     "event_type":"COUPON.USE", 
6     "summary": "用券成功", 
7     "resource" : { 
8         "original_type": "coupon", 
9         "algorithm":"AEAD_AES_256_GCM", 
10         "ciphertext": "...", 
11         "nonce": "...", 
12         "associated_data": "", 
13     } 
14}

# resource解密后字段

stock_creator_mchid 必填 string(20)

批次创建方商户号。

stock_id 必填 string(20)

微信为每个代金券批次分配的唯一ID。

coupon_id 必填 string(20)

微信为代金券或消费金唯一分配的id。

singleitem_discount_off 选填 object

单品优惠特定信息。

属性

discount_to 选填 object

减至优惠限定字段，仅减至优惠场景有返回。

属性

coupon_name 必填 string(20)

券或消费金名称

status 必填 string(16)

券或消费金状态：
SENDED：可用
USED：已实扣
EXPIRED：已过期

description 必填 string(3000)

券或消费金描述说明字段。

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.120+08:00表示，北京时间2015年5月20日 13点29分35秒。

coupon_type 必填 string(16)

券或消费金类型：
NORMAL：满减券
CUT_TO：减至券

no_cash 必填 bool

是否无资金流。枚举值：
true：是
false：否

available_begin_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秒。

available_end_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秒。

singleitem 必填 bool

是否单品优惠。枚举值：
true：是
false：否

normal_coupon_information 选填 object

普通满减券或消费金面额、门槛信息。

属性

consume_information 选填 object

已实扣代金券或消费金信息。

属性

business_type 选填 string(256)

细分业务类型，枚举值：
MULTIUSE：消费金，仅有当business_type=MULTIUSE时，才会返回

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

1{ 
2   "stock_creator_mchid": "9800064", 
3   "stock_id": "9865888", 
4   "coupon_id": "98674556",
5   "singleitem_discount_off": { 
6     "single_price_max": 100 
7   }, 
8   "discount_to": { 
9     "cut_to_price": 100, 
10     "max_price": 10 
11   }, 
12   "coupon_name": "微信支付代金券", 
13   "status": "EXPIRED", 
14   "description": "微信支付营销", 
15   "create_time": "2015-05-20T13:29:35+08:00", 
16   "coupon_type": "CUT_TO", 
17   "no_cash": true, 
18   "available_begin_time": "2015-05-20T13:29:35+08:00", 
19   "available_end_time": "2015-05-20T13:29:35+08:00", 
20   "singleitem": true, 
21   "normal_coupon_information": { 
22     "coupon_amount": 100, 
23     "transaction_minimum": 100 
24   }, 
25   "consume_information": { 
26     "consume_time": "2015-05-20T13:29:35+08:00", 
27     "consume_mchid": "9856081", 
28     "transaction_id": "4200752501201407033233368018", 
29     "consume_amount": 50,
30     "goods_detail": [ 
31       { 
32         "goods_id": "a_goods1", 
33         "quantity": 7, 
34         "price": 1, 
35         "discount_amount": 4 
36       } 
37     ] 
38   },
39   "business_type": "MULTIUSE"
40}

# 通知应答

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

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

Body 包体参数

code 必填 string(32)

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

message 选填 string(256)

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

应答示例

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

文档是否有帮助

服务商文档

代金券参考文档

更多支持

开发者社区微信开放平台微信公众平台腾讯客服