创建代金券批次

更新时间:2024.05.28

商户可以通过调用此接口创建微信支付代金券批次,包括预充值&免充值代金券;创建完成后将获得代金券批次id,将可用于各个营销场景的活动投放。

接口频率:单个商户号调用频率60/min,所有商户号调用频率为1000/min

接口耗时:500ms

# 接口说明

支持商户:
【普通商户】
请求方式:
【POST】/v3/marketing/favor/coupon-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(20)
    【批次名称】 批次名称
    校验规则:
    1、批次名称最多9个中文汉字
    2、批次名称最多20个字母
    3、批次名称中不能包含不当内容和特殊字符 _ , ; |
  • comment 选填 string(60)
    【批次备注】 仅配置商户可见,用于自定义信息
  • belong_merchant 必填 string(20)
    【归属商户号】 批次归属商户号
    本字段暂未开放生效,但入参时请设置为当前创建代金券商户号即不会报错,暂时不支持入参其他的商户号
  • available_begin_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秒。
    校验规则:
    1、开始时间不可早于当前时间
    2、不能创建365天后开始的批次
    3、批次可用时间范围最长为90天
  • available_end_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秒。
  • stock_use_rule 必填 object
    【发放规则】 批次使用规则
    • 属性
  • pattern_info 选填 object
    【代金券详情页】 代金券详情页
    • 属性
  • coupon_use_rule 必填 object
    【核销规则】
    • 属性
  • no_cash 必填 boolean
    【营销经费】 营销经费。
    枚举值:
    true:免充值
    false:预充值
    1、免充值:制券方无需提前充值资金,用户核销代金券时,直接从订单原价中扣除优惠减价金额,最终只将用户实际支付的金额结算给核销商户,商户实收少于订单原价。
    2、预充值:制券方需将优惠预算提前充值到微信支付商户可用余额中,用户核销代金券时,系统从制券方商户可用余额中扣除优惠减价部分对应的资金,连同用户实际支付的资金,一并结算给核销商户,不影响实收。
  • stock_type 必填 string(16)
    【批次类型】 批次类型,仅支持:
    NORMAL:固定面额满减券批次
  • out_request_no 必填 string(128)
    【商户单据号】 商户创建批次凭据号(格式:商户id+日期+流水号),可包含英文字母,数字,|,_,*,-等内容,不允许出现其他不合法符号,商户侧需保持商户单据号全局唯一。
  • ext_info 选填 string(128)
    【扩展属性】 扩展属性字段,按json格式,如无需要则不填写。
    该字段暂未开放

请求示例

POST

# 应答参数

    200OK
  • stock_id 必填 string
    【批次号】 微信为每个代金券批次分配的唯一ID。
  • 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后重试
400 INVALID_REQUEST OpenID与AppID不匹配 请使用AppID下的OpenID
400 INVALID_REQUEST 活动已结束或未激活 请检查批次状态
400 INVALID_REQUEST 非法的商户号 请检查商户号是否正确
400 MCH_NOT_EXISTS 商户号不合法 请输入正确的商户号
400 PARAM_ERROR 回调URL不能为空 请填写回调URL
400 PARAM_ERROR 回调商户不能为空 请填写回调商户
400 PARAM_ERROR 券ID必填 请填写券ID
400 PARAM_ERROR AppID必填 请输入AppID
400 PARAM_ERROR OpenID必填 请输入OpenID
400 PARAM_ERROR 页大小超过阈值 请不要超过最大的页大小
400 PARAM_ERROR 输入时间格式错误 请输入正确的时间格式
400 PARAM_ERROR 批次号必填 请输入批次号
400 PARAM_ERROR 商户号必填 请输入商户号
400 PARAM_ERROR 非法的批次状态 请检查批次状态
403 NO_AUTH 你配置的信息需要开通特殊权限 请参考:QA方案 (opens new window)
403 NOT_ENOUGH 批次预算不足 请补充预算
403 REQUEST_BLOCKED 调用商户无权限 请开通产品权限后再调用该接口
403 REQUEST_BLOCKED 商户无权发券 调用接口的商户号无权发券,请检查是否是自己的批次或是已授权的批次。
403 REQUEST_BLOCKED 批次不支持跨商户发券 该批次未做跨商户号的授权,请授权后再发放
403 REQUEST_BLOCKED 用户被限领拦截 用户领取已经达到上限,请调高上限或停止发放。
403 REQUEST_BLOCKED 活动未开始或已结束 该活动未开始或已结束
403 USER_ACCOUNT_ABNORMAL 用户非法 该用户账号异常,无法领券。商家可联系微信支付或让用户联系微信支付客服处理。
404 RESOURCE_NOT_EXISTS 批次不存在 请检查批次ID是否正确
429 FREQUENCY_LIMITED 请求过于频繁 稍后重试
反馈
咨询
目录