其他銀行服務

Open Banking_OtherService 1.0.0

取得Open Banking 產品相關資訊

production
development
https://openapi-sandbox.esunbank.com.tw/sandbox

路徑

/currency/list

get /currency/list
otherService

銀行提供的外幣幣別列表

查詢外幣幣別列表,key value對應, key是外幣幣別中文名, value是幣別對應的查詢用參數

X-STAN
header 中的必要項目
string

客戶端發送Request記錄的處理序號

{
    "pattern": "^[0-9]{7}$",
    "default": "1234567"
}
X-DestinationId
header 中的必要項目
string

TXN destination institute ID, 指參加單位代號, 例如：銀行代號

{
    "pattern": "^[0-9]{7}$",
    "default": "8080000"
}
X-ClientId
header 中的必要項目
string

client App 註冊於Open Banking GateWay的id

{
    "default": "user"
}
X-TxnInitDateTime
header 中的必要項目
string

TXN initiate date and time, 交易發起日期時間, 格式yyyyMMddhhmmss

{
    "pattern": "^[0-9]{14}$",
    "default": "20200702000000"
}
Accept
header中的選用項目
string
application/json
200

回應成功

appCurrencyList
範例要求
範例回應
回應資料僅供測試使用，如需串接真實資料，請至首頁留下聯繫資訊，將有專人與您聯繫。
GET https://openapi-sandbox.esunbank.com.tw/sandbox/openAPI/v1.0.0/otherService/currency/list
嘗試此作業
https://openapi-sandbox.esunbank.com.tw/sandbox/openAPI/v1.0.0/otherService/currency/list
accept
X-STAN
X-DestinationId
X-ClientId
X-TxnInitDateTime

/projectProduct/list

get /projectProduct/list
otherService

專案性質金融商品列表

查詢專案性質之金融商品名稱列表,key value對應, key是產品中文名, value是查詢用參數

X-STAN
header 中的必要項目
string

客戶端發送Request記錄的處理序號

{
    "pattern": "^[0-9]{7}$",
    "default": "1234567"
}
X-DestinationId
header 中的必要項目
string

TXN destination institute ID, 指參加單位代號, 例如：銀行代號

{
    "pattern": "^[0-9]{7}$",
    "default": "8080000"
}
X-ClientId
header 中的必要項目
string

client App 註冊於Open Banking GateWay的id

{
    "default": "user"
}
X-TxnInitDateTime
header 中的必要項目
string

TXN initiate date and time, 交易發起日期時間, 格式yyyyMMddhhmmss

{
    "pattern": "^[0-9]{14}$",
    "default": "20200702000000"
}
Accept
header中的選用項目
string
application/json
200

回應成功

appProjectProductList
範例要求
範例回應
回應資料僅供測試使用，如需串接真實資料，請至首頁留下聯繫資訊，將有專人與您聯繫。
GET https://openapi-sandbox.esunbank.com.tw/sandbox/openAPI/v1.0.0/otherService/projectProduct/list
嘗試此作業
https://openapi-sandbox.esunbank.com.tw/sandbox/openAPI/v1.0.0/otherService/projectProduct/list
accept
X-STAN
X-DestinationId
X-ClientId
X-TxnInitDateTime

/safeDepositBoxes

get /safeDepositBoxes
otherService

查詢保管箱相關資訊

查詢保管箱相關資訊, 以郵遞區號查詢該區銀行有的保管箱

X-STAN
header 中的必要項目
string

客戶端發送Request記錄的處理序號

{
    "pattern": "^[0-9]{7}$",
    "default": "1234567"
}
X-DestinationId
header 中的必要項目
string

TXN destination institute ID, 指參加單位代號, 例如：銀行代號

{
    "pattern": "^[0-9]{7}$",
    "default": "8080000"
}
X-ClientId
header 中的必要項目
string

client App 註冊於Open Banking GateWay的id

{
    "default": "user"
}
X-TxnInitDateTime
header 中的必要項目
string

TXN initiate date and time, 交易發起日期時間, 格式yyyyMMddhhmmss

{
    "pattern": "^[0-9]{14}$",
    "default": "20200702000000"
}
zipCode
query 中的必要項目
string

請参考郵局行政區代號(3碼)

{
    "pattern": "^[0-9]{3}$|^[all]{3}$"
}
Accept
header中的選用項目
string
application/json
200

回應成功

appSafeDepositBox
範例要求
範例回應
回應資料僅供測試使用，如需串接真實資料，請至首頁留下聯繫資訊，將有專人與您聯繫。
GET https://openapi-sandbox.esunbank.com.tw/sandbox/openAPI/v1.0.0/otherService/safeDepositBoxes
嘗試此作業
https://openapi-sandbox.esunbank.com.tw/sandbox/openAPI/v1.0.0/otherService/safeDepositBoxes
accept
X-STAN
X-DestinationId
X-ClientId
X-TxnInitDateTime
zipCode

/branches

get /branches
otherService

查詢該銀行分行資訊

查詢所有可提供的分行資訊

X-STAN
header 中的必要項目
string

客戶端發送Request記錄的處理序號

{
    "pattern": "^[0-9]{7}$",
    "default": "1234567"
}
X-DestinationId
header 中的必要項目
string

TXN destination institute ID, 指參加單位代號, 例如：銀行代號

{
    "pattern": "^[0-9]{7}$",
    "default": "8080000"
}
X-ClientId
header 中的必要項目
string

client App 註冊於Open Banking GateWay的id

{
    "default": "user"
}
X-TxnInitDateTime
header 中的必要項目
string

TXN initiate date and time, 交易發起日期時間, 格式yyyyMMddhhmmss

{
    "pattern": "^[0-9]{14}$",
    "default": "20200702000000"
}
zipCode
query 中的必要項目
string

請参考郵局行政區代號(3碼), 或帶 all, 海外分行全帶all

{
    "pattern": "^[0-9]{3}$|^[all]{3}$"
}
countryCode
query 中的必要項目
string

國別碼，長度2碼，請参考央行提供的國別碼

{
    "pattern": "^[A-Za-z]{2}$"
}
Accept
header中的選用項目
string
application/json
200

回應成功

appBranch
範例要求
範例回應
回應資料僅供測試使用，如需串接真實資料，請至首頁留下聯繫資訊，將有專人與您聯繫。
GET https://openapi-sandbox.esunbank.com.tw/sandbox/openAPI/v1.0.0/otherService/branches
嘗試此作業
https://openapi-sandbox.esunbank.com.tw/sandbox/openAPI/v1.0.0/otherService/branches
accept
X-STAN
X-DestinationId
X-ClientId
X-TxnInitDateTime
zipCode
countryCode

/atms

get /atms
otherService

查詢該銀行ATM資訊

所有可提供的ATM資訊

X-STAN
header 中的必要項目
string

客戶端發送Request記錄的處理序號

{
    "pattern": "^[0-9]{7}$",
    "default": "1234567"
}
X-DestinationId
header 中的必要項目
string

TXN destination institute ID, 指參加單位代號, 例如：銀行代號

{
    "pattern": "^[0-9]{7}$",
    "default": "8080000"
}
X-ClientId
header 中的必要項目
string

client App 註冊於Open Banking GateWay的id

{
    "default": "user"
}
X-TxnInitDateTime
header 中的必要項目
string

TXN initiate date and time, 交易發起日期時間, 格式yyyyMMddhhmmss

{
    "pattern": "^[0-9]{14}$",
    "default": "20200702000000"
}
zipCode
query 中的必要項目
string

請参考郵局行政區代號(3碼)

{
    "pattern": "^[0-9]{3}$|^[all]{3}$"
}
Accept
header中的選用項目
string
application/json
200

回應成功

appAtm
範例要求
範例回應
回應資料僅供測試使用，如需串接真實資料，請至首頁留下聯繫資訊，將有專人與您聯繫。
GET https://openapi-sandbox.esunbank.com.tw/sandbox/openAPI/v1.0.0/otherService/atms
嘗試此作業
https://openapi-sandbox.esunbank.com.tw/sandbox/openAPI/v1.0.0/otherService/atms
accept
X-STAN
X-DestinationId
X-ClientId
X-TxnInitDateTime
zipCode

/exchangeRates

get /exchangeRates
otherService

查詢該銀行匯率資訊

所有可提供的匯率資訊, 僅提供當日資訊查詢

X-STAN
header 中的必要項目
string

客戶端發送Request記錄的處理序號

{
    "pattern": "^[0-9]{7}$",
    "default": "1234567"
}
X-DestinationId
header 中的必要項目
string

TXN destination institute ID, 指參加單位代號, 例如：銀行代號

{
    "pattern": "^[0-9]{7}$",
    "default": "8080000"
}
X-ClientId
header 中的必要項目
string

client App 註冊於Open Banking GateWay的id

{
    "default": "user"
}
X-TxnInitDateTime
header 中的必要項目
string

TXN initiate date and time, 交易發起日期時間, 格式yyyyMMddhhmmss

{
    "pattern": "^[0-9]{14}$",
    "default": "20200702000000"
}
currency
query 中的必要項目
array

幣別碼，長度3碼，Ex:TWD/USD等, 用逗號區隔多種幣別查詢

{
    "items": {
        "type": "string"
    },
    "collectionFormat": "csv"
}
Accept
header中的選用項目
string
application/json
200

回應成功

appExchangeRate
範例要求
範例回應
回應資料僅供測試使用，如需串接真實資料，請至首頁留下聯繫資訊，將有專人與您聯繫。
GET https://openapi-sandbox.esunbank.com.tw/sandbox/openAPI/v1.0.0/otherService/exchangeRates
嘗試此作業
https://openapi-sandbox.esunbank.com.tw/sandbox/openAPI/v1.0.0/otherService/exchangeRates
accept
X-STAN
X-DestinationId
X-ClientId
X-TxnInitDateTime
currency

/projectProducts

get /projectProducts
otherService

專案性質金融商品

依查詢專案金融商品名稱列表內的名稱所對應的value去查詢

X-STAN
header 中的必要項目
string

客戶端發送Request記錄的處理序號

{
    "pattern": "^[0-9]{7}$",
    "default": "1234567"
}
X-DestinationId
header 中的必要項目
string

TXN destination institute ID, 指參加單位代號, 例如：銀行代號

{
    "pattern": "^[0-9]{7}$",
    "default": "8080000"
}
X-ClientId
header 中的必要項目
string

client App 註冊於Open Banking GateWay的id

{
    "default": "user"
}
X-TxnInitDateTime
header 中的必要項目
string

TXN initiate date and time, 交易發起日期時間, 格式yyyyMMddhhmmss

{
    "pattern": "^[0-9]{14}$",
    "default": "20200702000000"
}
projectProductValues
query 中的必要項目
array

專案性質產品productList名稱列表所對應的value, 用逗號區隔多種名稱的value

{
    "items": {
        "type": "string"
    },
    "collectionFormat": "csv"
}
Accept
header中的選用項目
string
application/json
200

回應成功

appProjectProduct
範例要求
範例回應
回應資料僅供測試使用，如需串接真實資料，請至首頁留下聯繫資訊，將有專人與您聯繫。
GET https://openapi-sandbox.esunbank.com.tw/sandbox/openAPI/v1.0.0/otherService/projectProducts
嘗試此作業
https://openapi-sandbox.esunbank.com.tw/sandbox/openAPI/v1.0.0/otherService/projectProducts
accept
X-STAN
X-DestinationId
X-ClientId
X-TxnInitDateTime
projectProductValues

定義

正確查詢保管箱資訊回應的資料模型

{
    "type": "object",
    "properties": {
        "appRepBody": {
            "$ref": "#\/definitions\/safeBoxRef"
        },
        "appRepExtension": {
            "description": "擴充欄位，可以任意key value pair",
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        }
    }
}

保管箱資訊

{
    "type": "object",
    "properties": {
        "safeDepositBox": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/safeDepositBox"
            }
        }
    }
}

保管箱資訊資料模型

{
    "type": "object",
    "properties": {
        "updateTime": {
            "description": "資料更新時間，格式：yyyyMMddhhmmss，Ex:20190101210900",
            "type": "string"
        },
        "spec": {
            "description": "保管箱箱號",
            "type": "string"
        },
        "boxType": {
            "$ref": "#\/definitions\/safeBoxType"
        },
        "eligibility": {
            "$ref": "#\/definitions\/safeBoxEligibility"
        },
        "rent": {
            "$ref": "#\/definitions\/safeBoxFee"
        }
    }
}

保管箱種類

{
    "type": "object",
    "properties": {
        "size": {
            "description": "大小",
            "type": "string"
        },
        "location": {
            "description": "保管箱所在分行地址",
            "type": "string"
        },
        "other": {
            "description": "其它欄位，可以任意key value pair做為補充",
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        }
    }
}

保管箱申請資格

{
    "type": "object",
    "properties": {
        "ageRequired": {
            "description": "年齡規定",
            "type": "string"
        },
        "identityProof": {
            "description": "身份證明",
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "otherProof": {
            "description": "其它證明",
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        }
    }
}

保管箱收費

{
    "type": "object",
    "properties": {
        "rent": {
            "description": "租金",
            "type": "string"
        },
        "margin": {
            "description": "保證金",
            "type": "string"
        },
        "otherFee": {
            "description": "其它費用",
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        }
    }
}

BankAPI回應的分行資訊

{
    "type": "object",
    "properties": {
        "appRepBody": {
            "$ref": "#\/definitions\/branchRef"
        },
        "appRepExtension": {
            "description": "擴充欄位，可以任意key value pair",
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        }
    }
}

分行資訊加上國別

{
    "type": "object",
    "properties": {
        "countryCode": {
            "description": "國別碼，長度2碼，請参考央行提供的國別碼",
            "type": "string"
        },
        "branches": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/branch"
            }
        }
    }
}

分行資訊

{
    "type": "object",
    "properties": {
        "updateTime": {
            "description": "資料更新時間，格式：yyyyMMddhhmmss，Ex:20190101210900",
            "type": "string"
        },
        "branchName": {
            "$ref": "#\/definitions\/branchName"
        },
        "location": {
            "$ref": "#\/definitions\/branchlocation"
        },
        "branchService": {
            "description": "分行提供的服務, ex:存款\/提款\/匯款、財富管理、消金\/企金、外匯指定、保險箱、補摺機",
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "accessibility": {
            "description": "分行提供的進出方便性, 例如：無障礙服務\/戶外行動分行",
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "branchBasicInfo": {
            "$ref": "#\/definitions\/branchBasicInfo"
        }
    }
}

提供分行名稱相關資訊

{
    "type": "object",
    "properties": {
        "branchName": {
            "description": "分行名稱",
            "type": "string"
        },
        "branchCode": {
            "description": "分行代號",
            "type": "string"
        }
    }
}

提供位置相關資訊

{
    "type": "object",
    "properties": {
        "zipCode": {
            "description": "郵遞區號(用於代表區域)",
            "type": "string"
        },
        "coordinate": {
            "$ref": "#\/definitions\/coordinate"
        },
        "address": {
            "$ref": "#\/definitions\/address"
        }
    }
}

提供經、緯度資訊

{
    "type": "object",
    "properties": {
        "longitude": {
            "description": "經度",
            "type": "string"
        },
        "latitude": {
            "description": "緯度",
            "type": "string"
        }
    }
}

提供中英文地址資訊

{
    "type": "object",
    "properties": {
        "chinese": {
            "description": "中文地址",
            "type": "string"
        },
        "english": {
            "description": "英文地址",
            "type": "string"
        }
    }
}

提供分行基本資訊

{
    "type": "object",
    "properties": {
        "openingTimes": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/branchServiceTime"
            }
        },
        "serviceNumber": {
            "type": "string",
            "description": "客服服務電話"
        },
        "faxNumber": {
            "description": "傳真號碼",
            "type": "string"
        },
        "swiftCode": {
            "description": "SWIFT Code(國外使用)",
            "type": "string"
        }
    }
}

營業時間相關資訊

{
    "type": "object",
    "properties": {
        "openingDay": {
            "description": "每周裡的營業日",
            "type": "string",
            "enum": [
                "ㄧ",
                "二",
                "三",
                "四",
                "五",
                "六",
                "七"
            ]
        },
        "openingTime": {
            "description": "營業開始時間,格式hhmm",
            "type": "string",
            "pattern": "^[0-9]{4}$"
        },
        "closingTime": {
            "description": "營業結束時間,格式hhmm",
            "type": "string",
            "pattern": "^[0-9]{4}$"
        }
    }
}

BankAPI回應ATM資訊

{
    "type": "object",
    "properties": {
        "appRepBody": {
            "$ref": "#\/definitions\/atmRef"
        },
        "appRepExtension": {
            "description": "擴充欄位，可以任意key value pair",
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        }
    }
}

ATM資訊

{
    "type": "object",
    "properties": {
        "atms": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/atm"
            }
        }
    }
}

ATM資訊model

{
    "type": "object",
    "properties": {
        "updateTime": {
            "description": "資料更新時間，格式：yyyyMMddhhmmss，Ex:20190101210900",
            "type": "string"
        },
        "atmName": {
            "$ref": "#\/definitions\/atmName"
        },
        "location": {
            "$ref": "#\/definitions\/atmLocation"
        },
        "atmServices": {
            "description": "ATM提供的服務內容,例如：存款\/提款\/轉帳\/繳費\/繳稅、補摺、跨國提款、外幣提款、行動提款(感應\/QR Code)、無卡提款、信用卡預借現金等",
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "accessibility": {
            "description": "ATM提供的服務方便性, 例如：無障礙\/供視障使用",
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "currency": {
            "description": "幣別碼，長度3碼，Ex:TWD\/USD等",
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "supprotedLanguages": {
            "description": "提供哪些語言操作介面,包含English,Chinese等",
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "atmBasicInfo": {
            "$ref": "#\/definitions\/atmBasicInfo"
        }
    }
}

提供atm名稱相關資訊

{
    "type": "object",
    "properties": {
        "atmName": {
            "description": "atm名稱",
            "type": "string"
        },
        "atmCode": {
            "description": "atm代號",
            "type": "string"
        }
    }
}

提供位置相關資訊

{
    "type": "object",
    "properties": {
        "zipCode": {
            "description": "郵遞區號(用於代表區域)",
            "type": "string"
        },
        "coordinate": {
            "$ref": "#\/definitions\/coordinate"
        },
        "address": {
            "$ref": "#\/definitions\/address"
        }
    }
}

提供atm基本資訊

{
    "type": "object",
    "properties": {
        "openingTimes": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/atmServiceTime"
            }
        },
        "serviceNumber": {
            "description": "atm使用問題客服電話",
            "type": "string"
        }
    }
}

atm營業時間相關資訊

{
    "type": "object",
    "properties": {
        "openingDay": {
            "description": "每周裡的營業日",
            "type": "string",
            "enum": [
                "ㄧ",
                "二",
                "三",
                "四",
                "五",
                "六",
                "七"
            ]
        },
        "openingTime": {
            "description": "營業開始時間,格式hhmm",
            "type": "string",
            "pattern": "^[0-9]{4}$"
        },
        "closingTime": {
            "description": "營業結束時間,格式hhmm",
            "type": "string",
            "pattern": "^[0-9]{4}$"
        }
    }
}

正確查詢幣別參數列表資訊回應的資料模型,key value對應, key是中文幣別名, value是查詢用參數

{
    "type": "object",
    "properties": {
        "appRepBody": {
            "$ref": "#\/definitions\/currencyListRef"
        },
        "appRepExtension": {
            "description": "擴充欄位，可以任意key value pair,做為補充用",
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        }
    }
}

幣別參數列表

{
    "type": "object",
    "properties": {
        "updateTime": {
            "description": "資料更新時間，格式：yyyyMMddhhmmss，Ex:20190101210900",
            "type": "string"
        },
        "currencyList": {
            "description": "幣別參數的中文名稱及查詢參數對應表",
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        }
    }
}

外匯查詢回應內容

{
    "type": "object",
    "properties": {
        "appRepBody": {
            "$ref": "#\/definitions\/exchangeRateRef"
        },
        "appRepExtension": {
            "description": "擴充欄位，可以任意key value pair",
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        }
    }
}

銀行匯率

{
    "type": "object",
    "properties": {
        "exchangeRates": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/exchangeRate"
            }
        }
    }
}

銀行匯率model

{
    "type": "object",
    "properties": {
        "updateTime": {
            "description": "資料更新時間，格式：yyyyMMddhhmmss，Ex:20190101210900",
            "type": "string"
        },
        "currency": {
            "description": "幣別碼，長度3碼，Ex:TWD\/USD等",
            "type": "string"
        },
        "currencyName": {
            "description": "幣別名稱",
            "type": "string"
        },
        "cashExchangeRate": {
            "$ref": "#\/definitions\/baseExchangeRate"
        },
        "spotExchangeRate": {
            "$ref": "#\/definitions\/baseExchangeRate"
        }
    }
}

基本匯率model

{
    "type": "object",
    "properties": {
        "sale": {
            "description": "銀行賣價",
            "type": "string"
        },
        "buy": {
            "description": "銀行買價",
            "type": "string"
        },
        "fee": {
            "description": "買賣手續費",
            "type": "string"
        }
    }
}

正確查詢專案性質之金融商品資訊回應的資料模型

{
    "type": "object",
    "properties": {
        "appRepBody": {
            "$ref": "#\/definitions\/projectProductListRef"
        },
        "appRepExtension": {
            "description": "擴充欄位，可以任意key value pair",
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        }
    }
}

專案性質之金融商品列表

{
    "type": "object",
    "properties": {
        "updateTime": {
            "description": "資料更新時間，格式：yyyyMMddhhmmss，Ex:20190101210900",
            "type": "string"
        },
        "projectProductList": {
            "description": "專案性質之金融商品的名稱對應表, key value對應, key是產品中文名, value是查詢用參數",
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        }
    }
}

正確查詢參數列表資訊回應的資料模型

{
    "type": "object",
    "properties": {
        "appRepBody": {
            "$ref": "#\/definitions\/projectProductRef"
        },
        "appRepExtension": {
            "description": "擴充欄位，可以任意key value pair",
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        }
    }
}

專案性質之金融商品相關資訊

{
    "type": "object",
    "properties": {
        "projectProduct": {
            "description": "專案性質之金融商品",
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/projectProduct"
            }
        }
    }
}

專案性質之金融商品

{
    "type": "object",
    "properties": {
        "updateTime": {
            "description": "資料更新時間，格式：yyyyMMddhhmmss，Ex:20190101210900",
            "type": "string"
        },
        "name": {
            "description": "商品名稱",
            "type": "string"
        },
        "specification": {
            "description": "說明項目",
            "type": "object",
            "additionalProperties": {
                "type": "array",
                "items": {
                    "$ref": "#\/definitions\/projectProductDetail"
                }
            }
        }
    }
}

專案性質之金融商品

{
    "type": "object",
    "properties": {
        "detailName": {
            "description": "細項名稱",
            "type": "string"
        },
        "detailText": {
            "description": "細項說明",
            "type": "string"
        },
        "other": {
            "description": "對細項其它補充",
            "type": "string"
        }
    }
}