查询优惠流水

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/listDiscountTrade
正式环境 https://ysgate.ysepay.com/openapi/ysMarket/listDiscountTrade

4、请求参数说明

4.1、公共请求参数

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

参数 类型(长度) 必填 参数说明
startTime String Y 交易时间(起),yyyyMMdd(交易时间不支持跨月)
endTime String Y 交易时间(止),yyyyMMdd(交易时间不支持跨月)
mkSn String N 条码网关/线下/垫资流水号
mkTradestat String N 交易状态,00:成功;01:被冲正;02:处理中;99:失败;04:退款
mkStat String N 参与活动,00:参与;99:未参与;01:被冲正;04:退款;zz:异常
mkFid String N 活动编号
mercId String N 银盛商户号,由银盛支付生成并下发
upLogno String N 线上/条码交易流水号
mkPayType String N 支付方式,0:普通刷卡;1:Apple Pay;2:云闪付;online_quick:线上快捷支付;
withdraw:提现;2080008:微信正扫,2080001:微信反扫,
2070008:支付宝正扫,2070001:支付宝反扫,2050008:银联正扫,2050001:银联反扫,
2050009:银联静态二维码,online_quick:线上快捷支付,5010000
orderId String N 订单号
generalActivNum String N 总活动
mkSettledtStart String Y 会计日期(起)
mkSettledtEnd String Y 会计日期(止)
mkCardType String N 卡类型,00:借记卡,01:贷记卡,02:准贷记卡
pageNo int Y 页码
pageSize int Y 每页展示大小
mkInitiatorid String Y 合作方id
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数据)

参数 类型(长度) 必填 参数说明
current int Y 当前页
records Array Y 记录
size int Y 每页条数
total int Y 总条数

5.2.1.1 records具体参数

参数 类型(长度) 必填 参数说明
commissionAmt String N 补贴金额
couponInfo String N 优惠备注
createTimeStr String N 交易时间
d0Investor String N d0出资方,11:银行;22:分公司;33:商户;44:其他
generalActivNum String N 总活动
lineType String N 交易来源,ONLINE_QRCODE:条码/线上;REAL_TIME_PAY:垫资;withdraw:提现;OFFLINE:线下
mkAmount int N 交易金额
mkCardType String N 卡类型,00:借记卡;01:贷记卡;02:准贷记卡;03:预付费卡
mkCardno String N 卡号
mkDisamount int N 实收金额
mkDiscountType String N 活动规则,(mkRuletype为01时:01:满减;02:折扣;03:特殊优惠;04:一口价;
05:随机减;06:随机折扣;07:随机优惠;08:资金营销;09:第三方营销;
为02时:01:定额扣减;02:折扣优惠;04:顶额扣减;10:交易金百分比优惠;11:交易金百分比收取费率)
mkFee int N 手续费
mkFid String N 子活动
mkInitiator String N 合作方名称
mkInitiatorid String N 合作方号
mkMerchant String N 商户号
mkMerchname String N 商户名称
mkName String N 子活动名称
mkOrgname String N 所属机构
mkPayType String N 支付方式,(1:Apple Pay;2:云闪付;2050008:银联正扫;2050001:银联反扫;
2050009:银联静态二维码;2080008:微信正扫;2080001:微信反扫;
2080009:微信静态二维码;2070008:支付宝正扫;2070001:支付宝反扫;2070009:支付宝静态二维码;
50100001:微信公众号;50100002:微信小程序;50
mkRuletype String N 交易类型,01:优惠金优惠;02:手续费优惠
mkSettledt String N 会计日期(起)
mkSn String N 条码网关/线下/垫资流水号
mkStat String N 参与活动,00:参与;01:被冲正;99:未参与;ZZ:异常;04:退款
mkSubamount String N 优惠金额,mkTradestat不为99时取原有值;为99时取0.00
mkSubfee int N 优惠手续费
mkTradeType String N 流水类型,01或者空:消费;02:补贴;05:银联双免
mkTradestat String N 交易状态,00:成功;01:被冲正;02:处理中;99:失败;04:退款
orderId String N 订单号
reversalLogNo String N 退款/冲正流水号
t1Investor String N t1出资方
upLogno String N 线上/条码交易流水号,线上/条码交易流水号

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

响应码 响应码描述 解决方案
101 成功
201 失败 该错误都会返回具体的错误原因,请根据实际返回做相应处理

results matching ""

    No results matching ""