用户券查询

1、修订记录

修订记录 日期 说明
1.0 2022.06.28 初稿

2、业务说明

(1)接口说明

用于查询用户券列表

请求主体类型:application/json

请求方式:POST

3、请求地址

环境 HTTPS请求地址
测试环境 https://appdev.ysepay.com/openapi/coupon/user/queryCoupon
正式环境 https://ysgate.ysepay.com/openapi/coupon/user/queryCoupon

4、请求参数说明

4.1、公共请求参数

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

参数 类型(长度) 必填 参数说明
accessSource String(20) Y 访问来源,该字段需要联系业务方进行分配。
phone String(11) N 用户手机号
couponCode String(32) N 优惠券编号
couponState String(20) N 券状态,SENDED:可用、USED:已核销、EXPIRED:已过期、INVALID:已失效
receiveTime String(25) N 领券时间,格式:yyyy-MM-dd
expireTime String(25) N 券有效期,格式:yyyy-MM-dd
useTime String(25) N 核销时间,格式:yyyy-MM-dd
pageNo int(6) N 页码,不传默认为1,传值大于0
pageSize int(4) N 每页展示大小,每页展示大小,最大100

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数据)

参数 类型(长度) 必填 参数说明
current int N 当前页
size int N 每页条数
total int N 总条数
records Array N 用户券列表

5.2.1.1 records具体参数

参数 类型(长度) 必填 参数说明
stockId String(50) N 活动编号
couponCode String(32) N 券编码
stockType String(20) N 批次类型,NORMAL:固定面额满减券批次、DISCOUNT:折扣券批次、EXCHANGE:换购券批次
couponState String(20) N 券状态,SENDED:可用、USED:已核销、EXPIRED:已过期、INVALID:已失效
expireTime String(25) N 券过期时间
receiveTime String(25) N 券领券时间
discountPercent String(10) N 折扣比例,88为八八折
discountAmount String(10) N 优惠金额,单位:元。特殊规则:取值范围 1 ≤ value ≤ 10000000
transactionMinimum String(10) N 消费门槛,单位:元,特殊规则:取值范围 1 ≤ value ≤ 10000000
useTime String(25) N 核销时间
bussType String(2) N 业务类型,1-普通券,2-代金券,3-积分券,4-石油券
phone String(11) N 领券手机号
couponChannelStat String(3) N 券渠道状态,石油渠道:00成功,01未同步,02失败

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

响应码 响应码描述 解决方案
0000 成功
B529999 操作失败
B520100 参数校验失败

results matching ""

    No results matching ""