2.订单接口文档

## 2.1.提交订单接口 开发环境:https://pay-dev.lx-rhino.com 生产环境:https://api.lx-rhino.com #### 接口地址: /open/api/v1/qs/bill/submitBill #### 请求方式:POST #### 请求参数说明: |参数名称|参数含义|数据类型|是否必填|参数备注| |-|-|-|-|-| |payeeName|收款人姓名|String|是|| |payeeAccount|收款账户|String|是|| |payeeIdCard|收款人身份证号码|String|是|| |amount |收款金额|String|是|收款金额必须为数字| |payeePhone|收款人手机号|String|否|该参数用于用户接收到款短信| |thirdOrderId|商户订单号|String|是|商户自己生成,不可重复提交| |thirdBizOrderId|第三方业务订单ID|String|否|该参数为商户自己的业务订单号,通过该订单号能够查询该笔金额来源明细| |payType|支付类型|int|否|支付类型该参数值填写支付类型对应数字即可 0:银行卡| |mainstayId|主体ID|Long|是|该参数由[4.查询轻税发票信息以及主体信息接口可获的]()| |invoiceCode|发票编码|String|是|该参数由[4.查询轻税发票信息以及主体信息接口可获的]()| |remark|备注|String|否|备注字数不可超过32个字符| |transName|转账备注|String|否|备注字数不可超过20个字符| #### 接口响应参数data字段解密后的参数说明: |参数名称| 参数含义| 数据类型| 是否必有| 参数备注| |-|-|-|-|-| |billNo| 订单号|String|是|[发放结果码对照表](doc:jcSiyTv1)| |billStatus| 发放平台订单状态|int|是|| |actualAmount| 结算金额(实际个人所得额)|BigDecimal|是|| |valueAddedTaxAmount|增值税|BigDecimal|是|| |additionalTaxAmount|附加税|BigDecimal|是|| |personIncomeTaxAmount|个税|BigDecimal|是|| |contractTaxAmount|服务费(合同税费)|BigDecimal|是|轻税方式选择是税后,则为0| |paymentAmount|实际打款金额(需要扣除的费用)|BigDecimal|是|| ## 2.2.1.确认发放接口 开发环境:https://pay-dev.lx-rhino.com 生产环境:https://api.lx-rhino.com #### 接口地址: /open/api/v1/qs/bill/sureGrant #### 请求方式:POST #### 请求参数说明: |参数名称|参数含义|数据类型|是否必填|参数备注| |-|-|-|-|-| |billNo|订单号|String|是|该值由提交订单接口返回| |settlementCertUrl|结算证明|String|是|该参数由[5.提交结算证明接口可获的]()| #### 接口响应参数data字段解密后的参数说明: |参数名称| 参数含义|数据类型| 是否必有| 参数备注| |-|-|-|-|-| |thirdOrderNo| 第三方订单号|String| 是|生成订单接口的thirdOrderId字段的值| |itemStatus| 发放结果状态|int| 是|详情请参考[发放结果状态码](doc:jcSiyTv1)| |billNo| 订单号|String|是| || ## 2.2.2.发放成功异步回调 >d 该接口需要第三方自行编写提供接口到发放平台回调成功必须返回success不然会重复回调 接口编写示例跟5.3 充值回调接口说明一致 解密结果示例如下: ```json {"billNo":"xxx","thirdOrderNo":"xxx","status":1,"itemStatus":1,"amount":"100.0","paymentTime":"xxx","reason":"xxxx","returnMsg":"xx","personIncomeTaxAmount":"0.01","valueAddedTaxAmount":"0.01","additionalTaxAmount":"0.01","contractTaxAmount":"0.01"} ``` |参数名称| 参数含义|数据类型| 是否必有| 参数备注| |-|-|-|-|-| |billNo| 平台订单号|String |是|平台订单号| |thirdOrderNo| 商户订单号|String |是|商户第三方订单号| |itemStatus| 结果状态|int| 是|详情请参考 [2. 结算明细订单状态状态码](https://easydoc.net/doc/75132717/8V9YDbr8/6Riyzg63)| |amount|结算金额|String|是|提交的金额| |paymentTime|发放时间|String|否|确认发放后才有,确认发放时间| |reason| 失败原因|String|是|支付失败才会有该值| |personIncomeTaxAmount|个税|String|否|直营模式才会有该值| |valueAddedTaxAmount|增值税|String|否|直营模式才会有该值| |additionalTaxAmount|附加税|String|否|直营模式才会有该值| |contractTaxAmount|服务费|String|否|直营模式才会有该值| ## 2.3.发放结果查询接口 开发环境:https://pay-dev.lx-rhino.com 生产环境:https://api.lx-rhino.com #### 接口地址: /open/api/v1/qs/bill/queryResult #### 请求方式:POST #### 请求参数说明: |参数名称|参数含义|数据类型|是否必填|参数备注| |-|-|-|-|-| |无参数名称|需要查询的商户订单号|Array|是|例如:[商户订单号1,商户订单号2]| >d 该接口参数无需参数名称只需将商户订单号拼接处json数组即可 示例:String data = [\"xxx\",\"xxx\"... ,\"xxx\"]; 一次性最多查询10条记录 #### 接口响应参数data字段解密后的参数说明: |参数名称| 参数含义|数据类型| 是否必有| 参数备注| |-|-|-|-|-| |billNo| 平台订单号|String |是|平台订单号| |thirdOrderNo| 商户订单号|String |是|三方订单号| |status| 结果状态|int| 是|老字段,已废弃,请对接itemStatus| |itemStatus| 结果状态|int| 是|详情请参考[系统错误码](doc:jcSiyTv1)| |amount|结算金额|String|是|提交的金额| |paymentTime|发放时间|String|否|确认发放后才有| |reason| 失败原因|String|是|支付失败才会有该值| |returnMsg| 失败原因|String|是|老字段,已废弃,请对接reason| |personIncomeTaxAmount|个税|String|否|直营才会有该值| |valueAddedTaxAmount|增值税|String|否|直营才会有该值| |additionalTaxAmount|附加税|String|否|直营才会有该值| |contractTaxAmount|服务费|String|否|直营才会有该值| >d该发放结果data解密后为List 集合json字符串。 结果示例 [{"billNo":"xxx","thirdOrderNo":"xxx","status":1,"itemStatus":1,"amount":"100.0","paymentTime":"xxx","reason":"xxxx","returnMsg":"xx","personIncomeTaxAmount":"0.01","valueAddedTaxAmount":"0.01","additionalTaxAmount":"0.01","contractTaxAmount":"0.01"},...] ## 2.4 取消订单接口 开发环境:https://pay-dev.lx-rhino.com 生产环境:https://api.lx-rhino.com #### 接口地址: /open/api/v1/qs/bill/cancel #### 请求方式:POST #### 请求参数说明: |参数名称|参数类型|参数含义|是否必填|参数备注| |-|-|-|-|-| |billNo|String|平台返回的提交结算订单号|是|| |reason|String|取消原因(取消原因字段限制不超过30字)|否|| #### 接口响应参数data字段解密后的参数说明: >d 该接口响应参数中无响应data字段 ,success 等于true代表取消成功,false 代表失败 errorMessage中有错误信息反馈 ## 2.5.1.电子回单查询 >d 电子回单在支付完成之后,需要一定时间制作,如若需要系统生成好回单自动推送,请调用电子回单回调申请接口 开发环境:https://pay-dev.lx-rhino.com 生产环境:https://api.lx-rhino.com #### 接口地址: /open/api/v1/qs/bill/voucher/query #### 请求方式:POST #### 请求参数说明: >d 请求确保callbackUrl地址能够用外网正常访问 |参数名称|参数含义|数据类型|是否必填|参数备注| |-|-|-|-|-| |thirdOrderNo|商户订单号|String|是| |callbackUrl|回调地址|String|否|如果电子回单未生成,将会记录回调地址,等电子回单生成后主动推送,调用此地址,重复提交(相同订单号)视为修改回调地址(入参空地址则不修改),一个订单只会回调一次| #### 接口响应参数data字段解密后的参数说明: |参数名称| 参数含义|数据类型| 是否必有| 参数备注| |-|-|-|-|-| |thirdOrderNo|商户订单号|String|是|| |status|电子回单状态|Integer|是|-1-未制作(没有提供回调地址);0-制作中(回单制作完成将主动推送回调地址);1-制作完成;| |voucherUrl|电子回单下载地址|String|否|回单制作完成时有值| ## 2.5.2.电子回单回调 #### 请求方式:POST #### 请求参数说明: >d 请在正常接收到回调请求后返回小写字符串"success",否则系统的回调补偿机制将轮询回调 |参数名称|参数含义|数据类型|是否必填|参数备注| |-|-|-|-|-| |thirdOrderNo|商户订单号|String|是|| |voucherUrl|电子回单下载地址|String|是||