支付增值服务
接口列表
代金券
创建代金券批次

创建代金券批次

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

⚠️

接口错误码说明(本说明同样适用于其他代金券接口)

当响应里的 ErrCode 不为 SUCCESS 时,代表请求出现错误。 如果是微信接口返回了错误码,本系统会在原微信接口响应的错误码前面加上WechatError.前缀,如:WechatError.MCH_NOT_EXISTS。 如果是其他错误,则不会有 WechatError.前缀,请根据错误原因排查或联系收付通技术支持。 下面是一个错误响应数据,供参考:

{
  "Response": {
    "RequestId": "xxx",
    "Result": null,
    "ErrCode": "WechatError.MCH_NOT_EXISTS",
    "ErrMessage": "商户号不合法"
  }
}

接口说明

请求方式:
post
https://p.wecard.tencent.com/cloudpay/v1/favor/create-stock

请求参数

Request
Body 包体
stock_name必填
string

批次名称
校验规则:1、批次名称最多9个中文汉字2、批次名称最多20个字母3、批次名称中不能包含不当内容和特殊字符 _ , ; |
示例值:微信支付代金券批次

最小长度:1     最大长度:20

comment选填
string

仅制券商户可见,用于自定义信息。
校验规则:批次备注最多60个UTF8字符数
示例值:零售批次

最小长度:1     最大长度:60

available_begin_time必填
string

批次开始时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC8小时,即北京时间)。例如: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

最小长度:1     最大长度:32

available_end_time必填
string

批次结束时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC8小时,即北京时间)。例如: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

最小长度:1     最大长度:32

stock_use_rule必填
object

批次使用规则


pattern_info选填
object

代金券详情页


coupon_use_rule必填
object

核销规则


no_cash必填
bool

营销经费。枚举值:
true:免充值
false:预充值
1、免充值:制券方无需提前充值资金,用户核销代金券时,直接从订单原价中扣除优惠减价金额,最终只将用户实际支付的金额结算给核销商户,商户实收少于订单原价。
2、预充值:制券方需将优惠预算提前充值到微信支付商户可用余额中,用户核销代金券时,系统从制券方商户可用余额中扣除优惠减价部分对应的资金,连同用户实际支付的资金,一并结算给核销商户,不影响实收。
示例值:false


stock_type必填
string

批次类型,仅支持:
NORMAL:固定面额满减券批次

示例值:NORMAL

最小长度:1     最大长度:16

out_request_no必填
string

商户创建批次凭据号(格式:商户id+日期+流水号),可包含英文字母,数字,|,_,*,-等内容,不允许出现其他不合法符号,商户侧需保持商户单据号全局唯一。
示例值:89560002019101000121

最小长度:1     最大长度:128

ext_info选填
string

扩展属性字段,按json格式,如无需要则不填写。
该字段暂未开放
示例值:{'exinfo1':'1234','exinfo2':'3456'}

最小长度:1     最大长度:128

channel_merchant_id必填
string

请求示例

{
  "stock_name": "微信支付代金券批次",
  "comment": "零售批次",
  "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",
  "channel_merchant_id": "CM465922975711959340"
}

返回参数

Response
Response必填
object

返回示例

{
  "Response": {
    "RequestId": "948948503842433001",
    "Result": {
      "stock_id": "98065001",
      "create_time": "2015-05-20T13:29:35+08:00"
    },
    "ErrCode": "SUCCESS",
    "ErrMessage": "成功"
  }
}

腾讯微卡收付通接口文档