商品券回调通知
更新时间:2025.08.21一、回调描述
用户商品券发放成功后,微信支付会将相关领券结果与用户信息发送给品牌方,品牌方需要接收处理,在品牌侧内部系统为用户发放同样的券。品牌侧发券完成后,还需要调用【确认发放用户商品券】接口进行确认。
回调地址设置方式: 回调地址通过【设置商品券事件通知地址】接口中的 notify_url
参数设置,回调地址的设置规范请参考文档: 回调通知注意事项 。
|
二、回调处理步骤
1、服务商接收回调通知报文
微信支付会通过POST的方式向回调地址发送回调报文,回调通知的请求主体中会包含JSON格式的通知参数,具体的通知参数列表如下:
通知参数
id 必填 string(36)
【通知ID】通知的唯一ID。
create_time 必填 string(32)
【通知创建时间】通知创建的时间,遵循RFC3339标准格式(如:2015-05-20T13:29:35+08:00)。
event_type 必填 string(32)
【通知类型】商品券回调通知类型,枚举值:
PRODUCT_COUPON_SP.SEND:商品券领券通知
resource_type 必填 string(32)
【通知数据类型】通知的资源数据类型,为encrypt-resource。
resource 必填 object
【通知资源数据】通知资源数据。
属性 | |
summary 必填 string(64)
【回调摘要】回调摘要
商品券通知
2、回调验签与应答
服务商接收到回调通知报文后,需在5秒内完成对报文的验签,并应答回调通知。
2.1、对回调通知进行验签
回调报文的HTTP请求头中会包含报文的签名信息,用于后续验签,具体如下:
参数 | 描述 |
---|---|
Wechatpay-Serial | |
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示例:
2.2、对回调通知进行应答
服务商验签后,根据验签结果对回调进行应答:
验签通过:服务商需告知微信支付接收回调成功,HTTP应答状态码需返回200或204,无需返回应答报文。
验签不通过:服务商需告知微信支付接收回调失败,HTTP应答状态码需返回5XX或4XX,同时需返回以下应答报文:
code 选填 string(32)
【返回状态码】服务商验签不通过时返回FAIL,代表回调接收失败。
message 选填 string(256)
【返回信息】返回信息,回调接收失败原因。
应答成功示例
200或204
应答失败示例
5XX或4XX
2.3、微信支付回调处理机制说明
微信支付接收到商户的应答后,会根据应答结果做对应的逻辑处理:
若商户应答回调接收成功,微信支付将不再重复发送该回调通知。若因网络或其他原因,商户收到了重复的回调通知,请做好重入设计并持续应答200
2.3、微信支付回调处理机制说明
微信支付接收到商户的应答后,会根据应答结果做对应的逻辑处理:
若商户应答回调接收成功,微信支付将不再重复发送该回调通知。若因网络或其他原因,商户收到了重复的回调通知,请按正常业务流程进行处理并应答。
对后台通知交互时,如果微信收到应答不是成功或超时,微信认为通知失败,微信会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但微信不保证通知最终能成功。(通知频率为每隔60秒重试一次,最多重试11次)
3、对回调通知内容进行解密
为了保证业务信息的安全性,微信支付将业务信息进行了AES-256-GCM加密,并通过参数resource将加密信息回调给服务商,服务商需要进行解密后才能获取到业务信息。
解密步骤如下:
获取服务商平台上设置的APIv3密钥,设置APIv3密钥可参考文档:APIv3密钥设置方法;
通过回调通知参数resource.algorithm确认加密算法(目前仅支持AEAD_AES_256_GCM,算法的接口细节,请参考:rfc5116)。
使用APIv3密钥与回调通知参数resource.nonce和resource.associated_data,对数据密文resource.ciphertext进行解密,最终可得到JSON格式的业务信息。
解密示例代码可参考文档:如何解密回调报文
注意
使用Java进行回调解密,取JSON串内的参数值时,只需取引号内的内容进行解密。例:"nonce":"123",只需取值123,不用取加上引号的"123"。
resource中ciphertext解密后字段
coupon_code 必填 string(32)
【用户券Code】 用户商品券的唯一标识,用户领取商品券后分配的Code
brand_id 必填 string(40)
【品牌ID】 商品券归属品牌的唯一标识,由微信支付生成
product_coupon_id 必填 string(40)
【商品券ID】 该用户券对应的商品券的唯一标识,由微信支付生成
stock_id 必填 string(40)
【商品券批次ID】 该用户券发券时使用的批次的唯一标识,由微信支付生成
appid 必填 string
【事件通知AppID】 品牌方在商品券批次中配置的 notify_config.notify_appid
字段,用于计算本通知的用户 OpenID
openid 必填 string
【用户OpenID】 领券用户在AppID下的唯一标识
unionid 必填 string
【用户UnionID】 领券用户在AppID所属微信开放平台账号下的唯一用户标识,详见《UnionID机制说明》
receive_time 必填 string
【领券时间】 用户领券时间。遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)
send_request_no 必填 string
【发券请求单号】 发券时传入的请求流水号
send_channel 必填 string
【发券渠道】 描述用户券是经由什么渠道发送的
可选取值
API
: 品牌方自主发放,品牌方调用发券接口自行发放BRAND_MANAGE
: 摇一摇有优惠,通过摇一摇有优惠渠道发放MERCHANT_CARD
: 名片优惠,通过名片优惠渠道发放MEMBER
: 会员优惠,通过会员优惠渠道发放
attach 选填 string
【自定义附加信息】调用发券接口时品牌方使用 attach
字段主动设置的附加信息。微信支付不会解析该信息,原样返回。
注: 发券渠道多样,只有服务商通过发券接口发放的券( send_channel
为 API
)才会在携带此字段,其他渠道发放的券 attach
为空。
channel_custom_info 选填 string
【渠道自定义信息】使用微信支付提供的其他渠道(比如「摇一摇有优惠」)发放商品券时,渠道可能会设置该渠道特定的自定义信息,请根据 send_channel
字段判断如何解析本字段。不同渠道的自定义信息格式不同,请根据对应渠道的文档解析。
对resource中ciphertext进行解密后,得到的资源对象示例