JP
このAPIは IBAN Suite サービスの一部です。
API統合ガイド
1. IBAN計算APIとは何か？
IBAN計算（AKA IBAN変換）エンジンは、お客様が国内の銀行コードと口座番号の組み合わせを有効な国際銀行口座番号（IBAN）に変換できるようにするソフトウェアシステムです。システムは私たちの顧客が彼らの会社の内部システムへの取り込みを可能にするためにAPIと同様に手動インターフェイスを可能にする。
このシステムはまた、銀行や金融機関を識別し、詳細をお客様に提供します。
2. 機能
以下は、IBAN計算エンジンの主な機能の一部です。:- 現地の銀行コード/口座番号のチェックサムを確認します（*サポートされている国を参照）。
- 現地の銀行/支店コードに基づいて銀行に関する情報を取得します。
- 指定された銀行/支店コードと口座番号に対して有効なIBANフォーマットを自動的に生成します。
- システムは複数回答フォーマット（JSON / XML）をサポートします。
3. サポートされている国
IBAN Calculation APIは現在、次の国と、IBANを計算するためにAPIが必要とするフィールドをサポートしています。| 国コード | 国名 | 銀行コード | 支店 | アカウント | チェックデジット ** |
|---|---|---|---|---|---|
| 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の両方の要求を受け入れます。許容されるパラメータは以下の表のとおりです。:
| フィールド名 | タイプ | 説明 |
|---|---|---|
| api_key | 文字列 | あなたの個人的なAPIキー。クライアントエリアで入手したもの。 |
| format | 文字列 | APIレスポンスフォーマット（xmlまたはjson） |
| country | 文字列 | 2文字の国コード( UK/US/DE/FR ) |
| bankcode | 文字列 | 固有の銀行ID国によって異なります（オプション）。国によっては口座番号だけが必要な場合もあります。 |
| branch | 文字列 | 固有の支店識別子（オプション） |
| account | 文字列 | 個人口座番号 |
| cd | 整数 | 一部の国で使用されているチェックデジット |
| prefix | 整数 | 現在はチェコ共和国でのみ必要です（オプション） |
APIは、統合を容易にするために複数の応答フォーマットをサポートしています。現在、XMLとJSONがサポートされています。
Country引数は、イギリスの場合は英国、ドイツの場合はDE、フランスの場合はFRのように、2文字のISO国コードで構成する必要があります。
銀行コードは、国ごとに長さや構造が異なります。
支店コードはオプション引数で、一部の国でのみ必要です（例を参照）
口座番号はすべての国に必要で、場合によってはIBANの計算に使用される唯一のパラメータです。
チェックディジットは、そのような検証アルゴリズムを国内の銀行口座番号構造に組み込んでいる特定の国にのみ必要です。 （例を参照）
プレフィックスは、オプションでチェコ共和国のIBAN計算にのみ必要なフィールドです。
5. API例
以下の表では、各国のAPIに対する実用的なGETクエリの例を見つけることができます。| 国 | クエリ (リクエストを得る) |
|---|---|
| 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レスポンス構造
返される可能性のあるフィールドの詳細な説明は、下の表にあります。:| フィールド名 | タイプ | 説明 |
|---|---|---|
| 所在地 | 文字列 | 銀行支店または本社の所在地 |
| bank | 文字列 | 銀行名または金融機関名 |
| bic | 文字列 | 銀行のBIC（銀行識別コード） |
| branch | 文字列 | 銀行コードで識別される支店の名前 |
| city | 文字列 | 支店がある都市名 |
| country | 文字列 | 国コードの2文字の略語。US, UK, AU, FRなど。 |
| 文字列 | 銀行または支店の連絡先メールアドレス | |
| fax | 文字列 | 銀行/支店のFAX番号 |
| phone | 文字列 | 銀行または支店の連絡先電話番号 |
| state | 文字列 | 銀行または支店の所在地の県名 |
| website | 文字列 | 銀行または支店のウェブサイトアドレス |
| zip | 文字列 | 銀行の支店住所の郵便番号 |
イギリスのSORTコードと口座番号検索に対するAPIからのXML応答の例は次のようになります。:
クエリURL:
?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>
ユーザーがJSONフォーマットを指定した場合の同じ照会に対する応答は次のようになります。:
"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計算APIはエラーメッセージを含むXMLまたはJSON応答を返します。The <error></error> XMLタグは、XML応答の他のフィールドなしで返されます。
以下に、返される可能性があるすべてのエラーメッセージの説明を示します。:
<error>アカウント番号のチェックサムが無効です。</error>
<error>アカウント番号（チェックサム）が正しくありません。</error>
<error>アカウント番号は11文字です。</error>
<error>
アカウント番号は14文字にする必要があります。</error>
<error>アカウント番号は24文字でなければなりません。</error>
<error>アカウント番号が無効です</error>
<error>ソートコードのアカウント番号が無効です</error>
<error>
アカウント番号のプレフィックスが長すぎます。</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>決済番号/口座番号が無効です。チェックディジットが正しくありません。</error>
<error>クリアリングナンバーまたは銀行コードが識別できません。 IBANは計算できません。</error>
<error>クリアリング番号またはアカウント番号が長すぎます。</error>
<error>銀行のABIコード/銀行コードが無効です</error>
<error>支店CABコード/支店コードが無効です</error>
<error>国コードが無効です</error>
<error>国または銀行はサポートされていません。</error>
<error>IBANは無効です</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>ソートコードが見つかりません。</error>