设置代金券消息通知地址

更新时间:2026.10.14
||| 安装 Skill

用于设置接收营销事件通知的URL,可接收营销相关的事件通知:核销通知

注意:该接口只能创建商户号进行设置

接口频率: 不区分来源 1000/min 单ip 5/min

幂等规则: 接口支持幂等重入

接口耗时: 100ms

接口说明

支持商户:【普通服务商】 【从业机构(银行)】 【从业机构(支付机构)】 【渠道商】 【清算机构】

请求方式:【POST】/v3/marketing/favor/callbacks

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

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

请求参数

Header  HTTP头参数

 Authorization  必填 string

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


 Accept  必填 string

请设置为application/json


 Content-Type  必填 string

请设置为application/json


body  包体参数

 mchid  必填   string(20)

【商户号】 微信支付商户号
校验规则:该商户号必须为创建商户号进行配置


 notify_url  必填   string(256)

【通知url地址】 支付通知商户url地址。
校验规则:
1、notify_url必须为https
2、地址要是一个可访问的地址
3、不能携带参数。示例: “https://pay.weixin.qq.com/wxpay/pay.action”


 switch  选填   boolean

【回调开关】 如果商户不需要再接收营销事件通知,可通过该开关关闭。
枚举值:
true:开启推送
false:停止推送
校验规则:
1、该参数设置为false暂不支持使用
2、如果想关闭通知请在商户平台关闭券的回调通知


 appid  选填   string(32)

【公众账号ID】 公众账号ID也称 AppID,是(微信开放平台、微信公众平台)为开发者提供的一个唯一标识,用于识别开发者的应用程序(APP、小程序、公众号)。开发者需要先在微信开放平台或微信公众平台中申请ID,然后在商户平台中绑定,详见:管理商户号绑定的APPID账号。

传入本字段时会更新配置,可填 AppID,也可填空串。
1、填 AppID:代金券核销通知将回传该 AppID 下的用户 openid。
2、填空串:核销通知不再生成 openid。

请求示例

curl
Java
Go

POST

1curl -X POST \
2  https://api.mch.weixin.qq.com/v3/marketing/favor/callbacks \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7    "mchid" : "9856888",
8    "notify_url" : "https://pay.weixin.qq.com",
9    "switch" : true
10  }'
11

应答参数

200 OK

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


 notify_url  必填   string

【通知地址】 通知地址


 appid  选填   string

【公众账号ID】 消息通知对应的appid,未设置时不返回;设置后原样返回appid,代金券核销通知将回传该appid下的用户openid。

应答示例

200 OK

1{
2  "update_time" : "2015-05-20T13:29:35.120+08:00",
3  "notify_url" : "api.weixin.qq.com"
4}
5

 

错误码

以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

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

400

INVALID_REQUEST

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

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

 

反馈
目录
置顶