Skip to content

honest_dong / accountDocs

Go to a project
Commit 50a81a48 by dongzhengcheng
Options

增加主账户统计接口文档

parent 1de3c9a8
Showing with 357 additions and 8 deletions
docs/ecrrc/demo.md 0 → 100644
# #### demo
> ##### 请求方法：`GET`
> ##### 请求地址：`{{URL}}/famous/modules/approval/index.php?act=approval_api&op=index`
> ##### 请求参数：
参数名 | 类型 | 必填 | 默认值 | 说明
:---|:---|:---|:---|:---
type|number|否|1|类型：`0`待我审批，`1`已审批
keywords|string|否||搜索的关键词
requestPage|number|否|1|请求的页码
perPage|number|否|10|每页显示记录数
> ##### 响应类型：`JSON`
> ##### 响应参数：
参数名 | 类型 | 说明
:---|:---|:---
code|number|响应码
data|array|响应数据，仅响应码`200`时存在
msg|string|错误信息，响应码非`200`时有效
url|string|跳转地址
> ##### data参数：
参数名 | 类型 | 说明
:---|:---|:---
list|array|数据集
nowPage|number|当前页码
totalPage|number|总页码数
perPage|number|每页显示记录数
totalData|number|总记录数
> ##### list参数：
参数名 | 类型 | 说明
:---|:---|:---
apvNo|string|审批编号
founder|string|发起人
type|string|类型
typeMsg|string|类型文字说明
status|string|状态：`0`审批中，`1`审批完成，`2`审批终止
statusMsg|string|状态文字说明
createdAt|string|创建时间
summary|array|摘要信息
> ##### 成功示例：
``` json
{
"code": 200,
"data": {
"list": [
{
"apvNo": "A00741346108591047",
"founder": "韩仁会",
"type": "compareSend",
"status": "0",
"createdAt": "2018-05-19 16:56:50",
"summary": [
"发标审批",
"项目编号：z321",
"项目名称：看了佳节快乐"
],
"typeMsg": "比选采购",
"statusMsg": "审批中"
}
],
"nowPage": 1,
"totalPage": 2,
"perPage": 1,
"totalData": 2
},
"url": "",
"msg": ""
}
```
> ##### 异常示例：
``` json
{
"code": 401,
"msg": "未登录",
"url": ""
}
```
> ##### 响应码：
返回码 | 说明
:---|:---
200|请求成功
401|未登录
403|企业未实名认证
500|请求失败
docs/ecrrc/stats/AcctDaily.md 0 → 100644
##统计-虚拟账户余额
**简要描述：**
获取指定日期，指定账户余额
**请求URL：**
- ` /api/stat/acctDaily/detail`
**请求方式：**
- get
**参数：**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|date |是|string（10） |日期：2019-03-01|
|acct_no |否|string（10） |银行主账户：空为默认主账户|
**返回示例**
```
{
'status':'SUCCESS',
'message':'操作成功',
'data':
{
'stat_date':'2019-03-01',
'acct_no':'8110701014101222604',
'amount':'646919389',
'in_amount':'12222222',
'out_amount':'66444444',
'created_at':'1554105197',
}
}
```
**返回参数说明**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|status_code|是|int |状态码|
|message|是|string |提示消息|
|data|是|obj | 业务数据 |
|-- stat_date|是|date| 日期|
|-- acct_no|是|int| 银行账号|
|-- amount|是|int| 账户余额 |
|-- in_amount|是|int| 当日入账金额|
|-- out_amount|是|int| 当日出账金额 |
|-- created_at|是|int| 创建时间 |
**备注**
- 更多返回错误代码请看首页的错误代码描述
***************
docs/ecrrc/stats/AcctList.md 0 → 100644
##统计-虚拟账户余额
**简要描述：**
获取指定日期，指定账户余额
**请求URL：**
- ` /api/stat/acctDaily`
**请求方式：**
- get
**参数：**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|stat_date-geq |是|string（10） |开始日期：2019-03-01， 包含|
|stat_date-lt |是|string（10） |截止日期：2019-03-01， 不包含|
|acct_no |否|string（10） |银行主账户：空为默认主账户|
**返回示例**
```
{
'status':'SUCCESS',
'message':'操作成功',
'data':
{
'stat_date':'2019-03-01',
'acct_no':'8110701014101222604',
'amount':'646919389',
'in_amount':'12222222',
'out_amount':'66444444',
'created_at':'1554105197',
}
}
```
**返回参数说明**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|status_code|是|int |状态码|
|message|是|string |提示消息|
|data|是|obj | 业务数据 |
|-- stat_date|是|date| 日期|
|-- acct_no|是|int| 银行账号|
|-- amount|是|int| 账户余额 |
|-- in_amount|是|int| 当日入账金额|
|-- out_amount|是|int| 当日出账金额 |
**备注**
- 更多返回错误代码请看首页的错误代码描述
***************
docs/ecrrc/stats/AcctTrade.md 0 → 100644
##统计-虚拟账户余额
**简要描述：**
获取指定日期，指定账户余额
**请求URL：**
- ` api/trade/acctTrade`
**请求方式：**
- get
**参数：**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|inout_date-geq |是|string（10） |开始日期：2019-03-01， 包含|
|inout_date-lt |是|string（10） |截止日期：2019-03-01， 不包含|
|trade_type |否|enum |交易类型：1，交易，8：退款，10：手续费，15：提现， 21：利息|
|keyword |否|string（10） |公司名称，|
|acct_no |否|string（10） |银行主账户：空为默认主账户|
|page |否|string（10） |分页数据|
**返回示例**
```
{
'status':'SUCCESS',
'message':'操作成功',
'data':
{
data: [
account_sn: "3110710039234028738",
amount: 259888,
bank_trade_no: "20190321BAT00030240063",
inout_at: 1553124754,
interest: 0,
interest_sync: 0,
remark: "利息",
service_charge: 0,
trade_type: 21 ,
trade_type_name: 利息,
account:{
account_name: "公共计息收费--京津冀票据交易中心",
account_sn: "3110710039234028738",
account_type: 1,
belong_id: 1,
belong_type: "p",
company_name: "公司名称"
}
}
],
current_page:1,
last_page:100,
per_page: 100,
to: 2,
total: 90
}
}
```
**返回参数说明**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|:---- |:---|:----- |----- |
|status_code|是|int |状态码|
|message|是|string |提示消息|
|data|是|obj | 业务数据 |
|--current_page|是|int |状态码|
|--per_page|是|string |每页条数|
|--last_page|是|string |最大页数|
|--to|是|string |当前获取到第几条|
|--total|是|string |总条数|
|--data|是|obj | 业务数据 |
|---- account_sn|是|date| 日期|
|---- bank_trade_no|是|int| 银行交易号|
|---- trade_amount|是|int| 交易金额 |
|---- is_plus|是|int| 1,入账， 0，出账 |
|---- inout_at|是|int| 出入账时间|
|---- trade_type|是|int| 交易类型|
|---- trade_type_name|是|string| 交易类型|
|---- amount|是|int| 本金余额 |
|---- interest|是|int| 结息利息|
|---- service_charge|是|int| 手续费|
|---- account|是|OBJ| 账户信息|
|------ account_name|是|string| 虚拟户名称|
|------ account_sn|是|string| 虚拟户编号|
|------ account_type|是|string| 虚拟户类型|
|------ belong_id|是|string| 公司ID、会员id|
|------ belong_type|是|string| 锁着类型：p平台，c公司，m会员|
|------ company_name|是|string| 公司名称|
**备注**
- 更多返回错误代码请看首页的错误代码描述
***************
mkdocs.yml
......@@ -8,14 +8,20 @@ nav:
- 首页: index.md
- 业务服务API:
- 引言: ecrrc/index.md
- 账户管理: ecrrc/account/account.md
- 冻结管理: ecrrc/account/freeze.md
- 账户白名单: ecrrc/account/whitelist.md
- 交易: ecrrc/trades/tradesPay.md
- 提现: ecrrc/trades/tradesPay.md
- 退款: ecrrc/trades/tradesRefund.md
- 交易验证: ecrrc/trades/tradesCheckCode.md
- 动账通知: ecrrc/trades/tradesNotice.md
- 账户:
- 账户管理: ecrrc/account/account.md
- 冻结管理: ecrrc/account/freeze.md
- 账户白名单: ecrrc/account/whitelist.md
- 交易:
- 交易: ecrrc/trades/tradesPay.md
- 提现: ecrrc/trades/tradesPay.md
- 退款: ecrrc/trades/tradesRefund.md
- 交易验证: ecrrc/trades/tradesCheckCode.md
- 动账通知: ecrrc/trades/tradesNotice.md
- 账户统计:
- 主账户每日金额: ecrrc/stats/AcctDaily.md
- 主账户每天金额历史记录: ecrrc/stats/AcctList.md
- 主账户交易: ecrrc/stats/AcctTrade.md
- 银行对接API文档:
- 引言: bank/index.md
- 流水状态查询: bank/trade.md
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment