创建商家券

更新时间:2023.08.16

商户可以通过该接口创建商家券。微信支付生成商家券批次后并返回商家券批次号给到商户,商户可调用发券接口【小程序发券】 (opens new window)【H5发券】 (opens new window)发放该批次商家券。
频率限制:接口级限制1000/min

# 接口说明

支持商户:
【普通商户】
请求方式:
【POST】/v3/marketing/busifavor/stocks
请求域名:
【主域名】
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 包体参数
  • stock_name 必填 string(21)
    【商家券批次名称】 批次名称,字数上限为21个,一个中文汉字/英文字母/数字均占用一个字数。
  • belong_merchant 必填 string(15)
    【批次归属商户号】 批次归属于哪个商户。
    注:
    普通直连模式,该参数为直连商户号;
    服务商模式,该参数为子商户号;
    间连模式,该参数为子商户号。
  • comment 选填 string(20)
    【批次备注】 仅配置商户可见,用于自定义信息。字数上限为20个,一个中文汉字/英文字母/数字均占用一个字数。
  • goods_name 必填 string(15)
    【适用商品范围】 用来描述批次在哪些商品可用,会显示在微信卡包中。字数上限为15个,一个中文汉字/英文字母/数字均占用一个字数。
  • stock_type 必填 string
    【批次类型】 批次类型
    可选取值:
    • NORMAL: 固定面额满减券批次
    • DISCOUNT: 折扣券批次
    • EXCHANGE: 换购券批次
  • coupon_use_rule 必填 CouponUseRule
    【核销规则】 券核销相关规则
    • 属性
  • stock_send_rule 必填 StockSendRule
    【发放规则】 券发放相关规则
    • 属性
  • out_request_no 必填 string(128)
    【商户请求单号】 商户创建批次凭据号(格式:商户ID+日期+流水号),商户侧需保持唯一性
  • custom_entrance 选填 CustomEntrance
    【自定义入口】 卡详情页面,可选择多种入口引导用户
    • 属性
  • display_pattern_info 选填 DisplayPatternInfo
    【样式信息】 创建批次时的样式信息。
    • 属性
  • coupon_code_mode 必填 string
    【券code模式】 特殊规则:
    1、券code模式为WECHATPAY_MODE时,是微信自动分配券code,商户不需要预存code;适用于多种场景
    2、券code模式为MERCHANT_API时,无需调用上传预存code接口,调用发券接口时需指定券code;更多用在商家自有流量场景(例如:商家自有小程序、H5网页等)
    3、券code模式为MERCHANT_UPLOAD,需要调用上传预存code接口上传code,调用发券接口时无需指定code;更多适用在微信支付平台流量场景(例如:支付有礼、支付有优惠等)
    可选取值:
    • WECHATPAY_MODE: 系统分配code,商户无需额外操作
    • MERCHANT_API: 商户发放时接口指定券code
    • MERCHANT_UPLOAD: 商户上传自定义code,发券时系统随机选取上传的券code
  • notify_config 选填 NotifyConfig
    【事件通知配置】 事件回调通知商户的配置
    • 属性
  • subsidy 选填 boolean
    【是否允许营销补差】 该批次发放的券是否允许进行补差,默认为false
    注:该字段暂未开放

请求示例

POST

# 应答参数

    200OK
  • stock_id 必填 string
    【批次号】 批次号
  • create_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

# 错误码

# 公共错误码

状态码 错误码 描述 解决方案
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 系统失败 多为网络超时引起,重试
反馈
咨询
目录