2.订单接口文档

## <a id="2.1.提交订单">2.1.提交订单</a> 开发环境:https://pay-dev.lx-rhino.com 生产环境:https://api.lx-rhino.com #### 接口地址: /open/api/v1/yns/bill/submit #### 请求方式:POST #### 请求参数说明: |参数名称|参数含义|数据类型|是否必填|参数备注| |-|-|-|-|-| |payeeName|收款人姓名|String|是|| |payeeAccount|收款账户|String|是|| |payeeIdCard|收款人身份证号码|String|是|| |amount |收款金额|String|是|收款金额必须为数字| |payeePhone|收款人手机号|String|否|该参数用于用户接收到款短信| |thirdOrderId|商户订单号|String|是|商户自己生成,不可重复提交| |wxAppId|微信多渠道appid|String|否|特殊情况下需要此字段| |thirdBizOrderId|第三方业务订单ID|String|否|该参数为商户自己的业务订单号,通过该订单号能够查询该笔金额来源明细| |payType|支付类型|Integer|否|支付类型该参数值填写支付类型对应数字即可 0:银行卡| |mainstayId|主体ID|Integer|是|该参数由[3.1.开票信息查询](#3.1.开票信息查询)| |invoiceCode|发票编码|String|是|该参数由[3.1.开票信息查询](#3.1.开票信息查询)| |remark|备注|String|否|备注字数不可超过32个字符| |transName|转账备注|String|否|备注字数不可超过20个字符| #### 接口响应参数data字段解密后的参数说明: |参数名称| 参数含义| 数据类型| 是否必有| 参数备注| |-|-|-|-|-| |billNo| 订单号|String|是|| |billStatus| 发放平台订单状态|Integer|[发放结果码对照表](doc:M3CsZ7Hh)|| |actualAmount| 结算金额(实际个人所得额)|BigDecimal|是|| |contractTaxAmount|服务费(合同税费)|BigDecimal|是|| |failReason|失败原因|String|否|| ## <a id="2.2.确认发放">2.2.确认发放</a> 开发环境:https://pay-dev.lx-rhino.com 生产环境:https://api.lx-rhino.com #### 接口地址: /open/api/v1/yns/bill/sureGrant #### 请求方式:POST #### 请求参数说明: |参数名称|参数含义|数据类型|是否必填|参数备注| |-|-|-|-|-| |billNo|订单号|String|是|该值由提交订单接口返回| |settlementCertUrl|结算证明|String|否|商户配置为结算前则必填,该参数为通过[4.1.上传文件接口](#4.1.上传文件接口)将文件上传后返回的值,最长640字符| #### 接口响应参数data字段解密后的参数说明: |参数名称| 参数含义|数据类型| 是否必有| 参数备注| |-|-|-|-|-| |billNo|订单号|String|是| || |thirdOrderNo|第三方订单号|String| 是|生成订单接口的thirdOrderId字段的值| |status|发放结果状态|Integer| 是|详情请参考[发放结果状态码](doc:M3CsZ7Hh)| |failReason|失败原因|String|否| || ## <a id="2.3.取消订单">2.3.取消订单</a> 开发环境:https://pay-dev.lx-rhino.com 生产环境:https://api.lx-rhino.com #### 接口地址: /open/api/v1/yns/bill/cancel #### 请求方式:POST #### 请求参数说明: |参数名称|参数含义|数据类型|是否必填|参数备注| |-|-|-|-|-| |billNo|订单号|String|是|该值由提交订单接口返回| |reason|取消原因|String|否|| #### 接口响应参数data字段解密后的参数说明: >d该接口返回结果data解密后为boolean。 ## <a id="2.4.发放结果查询接口">2.4.发放结果查询接口</a> 开发环境:https://pay-dev.lx-rhino.com 生产环境:https://api.lx-rhino.com #### 接口地址: /open/api/v1/yns/bill/queryResult #### 请求方式:POST #### 请求参数说明: |参数名称|参数含义|数据类型|是否必填|参数备注| |-|-|-|-|-| |thirdOrderNos|需要查询的商户订单号|List&lt;String&gt;|是|最大长度10 #### 接口响应参数data字段解密后的参数说明: |参数名称| 参数含义|数据类型| 是否必有| 参数备注| |-|-|-|-|-| |thirdOrderNo|商户订单号|String|是|| |status|结果状态|Integer|是|详情请参考[发放结果状态码](doc:M3CsZ7Hh)| |reason|失败原因|String|否|支付失败才会有该值| >d该发放结果data解密后为List 集合json字符串。 结果示例 [{"thirdOrderNo":"xxx","status":"xx","reason":"xxxx"}, {"thirdOrderNo":"xxx","status":"xx","reason":"xxxx"}] ## 2.5.发放成功异步回调 >d 该接口需要第三方自行编写提供接口到发放平台回调成功必须返回success不然会重复回调 接口编写示例跟8.充值回调接口说明一致 #### 请求方式:POST 解密结果示例如下: ```json {"itemStatus":"2","amount":"12.01","thirdOrderNo":"xxxxx","paymentTime":"2019-07-05 23:41:45","returnMsg":"xxxxx"}"; ``` |参数名称| 参数含义| 是否必有| 参数备注| |-|-|-|-| |itemStatus| 订单状态| 是|详情请参考[发放结果状态码](doc:M3CsZ7Hh)| |amount| 发放的金额| 是|实际发放的金额| |thirdOrderNo| 发放订单号| 是|| |paymentTime| 发放时间| 是|| |returnMsg| 描述信息| 是|| ## 2.6.1.电子回单查询 >d 电子回单在支付完成之后,需要一定时间生成,如若需要系统生成好回单自动推送,请调用电子回单回调申请接口 开发环境:https://pay-dev.lx-rhino.com 生产环境:https://api.lx-rhino.com #### 接口地址: /open/api/v1/yns/bill/voucher/query #### 请求方式:POST #### 请求参数说明: >d 请求确保callbackUrl地址能够用外网正常访问 |参数名称|参数含义|数据类型|是否必填|参数备注| |-|-|-|-|-| |thirdOrderNo|商户订单号|String|是| |callbackUrl|回调地址|String|否|如果电子回单未生成,将会记录回调地址,等电子回单生成后主动推送,调用此地址,重复提交(相同订单号)视为修改回调地址(入参空地址则不修改),一个订单只会回调一次| #### 接口响应参数data字段解密后的参数说明: |参数名称| 参数含义|数据类型| 是否必有| 参数备注| |-|-|-|-|-| |thirdOrderNo|商户订单号|String|是|| |status|电子回单状态|Integer|是|-1-未生成;0-生成中;1-已生成;| |voucherUrl|电子回单下载地址|String|否|status=1时返回,status=0/-1时,系统生成电子回单后,将主动推送callbackUrl地址| ## 2.6.2.电子回单回调 #### 请求方式:POST #### 请求参数说明: >d 请在正常接收到回调请求后返回小写字符串"success",否则系统的回调补偿机制将轮询回调 |参数名称|参数含义|数据类型|是否必填|参数备注| |-|-|-|-|-| |thirdOrderNo|商户订单号|String|是|| |status|电子回单状态|Integer|是|1-已生成;| |voucherUrl|电子回单下载地址|String|否|status=1时返回,status=0/-1时,系统生成电子回单后,将主动推送callbackUrl地址|