创建代金券批次API
最新更新时间：2021.11.11 版本说明
服务商可以通过调用此接口创建微信支付代金券批次，包括预充值&免充值代金券；创建完成后将获得代金券批次id，将可用于各个营销场景的活动投放。
接口说明
适用对象： 服务商
请求URL：https://api.mch.weixin.qq.com/v3/marketing/favor/coupon-stocks
请求方式：POST
接口频率：单个商户号调用频率60/min，所有商户号调用频率为1000/min
接口耗时：80ms
path指该参数为路径参数
query 指该参数需在请求URL传参
body 指该参数需在请求JSON传参
请求参数
| 参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 批次名称 | stock_name | string[1,20] | 是 | body 批次名称 校验规则： 1、批次名称最多9个中文汉字 2、批次名称最多20个字母 3、批次名称中不能包含不当内容和特殊字符 _ , ; | 示例值：微信支付代金券批次 |
| 批次备注 | comment | string[1,60] | 否 | body 仅制券商户可见，用于自定义信息。 校验规则：批次备注最多60个UTF8字符数 示例值：零售批次 |
| 归属商户号 | belong_merchant | string[1,20] | 是 | body 批次归属商户号 本字段暂未开放生效，但入参时请设置为当前创建代金券商户号即不会报错，暂时不支持入参其他的商户号 示例值：98568865 |
| 可用时间-开始时间 | available_begin_time | string[1,32] | 是 | body 批次开始时间，遵循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天 示例值：2015-05-20T13:29:35+08:00 |
| 可用时间-结束时间 | available_end_time | string[1,32] | 是 | body 批次结束时间，遵循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、可用时间最长为90天 3、有效时间间隔最短为1s 示例值：2015-05-20T13:29:35+08:00 |
| +发放规则 | stock_use_rule | object | 是 | body 批次使用规则 |
| +样式设置 | pattern_info | object | 否 | body 代金券详情页 |
| +核销规则 | coupon_use_rule | object | 是 | body 核销规则 |
| 营销经费 | no_cash | bool | 是 | body 营销经费。枚举值： |
| 批次类型 | stock_type | string[1,16] | 是 | body 批次类型，仅支持： |
| 商户单据号 | out_request_no | string[1,128] | 是 | body 商户创建批次凭据号（格式：商户id+日期+流水号），可包含英文字母，数字，|，_，*，-等内容，不允许出现其他不合法符号，商户侧需保持商户单据号全局唯一。 示例值：89560002019101000121 |
| 扩展属性 | ext_info | string[1,128] | 否 | body 扩展属性字段，按json格式，如无需要则不填写。 该字段暂未开放 示例值：{'exinfo1':'1234','exinfo2':'3456'} |
卡券背景颜色图
请求示例
{
"stock_name": "微信支付代金券批次",
"comment": "零售批次",
"belong_merchant": "98568865",
"available_begin_time": "2015-05-20T13:29:35+08:00",
"available_end_time": "2015-05-20T13:29:35+08:00",
"stock_use_rule": {
"max_coupons": 100,
"max_amount": 5000,
"max_amount_by_day": 400,
"max_coupons_per_user": 3,
"natural_person_limit": false,
"prevent_api_abuse": false
},
"pattern_info": {
"description": "微信支付营销代金券",
"merchant_logo": "https://qpic.cn/xxx",
"merchant_name": "微信支付",
"background_color": "COLOR020",
"coupon_image": "https://qpic.cn/xxx"
},
"coupon_use_rule": {
"fixed_normal_coupon": {
"coupon_amount": 50,
"transaction_minimum": 100
},
"goods_tag": [
"123321",
"123322"
],
"trade_type": ["OTHER","APPPAY"],
"combine_use": false,
"available_items": [
"123321",
"123322"
],
"available_merchants": [
"9856000",
"9856001"
]
},
"no_cash": false,
"stock_type": "NORMAL",
"out_request_no": "89560002019101000121"
}
返回参数
| 参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 批次号 | stock_id | string[1,20] | 是 | 微信为每个代金券批次分配的唯一ID。 示例值：98065001 |
| 创建时间 | create_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 |
返回示例
{
"stock_id": "98065001",
"create_time": "2015-05-20T13:29:35+08:00"
}
错误码公共错误码
| 状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
| 400 | PARAM_ERROR | 回调url不能为空 | 请填写回调url |
| PARAM_ERROR | 回调商户不能为空 | 请填写回调商户 | |
| PARAM_ERROR | 券id必填 | 请填写券id | |
| PARAM_ERROR | appid必填 | 请输入appid | |
| PARAM_ERROR | openid必填 | 请输入openid | |
| PARAM_ERROR | 页大小超过阈值 | 请不要超过最大的页大小 | |
| PARAM_ERROR | 输入时间格式错误 | 请输入正确的时间格式 | |
| PARAM_ERROR | 批次号必填 | 请输入批次号 | |
| PARAM_ERROR | 商户号必填 | 请输入商户号 | |
| PARAM_ERROR | 非法的批次状态 | 请检查批次状态 | |
| 400 | MCH_NOT_EXISTS | 商户号不合法 | 请输入正确的商户号 |
| 400 | INVALID_REQUEST | openid与appid不匹配 | 请使用appid下的openid |
| INVALID_REQUEST | 活动已结束或未激活 | 请检查批次状态 | |
| INVALID_REQUEST | 非法的商户号 | 请检查商户号是否正确 | |
| 400 | APPID_MCHID_NOT_MATCH | 商户号与appid不匹配 | 请绑定调用接口的商户号和appid后重试 |
| 403 | USER_ACCOUNT_ABNORMAL | 用户非法 | 该用户账号异常，无法领券。商家可联系微信支付或让用户联系微信支付客服处理。 |
| 403 | NOT_ENOUGH | 批次预算不足 | 请补充预算 |
| 403 | REQUEST_BLOCKED | 调用商户无权限 | 请开通产品权限后再调用该接口 |
| REQUEST_BLOCKED | 商户无权发券 | 调用接口的商户号无权发券，请检查是否是自己的批次或是已授权的批次。 | |
| REQUEST_BLOCKED | 批次不支持跨商户发券 | 该批次未做跨商户号的授权，请授权后再发放 | |
| REQUEST_BLOCKED | 用户被限领拦截 | 用户领取已经达到上限，请调高上限或停止发放。 | |
| 404 | RESOURCE_NOT_EXISTS | 批次不存在 | 请检查批次ID是否正确 |
| 429 | FREQUENCY_LIMIT_EXCEED | 接口限频 | 请降低调用频率 |
| 403 | NO_AUTH | 你配置的信息需要开通特殊权限 | 请参考：QA方案 |
| 403 | REQUEST_BLOCKED | 活动未开始或已结束 | 该活动未开始或已结束 |