领券事件回调通知

更新时间:2025.03.25

一、回调描述

领券完成后,微信会把相关领券结果和用户信息发送给商户,商户需要接收处理,并按照文档规范返回应答。

回调地址设置方式: 回调地址通过【设置商家券事件通知地址API 】接口中的“notify_url”参数设置,回调地址的设置规范和回调IP列表请参考文档:回调通知注意事项

注意

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

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

二、回调处理步骤

1、商户接收回调通知报文

微信支付会通过POST的方式向回调地址发送回调报文,回调通知的请求主体中会包含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年5月20日13点29分35秒。


event_type 必填 string(32)

券的回调通知类型,枚举值:
COUPON.SEND:领券


resource_type 必填 string(32)

通知的资源数据类型,券的回调通知为encrypt-resource。


summary 必填 string(64)

回调摘要


resource 必填 object

通知资源数据。 json格式,见示例

属性

请求示例

1{ 
2    "id":"8b33f79f-8869-5ae5-b41b-3c0b59f957d0",
3    "create_time":"2019-12-12T16:54:38+08:00",
4    "resource_type":"encrypt-resource",
5    "event_type":"COUPON.SEND",
6    "summary":"商家券领券通知",
7    "resource":{
8        "original_type":"coupon",
9        "algorithm":"AEAD_AES_256_GCM",
10        "ciphertext":"xxx",
11        "associated_data":"coupon",
12        "nonce":"j9g1wAzF9Xn1"
13     } 
14}

2、回调验签与应答

商户接收到回调通知报文后,需在5秒内完成对报文的验签,并应答回调通知。

2.1、对回调通知进行验签

回调报文的HTTP请求头中会包含报文的签名信息,用于验签,具体如下:

参数

描述

Wechatpay-Serial

验签的微信支付平台证书序列号/微信支付公钥ID

Wechatpay-Signature

验签的签名值

Wechatpay-Timestamp

验签的时间戳

Wechatpay-Nonce

验签的随机字符串

验签需使用请求头中的【Wechatpay-Timestamp】、【Wechatpay-Nonce】以及请求主体中JSON格式的通知参数构建出验签串,然后使用【Wechatpay-Serial】对应的微信支付平台证书/微信支付公钥对验签串和【Wechatpay-Signature】进行验签,确保接收的回调内容是来自微信支付。

商户可通过HTTP头"Wechatpay-Serial"中的证书序列号判断选择对应的证书验签,微信支付公钥的序列号固定采用"PUB_KEY_ID_数字串"格式(例如:PUB_KEY_ID_3000000001),若请求头中的序列号不符合该格式,则应使用平台证书进行验签。

详细验签步骤请参考:如何验证签名

微信支付会在极少数通知回调中返回以“WECHATPAY/SIGNTEST/”开头的错误【Wechatpay-Signature】,以检测商户系统是否正确验证签名。商户请参考:如何应对签名探测流量进行处理。

签名探测流量HTTP头中的Wechatpay-Signature示例:

1WECHATPAY/SIGNTEST/c0k+ZP6cSbveFpn0U5Bhq1Evz0A0rmmhGyuFXGqAtrlspDr3wrmaeauXJT6YYD4OmnDi767TImhRdV9hdmU0T5ZVfkOB/zka3mYthkxJ9V6UMoI
24QLGogSG1mnYjZGa6zGy1+8WInqosp0+6eBJuul55xwf3oEIpNMxAl4NL0QHr5nLfB0b0PZQSU9rZneOtDjdNtDCGEtcwV6H1eTdLpFrw2wCtiWJDw6tQwR1IfGVtdE4FK
3JQvYmOT7udgR6XfLdvzwbJsifpxvuG9q23OQF1i4PndT7AP8ykhKUEZayTrYGWdobrljFh2nu9Ng7divjg==

2.2、对回调通知进行应答

商户验签后,根据验签结果对回调进行应答:

验签通过:商户需告知微信支付接收回调成功,HTTP应答状态码需返回200或204,无需返回应答报文。

验签不通过:商户需告知微信支付接收回调失败,HTTP应答状态码需返回5XX或4XX,同时需返回以下应答报文:

code 选填 string(32)

【返回状态码】错误码,FAIL为回调接收失败。


message 选填 string(256)

【返回信息】返回信息,回调接收失败原因。

应答成功示例

200或204

1"无应答包体"

 

应答失败示例

5XX或4XX

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

 

2.3、微信支付回调处理机制说明

微信支付接收到商户的应答后,会根据应答结果做对应的逻辑处理:

  • 若商户应答回调接收成功,微信支付将不再重复发送该回调通知。若因网络或其他原因,商户收到了重复的回调通知,请按正常业务流程进行处理并应答。

  • 若商户应答回调接收失败,或超时(5s)未应答时,微信支付会按照(60s/次 - 总计11次)的频次重复发送回调通知,直至微信支付接收到商户应答成功,或达到最大发送次数(11次)

3、对回调通知内容进行解密

为了保证业务信息的安全性,微信支付将业务信息进行了AES-256-GCM加密,并通过参数resource将加密信息回调给商户,商户需要进行解密后才能获取到业务信息。

解密步骤如下:

  1. 获取商户平台上设置的APIv3密钥,设置APIv3密钥可参考文档:APIv3密钥设置方法

  2. 通过回调通知参数resource.algorithm确认加密算法(目前仅支持AEAD_AES_256_GCM,算法的接口细节,请参考:rfc5116)。

  3. 使用APIv3密钥与回调通知参数resource.nonce和resource.associated_data,对数据密文resource.ciphertext进行解密,最终可得到JSON格式的业务信息。

解密示例代码可参考文档:如何解密回调报文

注意

  • 使用Java进行回调解密,取JSON串内的参数值时,只需取引号内的内容进行解密。例:"nonce":"123",只需取值123,不用取加上引号的"123"。

 

resource中ciphertext解密后的字段

event_type 必填 string(32)

业务细分事件类型,枚举值:
EVENT_TYPE_BUSICOUPON_SEND:商家券用户领券通知


coupon_code 必填 string(32)

券的唯一标识。


stock_id 必填 string(32)

批次号


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


openid 选填 string(128)

微信用户在AppID下的唯一标识。


unionid 选填 string(128)

微信用户在同一个微信开放平台账号下的唯一用户标识,unionid获取方式请参见《UnionID机制说明》文档。


send_channel 必填 string

发放渠道,枚举值:
BUSICOUPON_SEND_CHANNEL_MINIAPP:小程序
BUSICOUPON_SEND_CHANNEL_API:API
BUSICOUPON_SEND_CHANNEL_PAYGIFT:支付有礼
BUSICOUPON_SEND_CHANNEL_H5:H5
BUSICOUPON_SEND_CHANNEL_FTOF:面对面
BUSICOUPON_SEND_CHANNEL_MEMBERCARD_ACT:会员卡活动
BUSICOUPON_SEND_CHANNEL_HALL:扫码领券(营销馆)
BUSICOUPON_SEND_CHANNEL_JSAPI:JSAPI
BUSICOUPON_SEND_CHANNEL_MINI_APP_LIVE:微信小程序直播
BUSICOUPON_SEND_CHANNEL_WECHAT_SEARCH:搜一搜
BUSICOUPON_SEND_CHANNEL_PAY_HAS_DISCOUNT:微信支付有优惠
BUSICOUPON_SEND_CHANNEL_WECHAT_AD:微信广告
BUSICOUPON_SEND_CHANNEL_RIGHTS_PLATFORM:权益平台
BUSICOUPON_SEND_CHANNEL_RECEIVE_MONEY_GIFT:收款有礼
BUSICOUPON_SEND_CHANNEL_MEMBER_PAY_RIGHT:会员付费权益
BUSICOUPON_SEND_CHANNEL_BUSI_SMART_RETAIL:智慧零售活动
BUSICOUPON_SEND_CHANNEL_FINDER_LIVEROOM:视频号直播


send_merchant 必填 string(16)

发券商户号


attach_info 选填 string

仅在支付有礼、扫码领券(营销馆)、会员有礼发放渠道,才有该信息

属性

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

1{
2  "event_type":"EVENT_TYPE_BUSICOUPON_SEND",
3  "coupon_code":"1227944959000000911017",
4  "stock_id":"1286950000000039",
5  "send_time":"2019-12-17T10:35:53+08:00",
6  "openid":"odXnH1CJjeQoWTld48db-pnxs-Wg",
7  "unionid":"oOuyajgxj0oVwjocSoQm6mp7PGKw",
8  "send_channel":"BUSICOUPON_SEND_CHANNEL_PAYGIFT",
9  "send_merchant":"98568888",
10  "attach_info":"{\"transaction_id\":\"4200000462220200226114599\",\"act_code\":\"540358695\"}"
11}