微信-创建代金券批次

1、修订记录

修订记录 日期 说明
1.0 2025.10.20 商户可以通过调用此接口创建微信支付代金券批次，包括预充值&免充值代金券；创建完成后将获得代金券批次id，将可用于各个营销场景的活动投放

2、业务说明

（1）接口说明

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

请求主体类型：application/json

请求方式：POST

3、请求地址

环境 HTTPS请求地址
测试环境 https://appdev.ysepay-test.com/openapi/ysMarket/favorCreateStocks
正式环境 https://ysgate.ysepay.com/openapi/ysMarket/favorCreateStocks

4、请求参数说明

4.1、公共请求参数

参数 类型(长度） 必填 参数说明
timeStamp String Y 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss"
method String(128) Y 接口名称，固定值：ysMarket.favorCreateStocks
charset String(10) Y 请求使用的编码格式，如utf-8,gbk,gb2312等,固定为utf-8
sign String Y 商户请求参数的签名串（签名算法默认为国密）,详见demo,注意:请用商户私钥进行签名
check String Y 银盛公钥加密随机生成的字符串（key）得到的加密值，详见demo
bizContent String Y 业务参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递。注意：需要通过AES以及随机生成的字符串（key）加密业务参数集合，得到bizContent
reqId String Y 请求唯一流水号,商户系统唯一，要求32个字符内（最少14个字符），只能是数字、大小写字母_-且在同一个商户号下唯一。最后12位要求格式为"yyMMddHHmmss" 示例值：xy1415220315145602
certId String Y 发起方商户号，服务商在银盛给自己开设的商户号，即可当作发起方商户号，由银盛生成并下发。 注意：不同于子商户号，服务商发展的商户即为子商户号
version String Y 调用的接口版本，固定为：1.0

4.2、业务请求参数

（bizContent加密前的json数据明文字符串）

参数 类型(长度） 必填 参数说明
stockName String Y 批次号名称
comment String N 批次备注
availableBeginTime String Y 可用时间-开始时间,批次开始时间，遵循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天
availableEndTime String Y 可用时间-结束时间,批次结束时间，遵循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秒。
stockUseRule Object Y 发放规则
patternInfo Object N 代金券详情页
couponUseRule Object Y 核销规则
noCash String Y 营销经费
stockType String Y 批次类型
outRequestNo String Y 商户单据号
callbackUrl String Y 活动回调地址,券核销回调地址

4.2.1 stockUseRule具体参数

参数 类型(长度） 必填 参数说明
maxCoupons int Y 发放总上限,校验规则：
 
1、发放总个数最少5个
 
2、发放总个数最多1000万个
maxAmount int Y 总预算,最大发券预算，当营销经费no_cash选择预充值false时，激活批次时会从制券商户的余额中扣除预算，请保证账户金额充足，单位：分
 
max_amount需要等于coupon_amount（面额） × max_coupons（发放总上限）
maxCouponsPerUser int Y 单个用户可领个数,活动期间每个用户可领个数，当开启了自然人限领时，多个微信号同属于一个身份证时，视为同一用户。
 
校验规则：
 
1、不能大于发放总个数
 
2、最少为1个，最多为60个
naturalPersonLimit boolean Y 是否开启自然人限制,当开启了自然人限领时，多个微信号同属于一个身份证时，视为同一用户。
 
枚举值
 
true：是
 
false：否
preventApiAbuse String Y 是否开启防刷拦截,若开启防刷拦截，当用户命中恶意、小号、机器、羊毛党、黑产等风险行为时，无法成功发放代金券。
 
枚举值
 
true：是
 
false：否
maxAmountByDay String N 单天预算发放上限

4.2.2 patternInfo具体参数

参数 类型(长度） 必填 参数说明
description String Y 使用说明,用于说明详细的活动规则，会展示在代金券详情页。
 
校验规则：最多1000个UTF8字符
merchantLogo String N 商户logo,商户logo，仅支持通过《图片上传API》接口获取的图片URL地址。1、商户logo大小需为120像素120像素。2、支持JPG/JPEG/PNG格式，且图片小于1M。3、最多128个UTF8字符
merchantName String N 品牌名称,品牌名称，展示在用户卡包
校验规则：
 
1、最多12个中文汉字
 
2、最多36个英文字符
backgroundColor String N 背景颜色,券的背景颜色，可设置14种颜色，色值请参考下方说明。颜色取值为颜色图中的颜色名称。可选枚举字段不用则不传，不可以传空值
可选取值：
  • COLOR010: 色值 #63b359
  • COLOR020: 色值 #2c9f67
  • COLOR030: 色值 #509fc9
  • COLOR040: 色值 #5885cf
  • COLOR050: 色值 #9062c0
  • COLOR060: 色值 #d09a45
  • COLOR070: 色值 #e4b138
  • COLOR080: 色值 #ee903c
  • COLOR081: 色值 #f08500
  • COLOR082: 色值 #a9d92d
  • COLOR090: 色值 #dd6549
  • COLOR100: 色值 #cc463d
  • COLOR101: 色值 #cf3e36
  • COLOR102: 色值 #5E6671
couponImage String N 券详情图片,券详情图片，850像素350像素，且图片大小不超过2M，支持JPG/PNG格式，仅支持通过《图片上传API》接口获取的图片URL地址。
jumpTarget String N 卡包跳转目标,【卡包跳转目标】枚举值：PAYMENT_CODE：跳转至微信支付付款码，点击“立即使用”跳转至微信支付付款码 MINI_PROGRAM：跳转至小程序，点击“立即使用”跳转至配置的商家小程序（需要指定小程序appid和path） DEFAULT_PAGE：跳转至默认页， 点击“立即使用”跳转至默认页面 如未传该参数，则默认跳转至默认页。
 
可选取值：
 
PAYMENT_CODE: 点击“立即使用”跳转至微信支付付款码
MINI_PROGRAM: 点击“立即使用”跳转至配置的商家小程序（需要指定小程序appid和path）
  • DEFAULT_PAGE: 点击“立即使用”跳转至默认页面
miniProgramAppid String N 小程序appid,【小程序appid】跳转的小程序appid，跳转至小程序时必填。跳转的小程序appid需至少和一个可核销商户有绑定关系。
miniProgramPath String N 小程序path,【小程序path】跳转的小程序path，跳转至小程序时必填。

4.2.3 couponUseRule具体参数

参数 类型(长度） 必填 参数说明
fixedNormalCoupon Object N 固定面额满减券使用规则
goodsTag Array N 订单优惠标记
tradeType Array N 指定支付模式
combineUse boolean N 是否可叠加其他优惠,允许指定本优惠是否可以和本商户号创建的其他券同时使用，不填则默认为：“不允许同时使用”。枚举值：true：是false：否
availableItems Array N 可核销商品编码,包含指定SKU商品编码的交易才可核销/使用代金券：活动商户在交易下单时，需传入用户购买的所有SKU商品编码，当命中代金券中设置的商品编码时可享受优惠。
 
校验规则：
 
1、单个商品编码的字符长度为【1，128】
 
2、条目个数限制为【1，50】
availableMerchants Array N 可核销商户号,可用商户的交易才可核销/使用代金券。当营销经费no_cash=false时，可用商户允许填入任何类型的特约商户或普通商户
 
当营销经费no_cash=true时，分为以下几种情况：
 
1、创建商户是普通商户或服务商特约商户(子商户)：可添加本商户号或同品牌商户。
 
说明：若可用商户中，有特约商户(子商户)，那么特约商户自己发起的交易、以及服务商帮特约商户发起的交易，都可以使用代金券。
 
2、创建商户是普通服务商：可添加已授权的子商户，详见《申请免充值代金券产品权限》。
 
说明：特约商户如果有多个服务商，那么服务商为他发起的交易，只要完成了免充值授权，都可以使用代金券；特约商户自己发起的交易不可以使用代金券。
 
3、创建商户是渠道商、银行服务商或从业机构：可直接添加旗下任意子商户，不需要子商户授权。
 
校验规则：条目个数限制为【1，50】
limitCard Object N 指定银行卡BIN

4.2.3.1 fixedNormalCoupon具体参数

参数 类型(长度） 必填 参数说明
couponAmount int N 面额,面额，单位：分。
transactionMinimum int N 门槛,使用券金额门槛，单位：分。

4.2.3.2 limitCard具体参数

参数 类型(长度） 必填 参数说明
name String N 银行卡名字,当批次指定付款方式为银行卡且配置了指定银行卡BIN，该字段必填，最多4个中文字符。并将在微信支付收银台中展示给用户。
bin Array N 银行卡BIN,当批次指定付款方式为银行卡且配置了指定银行卡BIN，该字段必填，按json格式。
 
特殊规则：单个卡BIN的字符长度为【6,9】，条目个数限制为【1,10】。

5、响应参数说明

请注意：银盛后期会对返回参数保留扩展的权力，扩展方式为新增参数但不会删除参数，请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。

5.1、公共响应参数

参数 类型(长度） 必填 参数说明
code String(5) Y 网关响应码，示例值：00000 ，详见网关公共响应码
msg String(50) Y 网关响应码描述
subCode String Y 业务响应码，参见具体的API接口文档
subMsg String Y 业务响应描述
timeStamp String Y 响应时间，格式"yyyy-MM-dd HH:mm:ss"
norce String(128) Y 随机参数
sign String Y 响应参数的签名串，详见demo,
注意:请用银盛公钥进行验签
businessData String Y 业务响应参数集合，
注意：银盛网关通过AES加密业务响应参数集合，得到businessData，商户需要对其进行解密，详情请见demo

5.2、业务响应参数

响应业务参数businessData(json数据)

参数 类型(长度） 必填 参数说明
stockId String Y 批次号
createTime String Y 创建时间,创建时间，遵循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秒。

6、业务响应码 网关公共响应码

响应码 响应码描述 解决方案
0 成功
901571999 渠道返回错误
901570200 参数校验不通过
901579999 业务系统异常
901001101 权限不足
901571100 渠道批次号变更错误
901001002 回调地址未登记

results matching ""

    No results matching ""