此API是我们< IBAN套装 s服务的一部分
API集成指南
1. 什么是IBAN计算API?
BAN计算（AKA IBAN转换）引擎是一个软件系统，允许我们的客户将国内银行代码和账号组合转换为经过验证的国际银行账号（IBAN）。该系统允许我们的客户手动界面和API，以允许集成到他们公司的内部系统。
该系统还可识别银行和金融机构，并向客户提供详细信息。
2. 功能
以下是我们的IBAN计算引擎的一些主要功能：- 验证本地银行代码/帐号校验和（*请参阅支持的国家）
- 根据当地银行/分行代码检索有关银行的信息。
- 自动为提供的银行/分行代码和帐号生成有效的IBAN格式。
- 系统支持多种响应格式（( JSON / XML )
3. 支持的国家
IBAN 计算API目前支持以下国家以及我们的API计算IBAN所需的字段。| 国家代码 | 国家名称 | 银行代码 | 分行 | 帐户 | 校验位** |
|---|---|---|---|---|---|
| AT | 奥地利 | 是 | 是 | ||
| BE | 比利时 | 是 | 是 | 是 | |
| 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输入
API接受输入数据的HTTP GET和POST请求 接受的参数列在下表中：| 字段名称 | 类型 | 描述n |
|---|---|---|
| api_key | 字串 | 您的个人API密钥。 在客户区获得。. |
| 格式 | 字串 | API响应格式（xml或json） |
| 国家 | 字串 | 2个字母的国家代码（英国/美国/ DE / FR） |
| 银行代码 | 字串 | 唯一的银行标识符。每个国家都不同。 （ 可选 ）。有些国家只需帐号。 |
| 分行 | 字串 | 唯一的本地分行标识符（可选） |
| 帐户 | 字串 | 个人帐号 |
| cd | 整数 | 检查某些国家/地区使用的数字。 |
| 前缀 | 整数 | 目前只需要捷克共和国（可选） |
API支持多种响应格式，以便更轻松地进行集成。目前，支持XML和JSON。
国家参数必须包含2个字母的ISO国家代码，例如英国UK，德国DE，法国FR…
银行代码对每个国家都有不同的长度和结构。
分行代码是可选参数，仅在某些国家/地区需要（参见示例）
所有国家都需要帐号，在某些情况下，它是用于计算IBAN的唯一参数。
只有在国内银行帐号结构中包含此类验证算法的某些国家才需要校验位。 （参考例子）
前缀是仅可用于捷克共和国IBAN计算的字段。
5. API示例
在下表中，您可以找到针对每个国家 API的示例工作并获取查询| 国家 | 示例查询 (获取请求) |
|---|---|
| AT | ?country=AT&format=json&bankcode=12000&account=52700357958 |
| BE | ?country=BE&format=json&bankcode=250&account=0135106&cd=70 |
| CH | ?country=CH&format=json&bankcode=0240&account=240C08011570 |
| DE | ?country=DE&format=json&bankcode=BLZ37010050&account=399509 |
| EE | ?country=EE&format=json&account=55000005511439 |
| ES | ?country=ES&format=json&bankcode=0081&branch=1731&cd=91&account=0006040912 |
| FI | ?country=FI&format=json&account=52900261901092 |
| FR | ?country=FR&format=json&bankcode=30056&branch=00264&account=02640016443 |
| GB | ?country=GB&format=json&bankcode=090127&account=93496333 |
| HU | ?country=HU&format=json&account=107000240416330551100005 |
| IE | ?country=IE&format=json&bankcode=905838&account=71924374 |
| IT | ?country=IT&format=json&country=IT&bankcode=02008&branch=30545&account=000103685854 |
| MC | ?country=MC&format=json&country=MC&bankcode=30002&branch=03260&account=0000079112A |
| MR | ?country=MR&format=json&bankcode=00012&branch=00001&account=00000078326 |
| MT | ?country=MT&format=json&bankcode=07113&account=199008240010 |
| NO | ?country=NO&format=json&account=96803502045 |
| PT | ?country=PT&format=json&bankcode=0038&branch=0000&cd=81&account=39551148771 |
| PK | ?country=PK&format=json&bankcode=HABBPKKA&account=39551148771 |
| SE | ?country=SE&format=json&bankcode=9150&account=0092395696 |
| SM | ?country=SM&format=json&country=SM&bankcode=03034&branch=09800&account=000060164676 |
| CZ | ?country=CZ&format=json&prefix=51&account=1707230277&bankcode=0100 |
| AL | ?country=AL&format=json&bankcode=20511117&account=374362CLPRCFEURC |
| SK | ?country=SK&format=json&prefix=&account=4110053902&bankcode=3100 |
| SI | ?country=SI&format=json&bankcode=33000&account=0000102423 |
| PL | ?country=PL&format=xml&bankcode=11402004&account=0000360275244226 |
| SE | ?country=SE&format=json&bankcode=9300&account=5913222524 |
| NL | ?country=NL&format=json&account=0006642318 |
6. API XML响应结构
返回的可能字段的详细说明可以在下表中看到：| 字段名称 | 类型 | 描述 |
|---|---|---|
| 地址 | 字串 | 银行分行或总部的地址 |
| 银行 | 字串 | 银行或金融机构的名称 |
| bic | 字串 | 银行的BIC（银行标识符代码） |
| 分行 | 字串 | 由银行代码标识的分行名称 |
| 城市 | 字串 | 分行所在城市的名称 |
| 国家 | 字串 | 国家代码的两个字母缩写，如US, UK, AU, FR …等等。. |
| 电子邮件 | 字串 | 指定银行或分行的联系电子邮件地址 |
| 传真 | 字串 | 银行/分行的传真号码 |
| 电话 | 字串 | 联系银行/分行的电话号码 |
| 状态 | 字串 | 银行/分行地址的状态 |
| 网站 | 字串 | 银行/分行的网址 |
| 邮编 | 字串 | 银行分行地址的邮政编码或邮政编码 |
来自API的英国SORT代码和帐号搜索的XML回复样本将是：
查询网址：
?api_key=9834hAHx78ba4g8habsdk&country=GB&format=json&bankcode=110377&account=10218962
<result>
<iban>GB20ULSB98006054100029</iban>
<account>54100029</account>
<sort_code>980060</sort_code>
<bank>ULSTER BANK LTD</bank>
<branch>BELFAST CITY OFFICE 1</branch>
<bic>ULSBGB2BXXX</bic>
<address>PO BOX 232 11-16 DONEGALL SQUARE EAST </address>
<city>BT1 5UB</city>
<country>GB<country/>
<phone>028 90244112</phone>
</result>
The response for the same query if user specified a JSON formatting will be:
"iban":"GB20ULSB98006054100029","account":"54100029","sort_code":"980060","bank":"ULSTER BANK LTD","branch":"BELFAST CITY OFFICE 1","bic":"ULSBGB2BXXX","address":"PO BOX 232 11-16 DONEGALL SQUARE EAST ","city":"BT1 5UB","country":"GB","phone":"028 90244112"
7. API错误
如果出现错误，IBAN Calculation API将返回包含错误消息的XML或JSON响应The <error></error> 返回XML标记时，XML响应中没有任何其他字段。
您可以在下面找到可能返回的所有可能错误消息的说明：
<error>Account 帐号校验和无效。</error>
<error>帐号（校验）不正确。</error>
<error>帐号必须为11个字符long</error>
<error>帐号必须为14个字符 long</error>
<error>A帐号必须为24个字符 long</error>
<error>帐号无效</error>
<error> 帐号代码的帐号无效</error>
<error> 帐号前缀太长g.</error>
<error> 帐号过长。</error>
<error> 银行/分行代码/ KIB（校验）不正确。</error>
<error> 银行代码/分行代码/帐号太长。</error>
<error> 银行代码/分行代码（校验和）不正确。</error>
<error> 银行代码无效 </error>
<error> 银行代码过长.</error>
<error> 未找到银行</error>
<error> 银行无法识别</error>
<error> BBAN / NIB（校验）不正确。</error>
<error> BLZ /银行代码无效</error>
<error> 未找到分行 / Agencia</error>
<error> 分行代码过长。</error>
<error> 未找到分行 </error>
<error> 校验码过长</error>
<error> Clearingnummer /帐号无效。检查数字不正确。</error>
<error> 无法识别Clearingnummer / 银行代码。无法计算IBAN。</error>
<error> Clearingnummer或帐号过长。</error>
<error> Codice ABI della Banca /银行代码无效</error>
<error> Codice CAB della Filiale /分行代码无效</error>
<error> ;国家代码无效</error>
<error> 国家或银行不受支持</error>
<error> BAN无效</error>
<error>Kontonummer /帐号无效</error>
<error> 缺少字段</error>
<error> 非FR IBAN </error>
<error> 非FR IBAN国家</error>
<error> 缺少必填字段。请输入银行代码和帐号</error>
<error> ;未提交必填字段。</error>
<error> RIB无效</error>
<error> 无法识别排序代码/银行代码。无法计算IBAN。</error>
<error>S无法找到排序代码</error>