微信-查询批次详情

1、修订记录

修订记录 日期 说明
1.0 2025.10.20 新增批次号详情查询

2、业务说明

（1）接口说明

新增批次号详情查询

请求主体类型：application/json

请求方式：POST

3、请求地址

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

4、请求参数说明

4.1、公共请求参数

参数 类型(长度） 必填 参数说明
timeStamp String Y 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss"
method String(128) Y 接口名称，固定值：ysMarket.favorQueryStocks
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数据明文字符串）

参数 类型(长度） 必填 参数说明
stockId String Y 批次号

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 批次号
stockCreatorMchid String Y 批次创建方商户号
stockName String Y 批次名称
status String Y 状态,枚举值：
unactivated：未激活
audit：审核中
running：运行中
stoped：已停止
paused：暂停发放
createTime String Y 创建时间
description String Y 描述,批次描述信息
stockUseRule Object N 批次使用规则
availableBeginTime String N 可用开始时间
availableEndTime String N 可用结束时间
distributedCoupons int N 已发券或消费金数量
noCash boolean N 是否无资金流,枚举值：
ture：是
false：否
startTime String N 激活批次的时间
stopTime String N 终止批次的时间
cutToMessage Object N 减至批次特定信息
singleitem boolean Y 是否单品优惠,枚举值：
true：是
false：否
stockType String Y 批次类型,枚举值：
NORMAL：代金券批次
DISCOUNT_CUT：立减与折扣
OTHER：其他
cardId String N 卡包ID,微信卡包id
businessType String N 业务类型,细分业务类型，仅有当business_type=MULTIUSE时，才会返回
枚举值：
MULTIUSE：消费金
availableRegionList Array N 消费金可用地域,仅有当business_type=MULTIUSE时，才会返回
availableIndustryList Array N 消费金可用行业列表,仅有当business_type=MULTIUSE时，才会返回

5.2.1.1 stockUseRule具体参数

参数 类型(长度） 必填 参数说明
maxCoupons int N 最大发券数
maxAmount int N 总预算,总消耗金额，单位：分
maxAmountByDay int N 单天发放上限金额,单位：分
fixedNormalCoupon Object N 固定面额
maxCouponsPerUser int N 单个用户可领个数
couponType String N 券或消费金类型,枚举值：
NORMAL：满减券
CUT_TO：减至券
goodsTag Array N 订单优惠标记,(该字段暂未开放返回)
特殊规则：单个优惠标记的字符长度为【1，128】,条目个数限制为【1，50】
combineUse boolean N 是否可叠加其他优惠,枚举值：
true：是
false：否
5.2.1.1.1 fixedNormalCoupon具体参数
参数 类型(长度） 必填 参数说明
couponAmount int N 面额,单位：分
transactionMinimum int N 使用门槛,使用券金额门槛，单位：分

5.2.1.2 cutToMessage具体参数

参数 类型(长度） 必填 参数说明
singlePriceMax String Y 可用优惠的商品最高单价,单位：分
cutToPrice String Y 减至后的优惠单价,单位：分

5.2.1.3 availableRegionList具体参数

参数 类型(长度） 必填 参数说明
type String N 消费金可用地域的类型, 消费金可用地域的类型，COUNTRY表示国家级别可用，PROVINCE表示省级可用，CITY表示市级可用，DISTRICT表示区级可用。
可选取值
  • PROVINCE: 地域信息精确到省级
  • CITY: 地域信息精确到市级
  • DISTRICT: 地域信息精确到区级
  • COUNTRY: 地域信息精确到国家级
province String N 省,消费金可用省
city String N 市,消费金可用市
district String N 区,消费金可用区
country String N 国家,消费金可用国家

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

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

results matching ""

    No results matching ""