设置商家券事件通知地址

更新时间:2024.11.18

用于设置接收商家券相关事件通知的URL,可接收商家券相关的事件通知、包括发放通知等。需要设置接收通知的URL,并在商户平台开通营销事件推送的能力,即可接收到相关通知。
营销事件推送:点击开通产品权限。由商家券批次创建方登录Pay平台,操作开通

注意

• 仅可以收到由商户自己创建的批次相关的通知
• 需要设置apiv3密钥,否则无法收到回调。
• 如果需要领券回调中的参数OpenID。需要创券时候传入notify_appid参数。

接口说明

支持商户:【普通服务商】 【渠道商】

请求方式:【POST】/v3/marketing/busifavor/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(15)

【商户号】商户号,不填默认查询调用方商户号


notify_url  必填 string(256)

【通知URL地址】商户提供的用于接收商家券事件通知的URL地址,必须支持HTTPS。

请求示例

POST

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

应答参数

200 OK

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


notify_url  必填 string(256)

【通知URL地址】商户提供的用于接收商家券事件通知的URL地址,必须支持HTTPS。


mchid  必填 string(15)

【商户号】商户号

应答示例

200 OK

1{
2  "update_time" : "2019-05-20T13:29:35+08:00",
3  "notify_url" : "https://pay.weixin.qq.com",
4  "mchid" : "98568888"
5}
6

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

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

400

INVALID_REQUEST

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

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

公共错误码

状态码

错误码

描述

解决方案

400

APPID_MCHID_NOT_MATCH

AppID与请求方商户无关联关系

AppID与请求方商户不匹配,请确认AppID与请求方商户是否有关联关系

400

INVALID_REQUEST

发券模式不合法

请更换支持预上传code的批次后重试

400

INVALID_REQUEST

上传的自定义code已达上限

请更换一个新的批次后重试

400

MCH_NOT_EXISTS

商户号不存在

请确认传入的商户号是否正确

400

RESOURCE_ALREADY_EXISTS

批次已存在

查看out_request_no字段是否重复使用

400

RESOURCE_ALREADY_EXISTS

券已被其他订单核销

请通过查询券API确认券是否已被其他订单核销

400

SYSTEM_ERROR

系统错误

请使用相同参数稍后重新调用

403

NOAUTH

无权限

查看具体错误信息,确认是否有权限

403

RULELIMIT

券不在有效期

请确认券是否能在当前时间核销

404

RESOURCE_NOT_EXISTS

查询的资源不存在

请检查查询资源的对应ID是否填写正确

404

USER_NOT_EXISTS

OpenID不正确

请确认传入的OpenID是否正确

429

FREQUENCY_LIMITED

频率限制

调用太频繁,请降低调用接口频率

500

SYSTEM_ERROR

系统失败

多为网络超时引起,重试

 

 

反馈
咨询
目录
置顶