查询活动详情
1、修订记录
修订记录 | 日期 | 说明 |
---|---|---|
1.0 | 2022.04.14 | 初版 |
1.1 | 2024.03.20 | 新增source字段 |
2、业务说明
(1)接口说明
用于查询活动详情信息,含活动有效时间段、活动优惠总金额及次数、活动已用次数及已用金额、活动风控初始额度及已使用额度
请求主体类型:application/json
请求方式:POST
3、请求地址
环境 | HTTPS请求地址 |
---|---|
测试环境 | https://appdev.ysepay.com/openapi/ysMarket/getActivityDetails |
正式环境 | https://ysgate.ysepay.com/openapi/ysMarket/getActivityDetails |
4、请求参数说明
4.1、公共请求参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
timeStamp | String | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
method | String(128) | Y | 接口名称,固定值:ysMarket.getActivityDetails |
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.1 |
4.2、业务请求参数
(bizContent加密前的json数据明文字符串)
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
activId | String | Y | 活动编号 |
source | 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数据)
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
id | String | N | 活动编号 |
generalActivNum | String | N | 总活动编号 |
activName | String | N | 活动名称 |
startTime | String | N | 活动周期(始),yyyy-MM-dd |
endTime | String | N | 活动周期(止),yyyy-MM-dd |
dayStartTime | String | N | 活动时间(始),HH:mm:ss |
dayEndTime | String | N | 活动时间(止),HH:mm:ss |
createTime | String | N | 创建时间 |
accAmountType | String | N | 活动金额类型,活动金额类型 dicount:优惠金额,consume:消费金额 |
totleAmount | dubble | N | 总金额(元) |
totleCount | int | N | 总名额 |
availableTotalAmount | String | N | 可用总金额 |
availableTotalCount | String | N | 可用总名额 |
accmulated | Array | N | 累计额度规则 |
tempId | String | N | 特惠活动模板 |
activType | String | N | 活动类型,1子活动 2 总活动 |
partnerId | String | N | 活动出资方,合作方id |
5.2.1.1 accmulated具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
accltCycle | String | N | 周期规则,day:日,week:周,month:月,quarter:季 |
accCurrNum | int | N | 名额 |
accCurrAmount | dubble | N | 金额 |
usedCurrNum | int | N | 已用名额 |
usedAmount | dubble | N | 已用金额 |
6、业务响应码 网关公共响应码
响应码 | 响应码描述 | 解决方案 |
---|---|---|
101 | 成功 | |
201 | 失败 | 该错误都会返回具体的错误原因,请根据实际返回做相应处理 |