收费单列表查询
1、修订记录
| 修订记录 | 日期 | 说明 |
|---|---|---|
| 1.0 | 2024.12.20 | 收费单列表查询 |
2、业务说明
（1）接口说明
收费单列表查询
请求主体类型：application/json
请求方式：POST
3、请求地址
| 环境 | HTTPS请求地址 |
|---|---|
| 测试环境 | https://appdev.ysepay.com/openapi/cloudCharge/queryMerBillsByUfyPaygate |
| 正式环境 | https://ysgate.ysepay.com/openapi/cloudCharge/queryMerBillsByUfyPaygate |
4、请求参数说明
4.1、公共请求参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| timeStamp | String | Y | 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss" |
| method | String(128) | Y | 接口名称，固定值：cloudCharge.queryMerBillsByUfyPaygate |
| 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数据明文字符串）
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| mercId | String(20) | N | 商户号,例如，826332758120191 |
| custId | String(20) | N | 客户ID,例如，2022022621200139 |
| billType | String(1) | N | 账单分类,1：需缴费账单；2：已缴费账单 默认查所有 |
| chargeBusiness | String(2) | N | 收费项目编号,传编号 |
| chargeId | String(20) | N | 收费单号,缴费单号 |
| trmNo | String(20) | N | 终端号 |
| trmSn | String(20) | N | 终端序列号 |
| chargeStartime | String(8) | N | 创建开始时间,格式yyyyMMddHHmmss示例，20220208101010 |
| chargeEndtime | String(8) | N | 创建结束时间,格式yyyyMMddHHmmss示例，20220208121212 |
| pageNum | String(20) | Y | 页码,从1开始，默认1 |
| pageSize | int(20) | Y | 页面条数,一个页面显示多少条数据，默认10 |
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数据)
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| mercId | String(20) | Y | 商户号 |
| totalCount | int(20) | N | 总记录数 |
| totalPage | int(20) | N | 总页数 |
| currentPage | int(20) | N | 当前页 |
| currentCount | int(20) | N | 当前页记录数 |
| orderList | Array | N | 收费单列表,详见收费单明细 |
5.2.1.1 orderList具体参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| chargeId | String(30) | Y | 收费单号 |
| shouldChargeAmount | String(10) | Y | 应收金额,单位元，精确到两位小数点 |
| alredyChargeAmount | String(10) | Y | 已收金额,单位元，精确到两位小数点 |
| collectinChargeAmount | String(10) | Y | 待收金额,单位元，精确到两位小数点 |
| trmNo | String(20) | N | 终端号 |
| trmType | String(11) | N | 终端类型 |
| trmSn | String(20) | N | 终端序列号 |
| chargeBusiness | String(2) | Y | 收费项目编号 |
| chargeBusinessNm | String(20) | N | 收费项目名称,支持关键词查询 |
| billState | String(1) | Y | 账单状态 |
| lockState | String(1) | Y | 锁定状态,(1:已锁定，2：未锁定) |
| lockReason | String(1) | N | 锁定原因 |
| lockTime | String(14) | N | 锁定截止时间,yyyyMMddHHmmss |
| createTime | String(14) | N | 创建时间,yyyyMMddHHmmss |
| updateTime | String(14) | N | 最近更新时间,yyyyMMddHHmmss |
6、业务响应码 网关公共响应码
| 响应码 | 响应码描述 | 解决方案 |
|---|---|---|
| 00 | 成功 | |
| 99 | 失败 |