HK
该应用程序界面（API）是本公司 国际银行账号（IBAN）组件 的组成部分
应用程序界面（API）整合指南
1.什么是国际银行账号（IBAN）计算应用程序界面（API）？
国际银行账号（IBAN）计算（AKA国际银行账号（IBAN）转换）引擎是一个软件系统。借助该系统，客户可以将国内银行代码（BIC）和账号一并转换为经过验证的国际银行账号（IBAN)。借助该系统，客户可以手动方式通过接口和应用程序界面（API），实现该系统与其公司内部系统的整合。
此外，客户还可利用该系统识别银行和金融机构，并获知其详细信息。
2. 特点
本公司国际银行账号（IBAN）计算引擎的部分关键特点如下所示：- 验证当地银行代码（BIC）/账号校验和(*参见支持国家)
- 依据当地银行/分支机构代码，检索银行信息。
- 自动生成适用于所支持银行/分支机构代码和账号的有效国际银行账号（IBAN)格式。
- 系统支持多种响应格式(JSON/XML)。
3. 支持国家
目前，国际银行账号（IBAN）计算应用程序界面（API)支持国家，及该界面完成国际银行账号（IBAN）计算所需字段如下所示：| 国家代码 | 国家名称 | 银行代码 | 分行 | 账户 | **校验码 ** |
|---|---|---|---|---|---|
| AT | 奥地利 | 是 | 是 | ||
| BE | 比利时 | 是YES | 是 | 是 | |
| CH | 瑞士= | 是 | 是 | ||
| DE | 德国 | 是 | 是 | ||
| EE | 爱沙尼亚 | 是 | |||
| ES | 西班牙 | 是 | 是 | 是 | 是 |
| FI | 芬兰 | 是 | 是 | ||
| FR | 法国 | 是 | 是 | 是 | 是 |
| GB | 英国 | 是 | 是 | 是 | |
| HU | 匈牙利 | 是 | 是 | ||
| IE | 爱尔兰 | 是 | 是 | 是 | |
| IT | 意大利 | 是 | 是 | 是 | 是 |
| MC | 摩纳哥 | 是 | 是 | 是 | 是 |
| MR | 毛里塔尼亚 | 是 | 是 | 是 | |
| MT | 马耳他 | 是 | 是 | ||
| NO | 挪威 | 是 | 是 | ||
| PT | 葡萄牙 | 是 | 是 | 是 | 是 |
| SM | 圣马力诺 | 是 | 是 | 是 | |
| CZ | 捷克共和国 | 是 | 是 | 是 | |
| AL | 阿尔巴尼亚 | 是 | 是 | ||
| SK | 斯洛伐克共和国 | 是 | 是 | 是 | |
| SI | 斯洛文尼亚 | 是 | 是 | 是 | |
| PL | 波兰 | 是 | 是 | 是 | |
| PK | 巴基斯坦 | 是 | 是 | ||
| SE | 瑞典 | 是 | 是 | 是 | |
| NL | 荷兰 | 是 | 是 |
校验码验证是附加的数据完整保护层，用于防止输入错误。
4.应用程序界面（API）输入
该界面认可用于输入数据的HTTP GET和POST 请求。认可参数如下表所示
| 字段名称 | 类型 | 说明 |
|---|---|---|
| api_秘钥 | 字符串 | 您专属的应用程序界面（API）秘钥。包含在客户区内。 |
| 格式 | 字符串 | 应用程序界面（API）响应格式（xml或json） |
| 国家 | 字符串 | 2个字母组成的国家代码（如UK/US/DE/FR) |
| 银行代码 | 字符串 | 银行唯一标识，其提供要求因不同国家而不同。（选择提供）部分国家仅需提供账号。 |
| 分行 | 字符串 | 当地分行的唯一标识（选择提供） |
| 账户 | 字符串 | 个人账号 |
| 校验码 | 整数 | 部分国家使用校验码。 |
| 前置代码 | 整数 | 目前仅捷克共和国要求提供（选择提供）。 |
为了更便捷地实现软件整合，该界面支持多种响应格式。目前支持的格式包括XML和JSON。
国家参数必须包含由2个字母构成的ISO国家代码，如UK代表英国，DE代表德国，FR代表法国......
不同的国家的银行代码（BIC）长度不同,构成不同。
分行代码是可选择提供的参数，仅部分国家要求提供（参见示例）。
所有国家都要求提供账号。有时，账号是计算国家银行代码（IBAN）的唯一参数。
只有将验证算法纳入了本国国内银行账号构成的特定国家，才要求提供校验码（参见示例）。
前置代码是按要求选择性提供的字段，仅用于捷克共和国国际银行代码（IBAN）计算。
5.应用程序界面（API）示例
利用该应用程序界面（API）针对每一个国家获取查询的示例如下。| 国家 | 查询示例（获取请求） |
|---|---|
| AT | ?国家=AT&格式=json&银行代码=12000&账号=52700357958 |
| BE | ?国家=BE&格式=json&银行代码=250&账号=0135106&校验码=70 |
| CH | ?国家=CH&格式=json&银行代码=0240&账号=240C08011570 |
| DE | ?国家=DE&格式=json&银行代码=BLZ37010050&账号=399509 |
| EE | ?国家=EE&格式=json&账号=55000005511439 |
| ES | ?国家=ES&格式=json&银行代码=0081&分行=1731&校验码=91&账号=0006040912 |
| FI | ?国家=FI&格式=json&账号=52900261901092 |
| FR | ?国家=FR&格式=json&银行代码=30056&分行=00264&账号=02640016443 |
| GB | ?国家=GB&格式=json&银行代码=090127&账号=93496333 |
| HU | ?国家=HU&格式=json&账号=107000240416330551100005 |
| IE | ?国家=IE&格式=json&银行代码=905838&账号=71924374 |
| IT | ?国家=IT&格式=json&国家=IT&银行代码=02008&分支机构=30545&账号=000103685854 |
| MC | ?国家country=MC&格式=json&国家=MC&银行代码=30002&分行=03260&账号=0000079112A |
| MR | ?国家=MR&格式=json&银行代码=00012&分行=00001&账号=00000078326 |
| MT | ?国家=MT&格式=json&银行代码=07113&账号=199008240010 |
| NO | ?国家=NO&格式=json&账号=96803502045 |
| PT | ?国家=PT&格式=json&银行代码=0038&分行=0000&校验码=81&账号=39551148771 |
| PK | ?国家=PK&格式=json&银行代码=HABBPKKA&账号=39551148771 |
| SE | ?国家=SE&格式=json&银行代码=9150&账号=0092395696 |
| SM | ?国家=SM&格式=json&国家=SM&银行代码=03034&分行=09800&账号=000060164676 |
| CZ | ?国家=CZ&格式=json&前置代码=51&账号=1707230277&银行代码=0100 |
| AL | ?国家=AL&格式=json&银行代码=20511117&账号=374362CLPRCFEURC |
| SK | ?国家=SK&格式=json&前置代码=&账号=4110053902&银行代码=3100 |
| SI | ?国家=SI&格式=json&银行代码=33000&账号=0000102423 |
| PL | ?国家=PL&格式=xml&银行代码=11402004&账号=0000360275244226 |
| SE | ?国家=SE&格式=json&银行代码=9300&账号=5913222524 |
| NL | ?国家=NL&格式=json&账号=0006642318 |
6. 应用程序界面（API）XML响应架构
可能返回字段的详细说明参见下表：| 字段名称 | 类型 | 说明 |
|---|---|---|
| 地址 | 字符串 | 银行分行或总行的地址 |
| 银行 | 字符串 | 银行或金融机构的名称 |
| 银行代码（BIC） | 字符串 | 银行的BIC ( 银行代码 ) |
| 分行 | S字符串 | 银行代码（BIC）对应的分行名称 |
| 城市 | 字符串 | 分行所在城市的名称 |
| 国家 | 字符串 | 由两个字母组成的国家代码缩写，如US、UK、AU与FR等。 |
| 电子邮箱 | 字符串 | 银行或分行制定联系用电子邮件地址。 |
| 传真号 | 字符串 | 银行/分行的传真号码 |
| 电话号码 | 字符串 | 银行/分行联系电话号码 |
| 州 | 字符串 | 银行/分行地址所在州 |
| 网站 | 字符串 | 银行/分行的网址 |
| 邮编 | 字符串 | 银行分行地址的邮编或邮政代码 |
使用该界面搜索英国分类代码和账号返回XML格式结果的示例如下
查询URL:
?api_key=9834hAHx78ba4g8habsdk&country=GB&format=json&bankcode=110377&account=10218962
<结果>
<国际银行账号（IBAN）>GB20ULSB98006054100029</国际银行账号（IBAN）>
<账号>54100029</账号>
<分类_代码>980060</分类_代码>
<银行>爱尔兰阿尔斯特银行有限公司</银行>
<分行>贝尔法斯特市一分行</分行>
<银行代码（BIC）>ULSBGB2BXXX</银行代码（BIC）>
<地址>PO BOX 232 11-16 DONEGALL SQUARE EAST </地址>
<城市>BT1 5UB</城市>
<国家>GB<国家/>
<电话>028 90244112</电话>
</结果>
当用户指定以JSON格式返回结果时，针对同样查询的响应如下：
"国际银行账号（IBAN）":"GB20ULSB98006054100029","账号":"54100029",">分类_代码":"980060","银行":"爱尔兰艾尔斯特银行有限公司","分行":"贝尔法斯特市1分行","银行代码（BIC）":"ULSBGB2BXXX","地址":"PO BOX 232 11-16 DONEGALL SQUARE EAST ","城市":"BT1 5UB","国家":"GB","电话":"028 90244112"
7. 应用程序界面（API）出错
出错时，国际银行账号（IBAN）计算应用程序界面（API）将返回包含错误信息的一个XML或JSON响应。<错误></错误> 返回的XML标签不包含XML响应中的任何其他字段
可能返回的所有可能错误信息的说明如下所示
<出错>账号校验无效。</出错>
<出错>账号（校验和）不正确。</出错>
<出错>账号必须包含11个字符。</出错>
<出错>账号必须包含14个字符。</出错>
<出错>账号必须包含24个字符。</出错>
<出错>账号无效</出错。>
<出错>分类代码账号无效。</出错>
<出错>账号前置代码过长。</出错>
<出错>账号过长。</出错>
<出错>银行/分行代码/KIB（校验和）不正确。</出错>
<出错>银行代码/分行代码/账号过长。</出错>
<出错>银行代码/分行代码(校验和)不正确。</出错>
<出错>银行代码无效。</出错>
<出错>银行代码过长。</出错>
<出错>未找到银行。</出错>
<出错>银行无法识别Bank Not Recognized</出错error>
<出错>银行基本账号/银行代码(校验和)不正确。</出错>
<出错>银行代码无效。</出错>
<出错>分行/代理机构未找到。</出错>
<出错>分行代码过长。</出错>
<出错>分行未找到</出错>
<出错>校验码过长。</出错>
<出错>清算行国际代码/账号无效。校验码不正确</出错>
<出错>清算行国际代码/账号无法识别。无法计算出国际银行账号（IBAN）。</出错>
<出错>清算行国际代码或账号过长。</出错>
<出错>银行代码无效</出错>
<出错>分行代码无效</出错>
<出错>国家代码无效</出错>
<出错>国家或银行不受支持</出错>
<出错>国际银行账号（IBAN ）无效 </出错>
<出错>银行账号/账号无效</出错>
<出错>字段遗失</出错>
<出错>不是法国国际银行代码（IBAN）</出错>
<出错>不是采用法国国际银行代码（IBAN）的国家</出错>
<出错>要求字段遗失。请输入银行代码和账号。</出错>
<出错>未提交要求提交的字段</出错>
<出错>银行账户证明（RIB）无效</出错>
<出错>分类代码/银行代码无法识别。无法计算出国际银行账号（IBAN）。 </出错>
<出错>分类代码未找到</出错>