# PublicDoc **Repository Path**: KeiYou/PublicDoc ## Basic Information - **Project Name**: PublicDoc - **Description**: 记录一些临时的资源信息 - **Primary Language**: C# - **License**: AGPL-3.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2020-02-28 - **Last Updated**: 2020-12-20 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README ## BankTech项目的对外 API 接口说明 #### 生产环境接口地址：https://api.omniwallet.com.au/api #### 测试环境接口地址：https://api.omniwallet.com.au/api > 返回结构： ``` { code:0 message:'' data:{} } ``` > 接口返回 状态码 code 状态码 | 状态含义 | 备 注 --- |--- |--- 200 | OK | 201 | Created | 202 | Accepted | 400 | Bad Request | 401 | Authentication Failure | 403 | Forbidden | 404 | Not Fount | 500 | Internal Server Error | 505 | Service Unavailable | ### 1.授权登录接口 - url: /Login/login - 功能说明：提交API Key 登录系统 - method: POST - 输入参数: ``` { "ApiSecret": "6/StoduFylQ9kO3fd3gxtwH6BIOCY0MdvJAexuuqHRKH5usbpQerPLwCUterFqx2fDecsy9K63B48dFAD20lpg==" } ``` 字段名称 | 字段类型 | 含义 | 备 注 --- |--- |--- |--- ApiSecret | string | 分配给调用方的APISecret | - 返回值： 输出参数 ``` { "code": 200, "message": "", "data": { "access_token": "tdzx9bQ35pODEdeDOW/OIlzzh/W3vdFPfbmfB6X714ecNlB8/YH2GcbmVA2ekVQ/wfhauuTcg2ZhKaC6ctAsmA==", "expires_in": 7200, "expires_time": "2020-02-27 00:25:31" } } ``` 字段名称 | 字段类型 | 含义 | 备 注 --- |--- |--- |--- access_token | string | 本次登录的Token | 以后每个接口 都需要带上这个Token，到下一次登录失效 expires_in | int | 有效期 单位秒 | expires_time | string | 过期时间 | ### 2.交易结算--获取待结算记录列表 - url: v1/Settlement/{status} - 功能说明：读取交易记录表 Status=3,InternalID='',FileName='' 条件下 不同结算状态的记录 - method: GET - Header : Token='tdzx9bQ35pODEdeDOW/OIlzzh/W3vdFPfbmfB6X714ecNlB8/YH2GcbmVA2ekVQ/wfhauuTcg2ZhKaC6ctAsmA==' - 输入参数: ``` status=101|102 ``` 字段名称 | 字段类型 | 含义 | 备 注 --- |--- |--- |--- status | int | 结算状态 | 101 等待结算 103 结算成功 102 结算失败 - 返回值： 输出参数 ``` { "code": 200, "message": "", "data": [{ "TransactionId": "4166ABE6-DF49-4D4D-865E-A899C2596BB8", "Amount": 500.00, "FromAccountId":"996FDEA0-4148-42B5-B40F-40EC6E5277EB", "ToAccountId":"996FDEA0-4148-42B5-B40F-40EC6E5277EC" }] } ``` 字段名称 | 字段类型 | 含义 | 备 注 --- |--- |--- |--- TransactionId | string | 交易记录ID | Amount | decimal | 交易金额 | FromAccountId | string | 转出账户银行ID | ToAccountId | string | 转入账户银行ID | ### 3.交易结算--更新交易记录信息 - url: v1/Settlement - 功能说明：银行提交记录过来，更新 InternalID 和 FileName 字段 - method: POST - Header : Token='tdzx9bQ35pODEdeDOW/OIlzzh/W3vdFPfbmfB6X714ecNlB8/YH2GcbmVA2ekVQ/wfhauuTcg2ZhKaC6ctAsmA==' - 输入参数: ``` [{ "TransactionId": "4166ABE6-DF49-4D4D-865E-A899C2596BB8", "InternalID":"", "FileName":"" },{ "TransactionId": "4166ABE6-DF49-4D4D-865E-A899C2596BB8", "InternalID":"", "FileName":"" }] ``` 字段名称 | 字段类型 | 含义 | 备 注 --- |--- |--- |--- TransactionId | string | 交易记录ID | 对应接口2里面的 TransactionId InternalID | string | 结算文件里面的行号 | FileName | string | 结算文件名称 | - 返回值： 输出参数 ``` { "code": 200, "message": "", "data": {} } ``` ### 4. 交易结算--定时服务，读取结算文件更新结算状态 - 结算文件格式 *.ABA - 结算文件内容格式: ``` [{ "TransactionId": "4166ABE6-DF49-4D4D-865E-A899C2596BB8", "InternalID":"", SettlementStatus:102 },{ "TransactionId": "4166ABE6-DF49-4D4D-865E-A899C2596BB8", "InternalID":"", SettlementStatus:103 },{ "TransactionId": "4166ABE6-DF49-4D4D-865E-A899C2596BB8", "InternalID":"", SettlementStatus:102 }] ``` 字段名称 | 字段类型 | 含义 | 备 注 --- |--- |--- |--- TransactionId | string | 交易记录ID | InternalID | string | 结算文件里面的行号 | SettlementStatus | int | 结算状态 | 103 结算成功 102 结算失败 ### 5. ATM Plus 交易接口 -- 请求账户钱包余额 - url: v1/atmplus/desired_deposit - 功能说明： - method: POST - Header : Token='tdzx9bQ35pODEdeDOW/OIlzzh/W3vdFPfbmfB6X714ecNlB8/YH2GcbmVA2ekVQ/wfhauuTcg2ZhKaC6ctAsmA==' - 输入参数: ``` { "machine_id": "4166ABE6-DF49-4D4D-865E-A899C2596BB8", "desired_deposit_amount": 500.00, } ``` 字段名称 | 字段类型 | 含义 | 备 注 --- |--- |--- |--- machine_id | string | 机器码ID | desired_deposit_amount | decimal | 期望扣款金额 | - 返回值： 输出参数 ``` { "code": 200, "message": "", "data": { TransactionId:'' } } { "code": 500, "message": "Insufficient Fund", "data": { TransactionId:'' } } ``` 字段名称 | 字段类型 | 含义 | 备 注 --- |--- |--- |--- code | int | 返回状态 | 200 操作正常，500：操作异常 message | string | 错误原因 | 200：为空 500：具体错误原因 TransactionId | string | 本次交易ID | 下个接口需要提供此参数 ### 6.ATM Plus 交易 -- 请求扣款，或者取消，执行结果 - url: /v1/atmplus/deposited - 功能说明：提交执行某条交易状态，扣款，或者取消 - method: POST - Header : Token='tdzx9bQ35pODEdeDOW/OIlzzh/W3vdFPfbmfB6X714ecNlB8/YH2GcbmVA2ekVQ/wfhauuTcg2ZhKaC6ctAsmA==' - 输入参数: ``` { "machine_id": "4166ABE6-DF49-4D4D-865E-A899C2596BB8", "TransactionId": '', "deposited_amount": 400.00, "status":100 } ``` 字段名称 | 字段类型 | 含义 | 备 注 --- |--- |--- |--- machine_id | string | 机器码ID | TransactionId | string | 交易记录ID | 上个接口的返回参数 deposited_amount | decimal | 实际扣款金额 | status | int | 执行动作 | 100 表示执行扣款 101 表示取消交易 - 返回值： 输出参数 ``` { "code": 200, "message": "", "data": { } } ``` #### 定时任务 1个小时内 未调用 接口6处理的数据 交易自动关闭。