结算进度查询
1、修订记录
| 修订记录 | 日期 | 说明 |
|---|---|---|
| 1.0 | 2023.06.16 | 初版 |
2、业务说明
(1)接口说明
结算进度查询(只支持结算周期为T1和D1的结算进度查询)
请求主体类型:application/json
请求方式:POST
3、请求地址
| 环境 | HTTPS请求地址 |
|---|---|
| 测试环境 | https://appdev.ysepay.com/openapi/pregate/settle/progressNotOrg |
| 正式环境 | https://ysgate.ysepay.com/openapi/pregate/settle/progressNotOrg |
4、请求参数说明
4.1、公共请求参数
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| timeStamp | String | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
| method | String(128) | Y | 接口名称,固定值:pregate.settle.progressNotOrg |
| 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数据明文字符串)
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| stlBillNo | String | N | 结算单号 |
| mercIds | Array | N | 所查商户号集合,查询多个时必填,商户号个数不能大于等于1000 |
| agtMercId | String | N | 代理商商户号 |
| stlStartDate | String | N | 结算开始日期,格式:YYYYMMDD |
| stlEndDate | String | N | 结算结束日期,格式:YYYYMMDD |
| payState | String | N | 付款状态,01-未记账;02-付款中;00-付款成功;03-作废;04-付款失败;05-无需付款;06-暂缓结算;07-商户冻结算;08-记账失败;09-等待付款(记账成功);10-已退票 |
| banktype | String | N | 收款银行行别 |
| stlDt | String | N | 结算日期,格式:YYYYMMDD |
| startFactPayDate | String | N | 实际付款起始日期,格式:YYYYMMDD |
| endFactPayDate | String | N | 实际付款结束日期,格式:YYYYMMDD |
| startPayDate | String | N | 付款起始日期,格式:YYYYMMDD |
| endPayDate | String | N | 付款结束日期,格式:YYYYMMDD |
| accountNoS | String | N | 卡号密文 |
| pageNum | int | N | 当前页,最小为1 |
| pageSize | int | N | 当前页支持显示多少条记录,最大1000 |
| mercId | 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数据)
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| reqMsgId | String | N | 请求流水号 |
| currentPage | int | N | 当前页 |
| maxPage | int | N | 最大页 |
| maxRowCount | int | N | 总笔数 |
| pageSize | int | N | 总页数 |
| infos | Array | N | 结算信息列表 |
5.2.1 infos具体参数
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| mercId | String | N | 商户号 |
| payStateTime | String | N | 状态变更时间 |
| accountName | String | N | 户名 |
| banktype | String | N | 行别 |
| bankName | String | N | 银行名称 |
| payState | String | N | 付款状态,01-未记账;02-付款中;00-付款成功;03-作废;04-付款失败;05-无需付款;06-暂缓结算;07-商户冻结算;08-记账失败;09-等待付款(记账成功);10-已退票 |
| mercServiceAmt | dubble | N | 商户手续费,单位:元 |
| stlAmt | dubble | N | 结算金额,单位:元 |
| detailType | String | N | 结算单类型,01=交易款;02=调单返还;03=冻结返还;04=反交易取消;05=长款清还;06=销户结算;07=月租返还;08=请款清还;09=代理商分润;10=手续费返还;11=D+1交易款;12=调账取消;13=结转结算;14=分公司收款专用;15=直联交易款(非白名单);16=押金返还 |
| adjustAmt | String | N | 资金调整金额,单位:元 |
| accountNo | String | N | 卡号 |
| accountNoS | String | N | 加密卡号 |
| crpIdNoS | String | N | 加密身份证号 |
| stlEndDate | String | N | 清算结算日期,格式:YYYYMMDD |
| factPayDate | String | N | 实际付款日期,格式:YYYYMMDD |
| bankcode | String | N | 行号 |
| mercName | String | N | 商户名称 |
| crpIdNo | String | N | 身份证号 |
| accountType | String | N | 卡类型,11:个人借记卡,12:个人贷记卡,13:个人存折,21:对公借记卡,22:对公贷记卡,23:对公存折,00:平台内账户 |
| payAmt | dubble | N | 付款金额,单位:元 |
| accountNameS | String | N | 加密户名 |
| stlStartDate | String | N | 清算起始日期,格式:YYYYMMDD |
| accountId | String | N | 账号id |
| stlBillNo | String | N | 结算单号 |
| paySn | String | N | 结算单流水 |
| payDate | String | N | 付款日期,格式:YYYYMMDD |
| retrunCode | String | N | 返回码,入账失败编码,只有payState为失败的时候才会有返回值。 |
| retrunMsg | String | N | 返回说明,入账失败原因,只有payState为失败的时候才会有返回值。 |
6、业务响应码 网关公共响应码
| 响应码 | 响应码描述 | 解决方案 |
|---|---|---|
| 0000 | 成功 | |
| 9999 | 失败 | 系统异常,请稍后使用相同的参数继续调用 |
| 5000 | 交易超时 | 业务系统超时,请稍后使用相同的参数继续调用 |
| A029998 | 网关非法参数 | 请根据接口返回的详细信息检查请求参数 |
| B099900 | 商户不属于来源所属机构 | 检查商户所属机构是否正确。 |