创建规则
1、修订记录
修订记录 | 日期 | 说明 |
---|---|---|
1.0 | 2022.04.14 | 初版 |
2、业务说明
(1)接口说明
用于配置优惠活动的优惠力度,以及可以限制(参与活动的支付类型、活动优惠时间段、按照不同的维度限制活动的参与次数及优惠金额)
请求主体类型:application/json
请求方式:POST
3、请求地址
环境 | HTTPS请求地址 |
---|---|
测试环境 | https://appdev.ysepay.com/openapi/ysMarket/saveRuleTemp |
正式环境 | https://ysgate.ysepay.com/openapi/ysMarket/saveRuleTemp |
4、请求参数说明
4.1、公共请求参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
timeStamp | String | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
method | String(128) | Y | 接口名称,固定值:ysMarket.saveRuleTemp |
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数据明文字符串)
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
name | String(33) | Y | 规则模板名称 |
discType | String | N | 优惠对象,01:交易金额,02:手续费 ,优惠类型:交易金优惠指的是用户支付时,用户可以享受到的优惠,手续费:指的是一笔交易收取商户手续费,在商户手续费上面进行的优惠。 |
ruleType | String | N | t1优惠类型,01:满减,02:折扣:,04:一口价,10:固定费率(优惠;仅discType为02时可选):,11:固定费率(收取;仅discType为02时可选) |
d0RuleType | String | N | d0优惠类型,discType为02该优惠类型可选,01:满减,02:折扣:,04:一口价,10:固定费率(优惠;仅discType为02时可选):,11:固定费率(收取;仅discType为02时可选) |
payType | Array | N | 付款方式,0:普通刷卡,qr:扫码支付,1:Apple Pay,2:云闪付,withdraw:手动提现(discType为01时不可选);(详细配置见下方"payType配置详情") |
discounts | Array | N | 交易金额区间,至少传一条,最多可配置5条记录(详情见下方"discounts对象参数"),符合交易金额区间的,即可享受该区间的优惠额度。 |
weekCheck | Array | N | 时间规则限制(周),1-7:星期天 -星期六,可多选,按英文逗号分隔(选择即可用,没有配置默认都可用),用于限制活动可以在周几参与。 |
tradeDay | Array | N | 时间规则限制(日期),可多选,按英文逗号分隔(选择即可用,没有配置默认都可用,不能超过10个),用于限制可以参与活动开放的具体日期。 |
accRule | Array | N | 用户额度规则,额度对象\周期\金额\次数,最多5条记录(详情见下方"accRule对象参数"),可按照不同的维度来限制参与活动的金额及次数。 |
riskQuotaFlag | String | N | 用户额度余额不足时可抵扣部分优惠,是:YES,否:NO, 当本次交易优惠额度小于剩余可优惠的额度时,该配置就可以将剩余的最后的额度优惠完。 |
cardType | Array | N | 卡类型,00:借记卡,01:贷记卡,02:准贷记卡 |
cardBin | Array | N | 卡bin,银行卡的BIN号即银行标识代码,限制20个 |
qrPay | Array | N | 扫码方式,2080008:微信正扫,2080001:微信反扫,2070008:支付宝正扫,2070001:支付宝反扫,2050008:银联正扫,2050001:银联反扫,2050009:银联静态二维码,50100001:微信公众号,50100002:微信小程序,50100003:支付宝服务窗,50100004:银联行业码,50100005:微信APP支付,50100006:支付宝APP支付,50100007 |
4.2.1 discounts具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
tradeMinAmount | dubble(8) | Y | 交易金额最小值 |
tradeMaxAmount | dubble(8) | Y | 交易金额最大值,交易金额最大值 |
discount | dubble(8) | Y | t1优惠额度,ruleType为01/04时是金额(number(8,2)),ruleType为02时是折扣(折扣配置大于0小于10(number(2))),ruleType为10/11时是百分比(百分比配置大于0小于100(number(2,2))) |
d0Discount | dubble(8) | Y | d0优惠额度,(discType为02时才有)ruleType为01/04时是金额(number(8,2)),ruleType为02时是折扣(折扣配置大于0小于10(number(2))),ruleType为10/11时是百分比(百分比配置大于0小于100(number(2,2))) |
discountMaxAmount | String(8) | N | 最高优惠金额,discType为01并且ruleType为02时才能填写 |
4.2.2 accRule具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
accName | String | N | 累积规则名称,累积规则名称 |
accltObj | String | Y | 累积对象,mercid:商户,cardno:卡号,mercid|cardno:单卡|商户,mercid|payType:商户|付款方式 |
accltCycle | String | Y | 累积规则,day:日,week:周,month:月,quarter:季,active:活动 |
accOption | String | Y | 累计选项,累计对象为"mercid|payType"才有,00:借记卡,01:贷记卡,02:准贷记卡,qr:扫码,withdraw:快速提现 |
accCurrNum | int | N | 次数名额,限制次数名额(与accCurrAmount必填其一) |
accCurrAmount | dubble | N | 金额,限制金额(与accCurrNum必填其一) |
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数据)
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
tempId | String | Y | tempId,规则模板id |
6、业务响应码 网关公共响应码
响应码 | 响应码描述 | 解决方案 |
---|---|---|
101 | 成功 | |
201 | 失败 | 该错误都会返回具体的错误原因,请根据实际返回做相应处理 |