订单分页查询

1、修订记录

修订记录 日期 说明
1.0 2022.04.14 初版

2、业务说明

（1）接口说明

1、当前接口可通过订单号、支付状态、码牌编号、交易时间、支付方式、所属商户等字段来分页查询交易订单信息 2、分页返回交易订单信息

请求主体类型：application/json

请求方式：POST

3、请求地址

环境 HTTPS请求地址
测试环境 https://appdev.ysepay.com/openapi/saas_internal_api_gateway/1.0.0/qianhaiYiLian/queriesOrderByPage
正式环境 https://ysgate.ysepay.com/openapi/saas_internal_api_gateway/1.0.0/qianhaiYiLian/queriesOrderByPage

4、请求参数说明

4.1、公共请求参数

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

参数 类型(长度） 必填 参数说明
bizType String N 交易的终端设备类型：1-扫码枪; 2-乐扫精灵 3-码牌 4-POS刷卡,可用值:1,2,3,4,5
channelOrderNo String N 渠道收款订单号
codeBoardCode String N 码牌编号
merchantNo String Y 商户编号,由银盛支付生成并下发，商户系统本字段不填
operatorUser String N 收银员查询
orderNo String N 订单号
orderStatus String N 订单状态,1-待支付 2-支付中 3-支付成功 4-支付失败 5-已取消 6-部分退款 7-整单退款 8-已关闭,可用值:1,2,3,4,5,6,7,8,9
pageNo int Y 当前页
pageSize int Y 页大小
payType String N 客户使用的支付类型,1-微信支付。2-支付宝支付。3-现金支付。4-银联云闪付 5-POS刷卡支付,可用值:1,2,3,4,5,6,7,8,9
posRefNo String N pos交易单号
queryEndTime String Y 交易结束时间, 开始时间和结束时间相差不能超过1个月, 比如2020-10-01 12:09:21和,格式YYYY-MM-dd HH:mm:ss,例：2022-03-01 12:09:21
queryStartTime String Y 交易开始时间,格式YYYY-MM-dd HH:mm:ss,例：2022-03-01 12:09:21
storeNo String N 门店编号
tradeNo String N 渠道交易参考号
trmNo String N 终端号
trmOrderNo String N 终端订单号

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

参数 类型(长度） 必填 参数说明
currTime String N 时间
data Object N PageInfo«订单查询响应参数»
stackTrace String N stackTrace,系统内部错误详细信息
stackType String N 可用值:NONE,PRINT_STACK_TRACE,暂无实际用处，可用值:NONE,PRINT_STACK_TRACE

5.2.1 data具体参数

参数 类型(长度） 必填 参数说明
list Array N 订单查询响应参数
pageNo int N 当前页
pageSize int N 页大小
total int N 总条数
totalPage int N 总页数

5.2.1.1 list具体参数

参数 类型(长度） 必填 参数说明
accountTime String N 会计日期(订单状态为支付成功时返回本字段) 格式:yyyyMMdd
agentFee int N 代付手续费, 单位分
agentName String N 代理商名称
agentNo String N 代理商编号,商户所属代理商，由银盛支付生成并下发
agentOrderNo String N 代付订单号
agentPath String N 代理商编号路径
bizType String N 交易的终端设备类型：1-扫码枪; 2-乐扫精灵 3-码牌 4-POS刷卡,可用值:1,2,3,4,5
cancelTime String N 订单取消时间(yyyyMMddHHmmss)
channelOrderNo String N 渠道收款订单号
codeBoardCode String N 码牌编号
createTime String N 订单创建时间(yyyyMMddHHmmss)
goodsDetail String N 商品明细, JSON格式
goodsList Array N 商品信息
goodsNum int N 商品购买数量
id String N 订单Id
marketingRuleInfo String N 营销规则json字符串
merchantName String N 商户名称
merchantNo String N 商户号,由银盛支付生成并下发
msg String N 订单支付消息
openId String N 微信交易的用户信息
operatorUser String N 收银员
orderNo String N 订单号
orderStatus String N 订单状态 1-待支付 2-支付中 3-支付成功 4-支付失败 5-已取消 6-部分退款 7-整单退款
orderTime String N 下单时间(yyyyMMddHHmmss)
payMerchantNo String N 收款商户号
payTime String N 支付时间(yyyyMMddHHmmss)
payType String N 客户使用的支付类型1-微信支付。2-支付宝支付。3-现金支付。4-银联云闪付 5-POS刷卡支付,可
payableAmt int N 订单金额, 单位分
payedAmt int N 实付金额, 单位分
posRefNo String N pos交易单号
refundAmt int N 实退总金额, 单位分
refundableAmt int N 可退金额, 单位分
serviceFee int N 手续费, 单位分
settlementAmt int N 结算金额 单位分
settlementFlag String N 结算标志0未结算1代付结算2渠道结算,可用值:0,1,2
storeName String N 门店名称
storeNo String N 门店编号
tradeNo String N 渠道交易参考号
trmName String N 终端名称
trmNo String N 终端号
trmOrderNo String N 终端订单号
userId String N 支付宝、银联云闪付交易的用户信息
walletStatus String N 入账状态 0-初始、1-进行中、2-入账成功、3-入账失败、4-超时,可用值:0,1,2,3,4
5.2.1.1.1 goodsList具体参数
参数 类型(长度） 必填 参数说明
goodsId String N 商品id
goodsName String N 商品名称
goodsNum String N 商品购买数量
goodsType String N 商品类型:1=标准商品、2=散装商品、3=组合商品,可用值:1,2,3
goodsUnitName String N 商品单位名称
salePrice String N 商品售价, 单位分
skuId String N skuId
weigh String N 商品重量

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

响应码 响应码描述 解决方案
0 成功
101 操作失败 该错误都会返回具体的错误原因，请根据实际返回做相应处理
102 用户未登录 请登录
103 用户无权限 请联系银盛运营人员处理
104 认证失败 检查请求参数，修改后重新发起请求
105 参数校验失败 检查请求参数，修改后重新发起请求
106 请求参数校验失败 检查请求参数，修改后重新发起请求
107 服务器错误 请稍后再试或联系银盛技术人员处理
113 限流异常
114 重复请求 检查请求参数，修改后重新发起请求
115 远程调用失败

results matching ""

    No results matching ""