第三章 接口参数 - 结算管理

## 综合服务云平台-API功能模块接口 >d 接口调用细节流程: ◆ 参数RSA加密[接口签名,加解密说明](https://easydoc.xyz/doc/67068226/iYZ0vo48/tTNs8mCH) ◆ 将加密结果以及公共参数拼接成新的字符串通过MD5加密生成签名 ◆ 将公共参数以及签名通过header传输,参数加密结果通过body传输,发起http请求 ◆ 返回结果解密[接口签名,加解密说明](https://easydoc.xyz/doc/67068226/iYZ0vo48/tTNs8mCH) ## 接口响应参数都为如下固定json格式 |参数名称|参数含义|数据类型|是否必有|参数备注| |-|-|-|-|-| |resopnseType| 返回类型|int|是|无需关注此值| |errorCode|错误码 |String|是|详情参考[系统错误码](https://easydoc.xyz/doc/67068226/iYZ0vo48/KsTw3e7C)| |errorMessage| 错误信息|String|是|详情参考[系统错误码](https://easydoc.xyz/doc/67068226/iYZ0vo48/KsTw3e7C)| |status|状态码|int|是|详情参考[系统错误码](https://easydoc.xyz/doc/67068226/iYZ0vo48/KsTw3e7C)| |success|是否成功|boolean|是|true:成功 false:失败| |data|返回结果数据|String|否|只有当success为true才会有该值,该值为RSA加密值,需解密使用,解密规则请看[接口签名,加解密说明](https://easydoc.xyz/doc/67068226/iYZ0vo48/tTNs8mCH)| ## 1. 业务流程 ## 业务流程图 ![业务流程图1222.jpg](https://cos.easydoc.net/87516830/files/kj0vwglq.jpg) ## 结算状态流程图 ![结算状态流程图.jpg](https://cos.easydoc.net/87516830/files/kh1eo1e5) ## 2 发放管理 ## 2.1 结算订单提交发放接口 >d 备注:该接口所生成订单超过五天未确认发放,系统会默认清除 开发环境:https://pay-dev.lx-rhino.com 生产环境:https://api.lx-rhino.com #### 接口地址: /open/api/v1/bill/submitBill #### 请求方式:POST #### 请求参数说明: |参数名称|参数含义|是否必填|参数备注| |-|-|-|-| |payeeName|收款人姓名|是|| |payeeAccount|收款人账号|是|根据支付类型对应不同参数, 0.银行卡对应的是银行卡信息 1.支付宝对应支付宝账号 2.微信对应个人的openID| |payeeIdCard|收款人身份证号码|是|| |amount |收款金额|是|| |thirdOrderId|商户订单号|是|商户自己生成,不可重复提交| |payeePhone|收款人手机号|否|该参数用于用户接收到款短信| |payeeBankName|收款账户开户银行|否|| |payeeBankNo|收款账户开户银行联行号|否|| |thirdBizOrderId|第三方业务订单ID|否|该参数为商户自己的业务订单号,通过该订单号能够查询该笔金额来源明细| |payType|支付类型|是|支付类型该参数值填写支付类型对应数字即可 0:银行卡 1:支付宝 2:微信 |batchNo|批次号|否|由第三方自己控制哪些订单为同一个批次号,开票的时候可根据批次号开票| #### 接口响应参数data字段解密后的参数说明: |参数名称| 参数含义| 数据类型| 是否必有| 参数备注| |-|-|-|-|-| |billId| 结算平台订单号| int|是|| |thirdOrderNo| 商户提交时的订单号|String| 是|| |transNo|交易号|String| 是|| |checkStatus| 检测状态 |String|是|-1:检测失败 1:检测成功| |reason| 失败原因|String| 是|| ## 2.2 确认结算发放接口 开发环境:https://pay-dev.lx-rhino.com 生产环境:https://api.lx-rhino.com #### 接口地址: /open/api/v1/bill/sureGrant #### 请求方式:POST #### 请求参数说明: |参数名称|参数含义|是否必填|参数备注| |-|-|-|-| |billId|订单ID|是|该值由提交订单接口返回| |mainstayId|主体ID|是|该参数由[2.5查询商户可开票列表,以及所拥有的主体接口](https://easydoc.xyz/doc/67068226/iYZ0vo48/LUOpX4DM)可获的| |invoiceCode|发票编号|是|该参数由[2.5查询商户可开票列表,以及所拥有的主体接口](https://easydoc.xyz/doc/67068226/iYZ0vo48/LUOpX4DM)可获的| >d mainstayId 由签约合同的时候决定使用什么主体,签约成功新增账户后主体ID通过接口公司可开票类型,主体查询接口可获得 #### 接口响应参数data字段解密后的参数说明: |参数名称| 参数含义|数据类型| 是否必有| 参数备注| |-|-|-|-|-| |thirdOrderNo| 第三方订单号|String| 是|生成订单接口的thirdOrderId字段的值| |transNo|交易单号|String|是|支付平台交易单号| |status| 结算结果状态|String| 是|详情请参考[发放结果状态码](https://easydoc.xyz/doc/67068226/iYZ0vo48/KsTw3e7C)| |returnMsg| 返回信息|String|是| || ## 2.3 结算订单结果查询接口 开发环境:https://pay-dev.lx-rhino.com 生产环境:https://api.lx-rhino.com #### 接口地址: /open/api/v1/bill/queryResult #### 请求方式:POST #### 请求参数说明: |参数名称|参数含义|是否必填|参数备注| |-|-|-|-| |无参数名称|需要查询的商户订单号|是|例如:[商户订单号1,商户订单号2]| >d 该接口参数无需参数名称只需将商户订单号拼接处json数组即可 示例:String data = [\"orderNo1\",\"orderNo2\"... ,\"orderNo10\"]; 一次性最多查询10条记录 #### 接口响应参数data字段解密后的参数说明: |参数名称| 参数含义|数据类型| 是否必有| 参数备注| |-|-|-|-|-| |thirdOrderNo| 商户订单号|String |是|| |status| 结果状态|int| 是|详情请参考[系统错误码](https://easydoc.xyz/doc/67068226/iYZ0vo48/KsTw3e7C)| |reason| 失败原因|String|是| |支付失败才会有该值| >d该发放结果data解密后为List 集合json字符串。 结果示例 [{"thirdOrderNo":"orderNo1","status":"xx","reason":"xxxx"}, {"thirdOrderNo":"orderNo2","status":"xx","reason":"xxxx"}] ## 2.4 发放结果异步回调 解释说明: >d 该接口需要第三方自行编写提供接口到发放平台回调成功必须返回success不然会重复回调 接口编写示例跟退款回调接口说明一致 解密结果 示例如下: ```json { "status": "", "amount": "", "thirdOrderNo": "", "refundInfo": { //退款信息 如无退款的情况,以下字段均为空字符串 "refundTransNo": "", "toBankCard": "", "refundAmount": "", "refundTime": "" } } ``` |参数名称 |参数含义 |是否必有 |参数备注| |-|-|-|-| |status |发放结果状态 |是 |详情请看[发放结果状态码](https://easydoc.xyz/doc/67068226/iYZ0vo48/KsTw3e7C)| |amount |打款金额 |是 |给用户打款的金额| |thirdOrderNo |订单号 |是 |该订单号由第三方创建订单的时候填写的 |refundInfo |退款信息 |是 |但支付成功时,该对象下面的字段都为"" |refundTransNo |退款单号 |是 | |toBankCard |退款到的银行卡 |是 |在蓝犀平台开户时提供的对公账户账户 |refundAmount |退款金额 |是 |实际退款的金额 |refundTime |退款时间 |是 |时间戳精确到毫秒 ## 2.5 查询商户可开票列表、主体接口 >d 通过该接口可获取公司的可开发票列表,以及所拥有主体列表,无需频繁请求。请求到之后保存自己库即可。当签署主体信息有变更。或者发票内容有调整重新请求接口即可。 开发环境:https://pay-dev.lx-rhino.com 生产环境:https://api.lx-rhino.com #### 接口地址: /open/api/v1/company/queryInvoices #### 请求方式:POST #### 请求参数说明: |参数名称|参数含义|是否必填|参数备注| |-|-|-|-| |无参数|||该接口无需参数| #### 响应参数说明: |参数名称| 参数含义|数据类型| 是否必有| 参数备注| |-|-|-|-|-| |name| 主体名称| String|是|主体名称| |mainstayId| 主体ID|int| 是|主体ID| |taxRate| 税率|BigDecimal| 是|| |invoiceOpResponseList| 发票列表| 是|发票列表为List数组| |invoiceCode| 发票列表里面属性值发票编码|String| 是|invoiceOpResponseList里面属性| |name| 发票列表里面属性值发票名称|String| 是|invoiceOpResponseList里面属性| 解密结果示例如下: ```json [{ "invoiceOpResponseList": [{ "invoiceCode": "XXJSFWJSFWF1", //发票编码 "name": "信息技术服务,技术服务费" //发票内容 }, { "invoiceCode": "XXJSFWJSZXFWF2", "name": "信息技术服务,技术咨询服务费" }], "mainstayId": 1, //主体ID "name": "xxx" //主体名称 }, { "invoiceOpResponseList": [{ "invoiceCode": "JZZXFWZXFWF19", "name": "鉴证咨询服务,咨询服务费" }, { "invoiceCode": "JZZXFWQYGLZXF20", "name": "鉴证咨询服务,企业管理咨询费" }], "mainstayId": 2, "name": "xxx", "taxRate" : 0.050 }] ```