设置商家券事件通知地址API

最新更新时间:2019.12.20 版本说明


用于设置接收商家券相关事件通知的URL,可接收商家券相关的事件通知、包括发放通知等。需要设置接收通知的URL,并在商户平台开通营销事件推送的能力,即可接收到相关通知。


营销事件推送:点击开通产品权限。    由商家券批次创建方登录Pay平台,操作开通

注意:

• 仅可以收到由商户自己创建的批次相关的通知

• 需要设置apiv3秘钥,否则无法收到回调。

• 如果需要领券回调中的参数openid。需要创券时候传入 notify_appid参数。

接口说明

适用对象:直连商户 服务商 渠道商

请求URL:https://api.mch.weixin.qq.com/v3/marketing/busifavor/callbacks

请求方式:POST

接口规则:https://pay.weixin.qq.com/wiki/doc/apiv3/wechatpay/wechatpay-1.shtml


path 指该参数为路径参数

query 指该参数需在请求URL传参

body 指该参数需在请求JSON传参


请求参数

参数名 变量 类型[长度限制] 必填 描述
商户号 mchid string[8,15] body 微信支付商户的商户号,由微信支付生成并下发,不填默认查询调用方商户的通知URL。
示例值:10000098
通知URL地址 notify_url string[10,256] body 商户提供的用于接收商家券事件通知的url地址,必须支持https。
示例值:https://pay.weixin.qq.com

请求示例


{
  "mchid": "10000098",
  "notify_url": "https://pay.weixin.qq.com"
}
    
{
JAVA示例代码
}
    

返回参数

参数名 变量 类型[长度限制] 必填 描述
修改时间 update_time string[1,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秒。
示例值:2015-05-20T13:29:35+08:00
通知URL地址 notify_url string[10,256] 商户提供的用于接收商家券事件通知的url地址,必须支持https。
示例值:https://pay.weixin.qq.com
商户号 mchid string[8,15] 微信支付商户的商户号,由微信支付生成并下发。
示例值:10000098

返回示例


> 200 Response
{
  "update_time": "2019-05-20T13:29:35+08:00",
  "notify_url": "https://pay.weixin.qq.com",
  "mchid": "10000098"
}

    http://2323weixin.qq.com
                                

错误码公共错误码

状态码 错误码 描述 解决方案
400 PARAM_ERROR 参数错误 查看具体错误信息,调整参数
400 SYSTEM_ERROR 系统错误 请使用相同参数稍后重新调用
400 RESOURCE_ALREADY_EXISTS 批次已存在 查看out_request_no字段是否重复使用
券已被其他订单核销 请通过查询券API确认券是否已被其他订单核销
404 RESOURCE_NOT_EXISTS 查询的资源不存在 请检查查询资源的对应id是否填写正确
403 NOAUTH 无权限 查看具体错误信息,确认是否有权限
400 APPID_MCHID_NOT_MATCH appid与请求方商户无关联关系 appid与请求方商户不匹配,请确认appid与请求方商户是否有关联关系
400 MCH_NOT_EXISTS 商户号不存在 请确认传入的商户号是否正确
404 USER_NOT_EXISTS openid不正确 请确认传入的openid是否正确
500 SYSTEM_ERROR 系统失败 多为网络超时引起,重试
429 FREQUENCY_LIMITED 频率限制 调用太频繁,请降低调用接口频率
403 RULELIMIT 券不在有效期 请确认券是否能在当前时间核销
400 INVALID_REQUEST 发券模式不合法 请更换支持预上传code的批次后重试
上传的自定义code已达上限 请更换一个新的批次后重试

版本说明

关闭
V1.0
2019年12月20日
1. 设置商家券事件通知地址接口上线

技术咨询

文档反馈