貸款

Open Banking_Loan 1.0.0

取得Open Banking 產品相關資訊

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

路徑

/{loanType}/list

get /{loanType}/list
loan

查詢貸款類型的相關產品名稱對應的查詢參數

1.信用卡(creditCard)包括 一般卡/聯名卡/白金卡/御璽卡/無限卡/國旅卡/商務卡/認同卡/手機信用卡/其他 2.擔保貸款(securedLoan)包括 一般房貸/政府優惠房貸/以房養老/一般貸款/汽車貸款/股票質借/其他 3.無擔保貸款(noSecuredLoan)包括 一般信貸 ,key是中文名, value是對應的查詢用參數

X-STAN
header 中的必要項目
string

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

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

client App 註冊於Open Banking GateWay的id

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

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

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

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

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

貸款類型

{
    "enum": [
        "creditCard",
        "securedLoan",
        "noSecuredLoan"
    ]
}
Accept
header中的選用項目
string
application/json
200

回應成功

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

/creditCards

get /creditCards
loan

查詢信用卡類型的相關貸款資訊

包括 一般卡/聯名卡/白金卡/御璽卡/無限卡/國旅卡/商務卡/認同卡/手機信用卡/其他

X-STAN
header 中的必要項目
string

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

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

client App 註冊於Open Banking GateWay的id

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

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

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

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

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

信用卡產品productList名稱列表所對應的value, 用逗號區隔多種名稱的value

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

回應成功

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

/securedLoans

get /securedLoans
loan

查詢擔保貸款類型的相關貸款資訊

包括 一般房貸/政府優惠房貸/以房養老/汽車貸款/股票質借

X-STAN
header 中的必要項目
string

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

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

client App 註冊於Open Banking GateWay的id

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

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

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

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

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

擔保貸款產品productList名稱列表所對應的value, 用逗號區隔多種名稱的value

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

回應成功

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

/noSecuredLoans

get /noSecuredLoans
loan

查詢無擔保貸款類型的相關貸款資訊

無擔保貸款包括 一般信貸

X-STAN
header 中的必要項目
string

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

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

client App 註冊於Open Banking GateWay的id

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

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

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

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

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

無擔保貸款產品productList名稱列表所對應的value, 用逗號區隔多種名稱的value

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

回應成功

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

定義

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

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

貸款參數列資料模型, 查詢以下3類回傳中文產品名及查詢值的對應表, 1.信用卡(creditCard)包括 一般卡/聯名卡/白金卡/御璽卡/無限卡/國旅卡/商務卡/認同卡/手機信用卡/其他, 2.擔保貸款(securedLoan)包括 一般房貸/政府優惠房貸/以房養老/一般貸款/汽車貸款/股票質借/其他, 3.無擔保貸款(noSecuredLoan)包括 一般信貸

{
    "type": "object",
    "properties": {
        "updateTime": {
            "description": "資料更新時間，格式：yyyyMMddhhmmss，Ex:20190101210900",
            "type": "string"
        },
        "loanList": {
            "description": "貸款參數列表，自訂key value對應",
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        }
    }
}

貸款共通資訊

{
    "type": "object",
    "properties": {
        "updateTime": {
            "description": "資料更新時間，格式：yyyyMMddhhmmss，Ex:20190101210900",
            "type": "string"
        },
        "productName": {
            "description": "產品代號或名稱, ex:聯名卡或一般貸款之類等",
            "type": "string"
        },
        "eligibility": {
            "$ref": "#\/definitions\/loanEligibility"
        },
        "fee": {
            "description": "手續費, ex:年費\/逾期繳款違約金\/預借現金手續費\/循環\/分期\/其他",
            "type": "object",
            "additionalProperties": {
                "type": "array",
                "items": {
                    "$ref": "#\/definitions\/loanFeeDetail"
                }
            }
        },
        "other": {
            "description": "貸款擴充欄位,可以任意key value pair",
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        }
    }
}

貸款申請資格的細項訊息, 身份證明及收入證明為必要

{
    "type": "object",
    "properties": {
        "requiredAge": {
            "description": "年齡規定, ex:18歲以上",
            "type": "string"
        },
        "identityProof": {
            "description": "身份證明",
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "incomeProof": {
            "description": "收入證明",
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "otherProof": {
            "description": "其它證明",
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        }
    },
    "required": [
        "identityProof",
        "incomeProof"
    ]
}

費用細節描述, ex:信用卡有 年費/逾期繳款違約金/預借現金手續費/循環/分期/其他, 擔保貸款有 鑑價服務費/處理手續費/提前還款費用/違約金, 無擔保貸款有 徵信費/處理手續費/提前還款費用/違約金

{
    "type": "object",
    "properties": {
        "name": {
            "description": "費用名稱",
            "type": "string"
        },
        "countMethod": {
            "description": "費用計算方式, 用百分比或金額或其它方式",
            "type": "string"
        },
        "other": {
            "description": "對費用的補充描述",
            "type": "string"
        }
    }
}

正確查詢信用卡資訊回應的資料模型

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

信用卡資料加上其它資訊

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

信用卡的細項訊息

{
    "allOf": [
        {
            "$ref": "#\/definitions\/loanCommon"
        },
        {
            "type": "object",
            "properties": {
                "cardRights": {
                    "description": "產品權益,可以任意key value pair, ex:機場接送\/機場貴賓室\/停車優惠\/加油優惠\/道路救援\/電影優惠\/保險\/其他卡友權益..",
                    "type": "object",
                    "additionalProperties": {
                        "type": "array",
                        "items": {
                            "$ref": "#\/definitions\/cardRightInfo"
                        }
                    }
                },
                "cardBonus": {
                    "description": "消費獎勵相關資訊, ex:現金回饋\/紅利點數\/哩程\/其他",
                    "type": "object",
                    "additionalProperties": {
                        "type": "array",
                        "items": {
                            "$ref": "#\/definitions\/cardBonusInfo"
                        }
                    }
                }
            }
        }
    ]
}

產品權益描述

{
    "type": "object",
    "properties": {
        "name": {
            "description": "產品權益名稱",
            "type": "string"
        },
        "detail": {
            "description": "產品權益細項描述",
            "type": "string"
        },
        "other": {
            "description": "產品權益其它補充",
            "type": "string"
        }
    }
}

消費獎勵條件與比率

{
    "type": "object",
    "properties": {
        "condition": {
            "description": "獎勵條件",
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        },
        "return": {
            "description": "回饋比率或其它計算方式",
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        },
        "other": {
            "description": "消費獎勵補充說明",
            "type": "string"
        }
    }
}

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

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

擔保貸款資料加上其它資訊

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

貸款條件資訊

{
    "type": "object",
    "additionalProperties": {
        "type": "array",
        "items": {
            "$ref": "#\/definitions\/loanConditionInfo"
        }
    }
}

貸款條件說明, ex:金額/期間/利率(及其上限)/月還款金額(或其他還款頻率下之還款金額)/還款方式

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "貸款條件名稱"
        },
        "detail": {
            "type": "string",
            "description": "貸款條件細項描述"
        },
        "other": {
            "type": "string",
            "description": "貸款條件其它補充"
        }
    }
}

擔保貸款的細項訊息

{
    "allOf": [
        {
            "$ref": "#\/definitions\/loanCommon"
        },
        {
            "type": "object",
            "properties": {
                "collateral": {
                    "type": "array",
                    "items": {
                        "$ref": "#\/definitions\/collateral"
                    }
                },
                "loanCondition": {
                    "$ref": "#\/definitions\/loanCondition"
                }
            }
        }
    ]
}

抵押品的細項訊息

{
    "properties": {
        "itemType": {
            "description": "抵押品種類",
            "type": "string"
        },
        "years": {
            "description": "抵押品年限",
            "type": "string"
        },
        "other": {
            "description": "抵押品其它補充",
            "type": "string"
        }
    }
}

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

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

無擔保貸款資料加上其它資訊

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

無擔保貸款的細項訊息

{
    "allOf": [
        {
            "$ref": "#\/definitions\/loanCommon"
        },
        {
            "type": "object",
            "properties": {
                "loanCondition": {
                    "$ref": "#\/definitions\/loanCondition"
                }
            }
        }
    ]
}