diff --git a/content/docs/API/HRO接口文档.md b/content/docs/API/HRO接口文档.md index 2319a44..2a42c8a 100644 --- a/content/docs/API/HRO接口文档.md +++ b/content/docs/API/HRO接口文档.md @@ -3,14 +3,13 @@ title: HRO接口文档 weight: 1 --- - - # 易才代收付API **修订记录** 版本号 | 更新日期 | 更新人 | 更新内容 --- | --- | --- | --- +v1.3 | 2021-04-08 | 赵磊 | 增加接口限制说明；送盘行号可选 v1.2 | 2021-04-02 | 赵磊 | 送盘文件增加银行代号、联行号字段 v1.1 | 2021-02-26 | 赵磊 | 退票接口增加transStsMsg v1.0 | 2021-02-03 | 赵磊 | 修改acctType枚举值 @@ -92,6 +91,9 @@ bodyStream 为字节数组 ``` + + + ## 接口清单 序号 | 服务名 | 描述 | 报文方向 | 是否签名 @@ -106,6 +108,15 @@ bodyStream 为字节数组 8 | cardInfoQuery | 卡信息查询 | HRO -> 沐融代付 | Y 9 | reconciliationQuery | 对账信息查询 | HRO -> 沐融代付 | Y + +### 接口约束性说明 + +符号 | 含义 | 描述 +--- | --- | --- +M | Mandatory | 强制的 +O | Optional | 可选的 +C | Conditional | 满足条件后必选 + ### 公共请求/响应头 - 请求 @@ -283,11 +294,11 @@ bodyStream 为字节数组 字段名称 | 类型 | 必输 | 描述 | 备注 --- | --- | :----: | ---- | --- - applyDate | VARCHAR(8) | Y | 原订单申请日期 | - refId | VARCHAR(48) | Y | 参考号 | HRO明细流水号 - oriTransSts | VARCHAR(1) | Y | 原交易状态 | S：成功 F：失败 R：已退票 - transSts | VARCHAR(1) | Y | 交易状态 | S：成功 F：失败 R：已退票 - remark | VARCHAR(100) | Y | 备注 | 此处可填修改状态的具体原因 + applyDate | VARCHAR(8) | M | 原订单申请日期 | + refId | VARCHAR(48) | M | 参考号 | HRO明细流水号 + oriTransSts | VARCHAR(1) | M | 原交易状态 | S：成功 F：失败 R：已退票 + transSts | VARCHAR(1) | M | 交易状态 | S：成功 F：失败 R：已退票 + remark | VARCHAR(100) | O | 备注 | 此处可填修改状态的具体原因 - 返回 @@ -301,15 +312,15 @@ bodyStream 为字节数组 字段名称 | 类型 | 必输 | 描述 | 备注 --- | --- | :----: | ---- | --- - cardNo | VARCHAR(32) | Y | 卡号 | + cardNo | VARCHAR(32) | M | 卡号 | - 返回 字段名称 | 类型 | 必输 | 描述 | 备注 --- | --- | :----: | ---- | --- - bankType | VARCHAR(4) | Y | 银行类型 | 详见 [银行代码](#银行代码) - cardType | VARCHAR(2) | Y | 卡类型 | - cardName | VARCHAR(100) | Y | 卡名称 | + bankType | VARCHAR(4) | M | 银行类型 | 详见 [银行代码](#银行代码) + cardType | VARCHAR(2) | M | 卡类型 | + cardName | VARCHAR(100) | M | 卡名称 | ### reconciliationQuery [对账信息查询] @@ -317,19 +328,19 @@ bodyStream 为字节数组 字段名称 | 类型 | 必输 | 描述 | 备注 --- | --- | :----: | ---- | --- - date | VARCHAR(8) | Y | 对账日期 | + date | VARCHAR(8) | M | 对账日期 | - 返回 字段名称 | 类型 | 必输 | 描述 | 备注 --- | --- | :----: | ---- | --- - filePath | VARCHAR(100) | Y | 文件路径/FID | - totalCount | VARCHAR(8) | Y | 总笔数 | - totalAmount | VARCHAR(18) | Y | 总金额 | 分为单位 - succCount | VARCHAR(8) | Y | 成功笔数 | - succAmount | VARCHAR(18) | Y | 成功金额 | 分为单位 - failCount | VARCHAR(8) | Y | 失败笔数 | - failAmount | VARCHAR(18) | Y | 失败金额 | 分为单位 + filePath | VARCHAR(100) | M | 文件路径/FID | + totalCount | VARCHAR(8) | M | 总笔数 | + totalAmount | VARCHAR(18) | M | 总金额 | 分为单位 + succCount | VARCHAR(8) | M | 成功笔数 | + succAmount | VARCHAR(18) | M | 成功金额 | 分为单位 + failCount | VARCHAR(8) | M | 失败笔数 | + failAmount | VARCHAR(18) | M | 失败金额 | 分为单位 md5 | VARCHAR(32) | M | 磁盘MD5值 | eg. c5950a259435d3e51262539a10a22910 @@ -344,25 +355,25 @@ bodyStream 为字节数组 字段名称 | 类型 | 必输 | 描述 | 备注 --- | --- | :----: | ---- | --- - totalCount | VARCHAR(8) | Y | 总笔数 | - totalAmount | VARCHAR(18) | Y | 总金额 | 分为单位 - titleId | VARCHAR(48) | Y | 支付地抬头ID | - customerId | VARCHAR(48) | Y | 客户ID | - postscript | VARCHAR(100) | Y | 银行附言 | + totalCount | VARCHAR(8) | M | 总笔数 | + totalAmount | VARCHAR(18) | M | 总金额 | 分为单位 + titleId | VARCHAR(48) | M | 支付地抬头ID | + customerId | VARCHAR(48) | M | 客户ID | + postscript | VARCHAR(100) | M | 银行附言 | - 循环体 字段名称 | 类型 | 必输 | 描述 | 备注 --- | --- | :----: | ---- | --- - acctNo | VARCHAR(48) | Y | 账号 | 卡号、存折号 - acctName | VARCHAR(150) | Y | 姓名 | - refId | VARCHAR(48) | Y | 参考号 | HRO明细流水号 - amount | VARCHAR(18) | Y | 金额 | 分为单位 - bankCode | VARCHAR(20) | Y | 开户银行代号 | 详见 [银行代码](#银行代码) - bankCity | VARCHAR(100) | Y | 开户行所在城市 | 存折与大小额时必输 - bankName | VARCHAR(100) | Y | 开户银行网点 | 存折与大小额时必输 - bankNo | VARCHAR(14) | Y | 联行号 | 开户行联行号（预留） - remark | VARCHAR(100) | Y | 备注 | + acctNo | VARCHAR(48) | M | 账号 | 卡号、存折号 + acctName | VARCHAR(150) | M | 姓名 | + refId | VARCHAR(48) | M | 参考号 | HRO明细流水号 + amount | VARCHAR(18) | M | 金额 | 分为单位 + bankCode | VARCHAR(20) | C | 开户银行代号 | 详见 [银行代码](#银行代码) + bankCity | VARCHAR(100) | C | 开户行所在城市 | 存折与大小额时必输 + bankName | VARCHAR(100) | C | 开户银行网点 | 存折与大小额时必输 + bankNo | VARCHAR(14) | C | 联行号 | 开户行联行号（预留） + remark | VARCHAR(100) | O | 备注 | ### 回盘 @@ -370,36 +381,36 @@ bodyStream 为字节数组 字段名称 | 类型 | 必输 | 描述 | 备注 --- | --- | :----: | ---- | --- - totalCount | VARCHAR(8) | Y | 总笔数 | - totalAmount | VARCHAR(18) | Y | 总金额 | 分为单位 - succCount | VARCHAR(8) | Y | 成功笔数 | - succAmount | VARCHAR(18) | Y | 成功金额 | 分为单位 - failCount | VARCHAR(8) | Y | 失败笔数 | - failAmount | VARCHAR(18) | Y | 失败金额 | 分为单位 - titleId | VARCHAR(48) | Y | 支付地抬头ID | - customerId | VARCHAR(48) | Y | 客户ID | + totalCount | VARCHAR(8) | M | 总笔数 | + totalAmount | VARCHAR(18) | M | 总金额 | 分为单位 + succCount | VARCHAR(8) | M | 成功笔数 | + succAmount | VARCHAR(18) | M | 成功金额 | 分为单位 + failCount | VARCHAR(8) | M | 失败笔数 | + failAmount | VARCHAR(18) | M | 失败金额 | 分为单位 + titleId | VARCHAR(48) | M | 支付地抬头ID | + customerId | VARCHAR(48) | M | 客户ID | - 循环体 字段名称 | 类型 | 必输 | 描述 | 备注 --- | --- | :----: | ---- | --- - applyDate | VARCHAR(8) | Y | 申请日期 | + applyDate | VARCHAR(8) | M | 申请日期 | lastTime | VARCHAR(14) | M | 最后更新时间 | eg. 20210111 - acctType | VARCHAR(2) | Y | 账号类型 | 00：借记卡 01：贷记卡 02：准贷记卡 03：预付费卡 - acctNo | VARCHAR(48) | Y | 账号 | 卡号、存折号 - acctName | VARCHAR(150) | Y | 姓名 | - transId | VARCHAR(48) | Y | 业务平台流水号 | 沐融交易流水号 - refId | VARCHAR(48) | Y | 参考号 | HRO明细流水号 - bankRefId | VARCHAR(48) | Y | 银行流水号 | - amount | VARCHAR(18) | Y | 金额 | 分为单位 - bankName | VARCHAR(50) | N | 银行名称 | - postscript | VARCHAR(100) | N | 银行附言 | - payerAcctNo | VARCHAR(48) | Y | 出款账号 | - payerAcctName | VARCHAR(100) | Y | 出款户名 | - orgNo | VARCHAR(100) | N | 合作机构编号 | 详见 [银行代码](#银行代码) - remark | VARCHAR(100) | Y | 备注 | - transSts | VARCHAR(1) | Y | 明细状态 | S：成功 F：失败 - transMessage | VARCHAR(100) | Y | 业务信息 | 当transSts = F时该字段返回错误信息 + acctType | VARCHAR(2) | M | 账号类型 | 00：借记卡 01：贷记卡 02：准贷记卡 03：预付费卡 + acctNo | VARCHAR(48) | M | 账号 | 卡号、存折号 + acctName | VARCHAR(150) | M | 姓名 | + transId | VARCHAR(48) | M | 业务平台流水号 | 沐融交易流水号 + refId | VARCHAR(48) | M | 参考号 | HRO明细流水号 + bankRefId | VARCHAR(48) | M | 银行流水号 | + amount | VARCHAR(18) | M | 金额 | 分为单位 + bankName | VARCHAR(50) | O | 银行名称 | + postscript | VARCHAR(100) | O | 银行附言 | + payerAcctNo | VARCHAR(48) | M | 出款账号 | + payerAcctName | VARCHAR(100) | M | 出款户名 | + orgNo | VARCHAR(100) | O | 合作机构编号 | 详见 [银行代码](#银行代码) + remark | VARCHAR(100) | M | 备注 | + transSts | VARCHAR(1) | M | 明细状态 | S：成功 F：失败 + transMessage | VARCHAR(100) | M | 业务信息 | 当transSts = F时该字段返回错误信息 @@ -409,18 +420,18 @@ bodyStream 为字节数组 字段名称 | 类型 | 必输 | 描述 | 备注 --- | --- | :----: | ---- | --- - applyDate | VARCHAR(8) | Y | 申请日期 | - transId | VARCHAR(48) | Y | 业务平台流水号 | 沐融交易流水号 - refId | VARCHAR(48) | Y | 参考号 | HRO明细流水号 - bankRefId | VARCHAR(48) | Y | 银行流水号 | - payerAcctNo | VARCHAR(48) | Y | 出款账号 | - payerAcctName | VARCHAR(100) | Y | 出款户名 | - acctNo | VARCHAR(48) | Y | 账号 | 卡号、存折号 - acctName | VARCHAR(150) | Y | 姓名 | - amount | VARCHAR(18) | Y | 金额 | 分为单位 - orgNo | VARCHAR(100) | N | 合作机构编号 | 详见 [银行代码](#银行代码) - transSts | VARCHAR(1) | Y | 明细状态 | S：成功 P：处理中 - transMessage | VARCHAR(100) | Y | 业务信息 | + applyDate | VARCHAR(8) | M | 申请日期 | + transId | VARCHAR(48) | M | 业务平台流水号 | 沐融交易流水号 + refId | VARCHAR(48) | M | 参考号 | HRO明细流水号 + bankRefId | VARCHAR(48) | M | 银行流水号 | + payerAcctNo | VARCHAR(48) | M | 出款账号 | + payerAcctName | VARCHAR(100) | M | 出款户名 | + acctNo | VARCHAR(48) | M | 账号 | 卡号、存折号 + acctName | VARCHAR(150) | M | 姓名 | + amount | VARCHAR(18) | M | 金额 | 分为单位 + orgNo | VARCHAR(100) | O | 合作机构编号 | 详见 [银行代码](#银行代码) + transSts | VARCHAR(1) | M | 明细状态 | S：成功 P：处理中 + transMessage | VARCHAR(100) | M | 业务信息 | ## 附录