领券事件回调通知

更新时间：2024.11.18

注意

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

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

接口说明

支持商户：【普通商户】

请求方式：【POST】

回调URL：该链接是通过【设置商家券事件通知地址API】提交notify_url参数设置，必须为HTTPS协议。如果链接无法访问，商户将无法接收到微信通知。通知URL必须为直接可访问的URL，不能携带参数。示例：“https://pay.weixin.qq.com/wxpay/pay.action”

通知规则

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

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

通知报文

领券结果通知是以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。

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格式，见示例

属性

algorithm 必填 string(32)

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

ciphertext 必填 string(1048576)

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

associated_data 选填 string(16)

附加数据

nonce 必填 string(16)

加密使用的随机串。

original_type 必填 string(64)

原始回调类型，券的原始回调类型为coupon

领券成功通知结果

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}

resource解密后字段

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 选填 object

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

属性

transaction_id 选填 string(32)

仅在支付有礼渠道，才有该信息，对应支付有礼曝光支付订单编号信息

act_code 选填 string(32)

仅在支付有礼渠道，才有该信息，对应支付有礼活动编号信息。该字段并不会和扫码领券(act_code)同时出现。

act_code 选填 string(32)

仅在扫码领券（营销馆）渠道，才有该信息，对应领券的营销馆领券活动ID信息信息。该字段并不会和支付有礼活动编码(act_code)同时出现。

hall_code 选填 string(32)

仅在扫码领券（营销馆）渠道，才有该信息，对应领券的营销馆ID信息

hall_belong_mch_id 选填 int

仅在扫码领券（营销馆）渠道，才有该信息，对应领券的营销馆所属商户号信息

card_id 选填 string(32)

仅在会员卡活动渠道，才有该信息，对应会员卡Card_ID信息

code 选填 string(32)]

仅在会员卡活动渠道，才有该信息，对应用户卡包会员卡Code信息

activity_id 选填 string(32)

仅在会员卡活动渠道，才有该信息，对应会员有礼活动ID信息

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

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":{
11    "transaction_id":"4200000462220200226114599",
12    "act_code":"540358695"
13}
14}

通知应答

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

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

BODY 包体参数

code 必填 string(32)

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

message 选填 string(256)

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

应答示例

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

文档是否有帮助

更多支持

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