获取商品券事件通知地址

更新时间:2025.08.28

品牌方可以通过本接口查询商品券相关事件的回调地址,该地址配置为品牌维度配置,该品牌下的所有商品券相关事件均会通知到该地址。

前置条件:品牌已经配置商品券事件通知地址

接口说明

支持商户:【品牌商户】

请求方式:【GET】/brand/marketing/product-coupon/notify-configs

请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

     【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看

请求参数

Header  HTTP头参数

 Authorization  必填 string

请参考签名认证生成认证信息


 Accept  必填 string

请设置为application/json


 Wechatpay-Serial  必填 string

【微信支付公钥ID】  请传入brand_id对应的微信支付公钥ID,接口将会校验两者的关联关系,参考微信支付公钥产品简介及使用说明获取微信支付公钥ID和相关的介绍。以下两种场景将使用到微信支付公钥: 1、接收到接口的返回内容,需要使用微信支付公钥进行验签; 2、调用含有敏感信息参数(如姓名、身份证号码)的接口时,需要使用微信支付公钥加密敏感信息后再传输参数,加密指引请参考微信支付公钥加密敏感信息指引

请求示例

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/brand/marketing/product-coupon/notify-configs \
3  -H "Authorization: WECHATPAY-BRAND-SHA256-RSA2048 brand_id=\"XXXX\",..." \
4  -H "Accept: application/json" \
5  -H "Wechatpay-Serial: PUB_KEY_ID_XXXX"  
6

应答参数

200 OK

 notify_url  必填   string

【通知URL地址】 品牌方通过设置商品券事件通知接口设置的用于接收商品券事件通知的URL地址,原样返回


 update_time  必填   string

【更新时间】 遵循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秒。

应答示例

200 OK

1{
2  "notify_url" : "https://www.example.com/notify",
3  "update_time" : "2025-01-01T00:00+08:00"
4}
5

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

403

NO_AUTH

缺少业务相关权限

请确认已开通商品券权限

404

NOT_FOUND

未找到品牌通知配置

请确认品牌已经配置商品券事件通知地址

429

RATELIMIT_EXCEEDED

请求超过接口频率限制

请稍后使用原参数重试