Open Banking_deposit 1.0.0
取得Open Banking 產品相關資訊
路徑
/{depositType}/list
查詢4種存款類型的相關存款產品名稱參數以做為查詢參數用
包括以下四種類別 1.台幣活期(domesticDemand)包括 活期存款/活期儲蓄存款/薪資轉帳活期儲蓄存款/證券戶活期儲蓄存款/數位存款/綜合存款 2.台幣定期(domesticTime)包括 定期存款/定期儲蓄存款 3.外匯活期(foreignDemand)包括 外匯活期存款/外匯綜合活期存款 4.外匯定期(foreignTime)包括 外匯定期存款 ,key是中文名, value是對應的查詢用參數
客戶端發送Request記錄的處理序號
{
"pattern": "^[0-9]{7}$",
"default": "1234567"
}
TXN destination institute ID, 指參加單位代號, 例如:銀行代號
{
"pattern": "^[0-9]{7}$",
"default": "8080000"
}
client App 註冊於Open Banking GateWay的id
{
"default": "user"
}
TXN initiate date and time, 交易發起日期時間, 格式yyyyMMddhhmmss
{
"pattern": "^[0-9]{14}$",
"default": "20200702000000"
}
存款類型
{
"enum": [
"domesticDemand",
"domesticTime",
"foreignDemand",
"foreignTime"
]
}
回應成功
/domestic/demand
查詢台幣活期存款類型的相關存款資訊
台幣活期(demesticDemand)包括 活期存款/活期儲蓄存款/薪資轉帳活期儲蓄存款/證券戶活期儲蓄存款/數位存款/綜合存款
客戶端發送Request記錄的處理序號
{
"pattern": "^[0-9]{7}$",
"default": "1234567"
}
TXN destination institute ID, 指參加單位代號, 例如:銀行代號
{
"pattern": "^[0-9]{7}$",
"default": "8080000"
}
client App 註冊於Open Banking GateWay的id
{
"default": "user"
}
TXN initiate date and time, 交易發起日期時間, 格式yyyyMMddhhmmss
{
"pattern": "^[0-9]{14}$",
"default": "20200702000000"
}
存款產品名稱列表所對應的value, 用逗號區隔多種名稱的value
{
"items": {
"type": "string"
},
"collectionFormat": "csv"
}
回應成功
/domestic/time
查詢台幣定期存款類型的相關存款資訊
台幣定期(domesticTime)包括 定期存款/定期儲蓄存款
客戶端發送Request記錄的處理序號
{
"pattern": "^[0-9]{7}$",
"default": "1234567"
}
TXN destination institute ID, 指參加單位代號, 例如:銀行代號
{
"pattern": "^[0-9]{7}$",
"default": "8080000"
}
client App 註冊於Open Banking GateWay的id
{
"default": "user"
}
TXN initiate date and time, 交易發起日期時間, 格式yyyyMMddhhmmss
{
"pattern": "^[0-9]{14}$",
"default": "20200702000000"
}
存款產品名稱列表所對應的value, 用逗號區隔多種名稱的value
{
"items": {
"type": "string"
},
"collectionFormat": "csv"
}
回應成功
/foreign/demand
查詢外匯活期存款類型的相關存款資訊
外匯活期(foreignDemand)包括 外匯活期存款/外匯綜合活期存款
客戶端發送Request記錄的處理序號
{
"pattern": "^[0-9]{7}$",
"default": "1234567"
}
TXN destination institute ID, 指參加單位代號, 例如:銀行代號
{
"pattern": "^[0-9]{7}$",
"default": "8080000"
}
client App 註冊於Open Banking GateWay的id
{
"default": "user"
}
TXN initiate date and time, 交易發起日期時間, 格式yyyyMMddhhmmss
{
"pattern": "^[0-9]{14}$",
"default": "20200702000000"
}
存款產品名稱列表所對應的value, 用逗號區隔多種名稱的value
{
"items": {
"type": "string"
},
"collectionFormat": "csv"
}
回應成功
/foreign/time
查詢外匯定期存款類型的相關存款資訊
外匯定期(foreignTime)包括 外匯定期存款
客戶端發送Request記錄的處理序號
{
"pattern": "^[0-9]{7}$",
"default": "1234567"
}
TXN destination institute ID, 指參加單位代號, 例如:銀行代號
{
"pattern": "^[0-9]{7}$",
"default": "8080000"
}
client App 註冊於Open Banking GateWay的id
{
"default": "user"
}
TXN initiate date and time, 交易發起日期時間, 格式yyyyMMddhhmmss
{
"pattern": "^[0-9]{14}$",
"default": "20200702000000"
}
存款產品名稱列表所對應的value, 用逗號區隔多種名稱的value
{
"items": {
"type": "string"
},
"collectionFormat": "csv"
}
回應成功
定義
正確查詢存款參數列表資訊回應的資料模型, 查詢以下4類回傳中文產品名及查詢值的對應表, 1.台幣活期(domesticDemand)包括 活期存款/活期儲蓄存款/薪資轉帳活期儲蓄存款/證券戶活期儲蓄存款/數位存款/綜合存款, 2. 台幣定期(domesticTime)包括 定期存款/定期儲蓄存款, 3. 外匯活期(foreignDemand)包括 外匯活期存款/外匯綜合活期存款, 4. 外匯定期(foreignTime)包括 外匯定期存款
{
"type": "object",
"properties": {
"appRepBody": {
"$ref": "#\/definitions\/depositListRef"
},
"appRepExtension": {
"description": "擴充欄位,可以任意key value pair",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
存款參數列表資料模型
{
"type": "object",
"properties": {
"updateTime": {
"description": "資料更新時間,格式:yyyyMMddhhmmss,Ex:20190101210900",
"type": "string"
},
"depositList": {
"description": "存款參數列表,自訂key value對應",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
正確查詢資訊回應的資料模型
{
"type": "object",
"properties": {
"appRepBody": {
"$ref": "#\/definitions\/depositRef"
},
"appRepExtension": {
"description": "擴充欄位,可以任意key value pair",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
正確查詢存款類資訊回應的資料模型
{
"type": "object",
"properties": {
"deposit": {
"type": "array",
"items": {
"$ref": "#\/definitions\/deposit"
}
}
}
}
存款資料模型
{
"type": "object",
"properties": {
"updateTime": {
"description": "資料更新時間,格式:yyyyMMddhhmmss,Ex:20190101210900",
"type": "string"
},
"productName": {
"description": "產品代號或名稱, Ex:活期存款",
"type": "string"
},
"rate": {
"type": "array",
"items": {
"$ref": "#\/definitions\/depositRate"
}
},
"interest": {
"type": "array",
"items": {
"$ref": "#\/definitions\/depositInterest"
}
},
"currency": {
"description": "幣別碼,長度3碼,Ex:TWD\/USD等",
"type": "string"
},
"eligibility": {
"$ref": "#\/definitions\/depositEligibility"
},
"fee": {
"description": "手續費",
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#\/definitions\/depositFeeDetail"
}
}
},
"extension": {
"description": "存款擴充欄位,可以任意key value pair",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"updateTime",
"productName",
"rate",
"interest",
"currency",
"threshold",
"fee"
],
"additionalProperties": false
}
費用細節描述
{
"type": "object",
"properties": {
"name": {
"description": "費用名稱, ex:臨櫃存匯業務手續費",
"type": "string"
},
"countMethod": {
"description": "費用計算方式, 用百分比或金額或其它方式, ex:0.005%或每次交易5元之類",
"type": "string"
},
"other": {
"description": "對費用的補充描述",
"type": "string"
}
}
}
利率的細項訊息, 利率性質及額度是必要
{
"type": "object",
"properties": {
"value": {
"description": "利率值, 請以小數點表示, 不帶百分比符號, ex: 0.005即代表0.5%",
"type": "string"
},
"rateType": {
"description": "利率性質, ex:機動、固定",
"type": "string"
},
"amount": {
"description": "額度, ex:一般\/大額\/其他",
"type": "string"
},
"period": {
"$ref": "#\/definitions\/depositPeriod"
}
},
"required": [
"rateType",
"amount"
]
}
存款期間的描述, 當是定期類的存款, 在回應的資料中就加入存期這個屬性, 若是活期類請以空物件 大括號的方式{}表示
{
"type": "object",
"properties": {
"timeLength": {
"description": "表示時間長度用, 例如: 1,2,3,4...等",
"type": "string"
},
"timeType": {
"description": "表示時間類型, 例如:day\/week\/month\/year",
"type": "string",
"enum": [
"day",
"week",
"month",
"year"
]
}
}
}
利息的細項訊息
{
"type": "object",
"properties": {
"calculateMethod": {
"description": "利息計算方法, ex:按日計息",
"type": "string"
},
"depositFrequency": {
"description": "存入頻率, ex:機動、固定",
"type": "string"
},
"countDates": {
"description": "在哪些日期計息, ex:06\/21, 12\/21等",
"type": "string"
},
"other": {
"description": "補充欄位, 可填入其它要補充的利息資訊",
"type": "string"
}
}
}
開戶資格的細項訊息
{
"type": "object",
"properties": {
"minimumAmount": {
"description": "最低存款金額, 單位為元, ex:1000",
"type": "string"
},
"document": {
"description": "開戶所需文件,可以任意key value pair, ex:類型名稱:對應細項文件之類的",
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#\/definitions\/depositDocument"
}
}
}
}
}
開戶相關文件
{
"type": "object",
"properties": {
"name": {
"description": "文件名稱, ex:xxx申請書",
"type": "string"
},
"docUrl": {
"description": "文件可供存取的網址",
"type": "string"
},
"otherInfo": {
"description": "其它對文件的補充資訊",
"type": "string"
}
}
}