DE
Diese API ist Teil unseres IBAN Suite Dienstes
API-Integrationsleitfaden
1. Was ist die IBAN-Berechnungs-API?
Die IBAN-Berechnung ("AKA IBAN-Konvertierung") ist ein Softwaresystem, mit dem unsere Kunden inländische Bankleitzahlen und Kontonummernkombinationen in validierte internationale Kontonummern ("IBAN") umwandeln können.Das System ermöglicht unseren Kunden sowohl eine manuelle Schnittstelle als auch eine API zur Integration in die internen Systeme ihres Unternehmens.
Das System identifiziert auch die Banken und Finanzinstitute und stellt die Daten unseren Kunden zur Verfügung.
2. Features
Nachfolgend finden Sie einige der wichtigsten Funktionen unserer IBAN-Berechnungsmaschine:- Lokale Bankleitzahl / Kontonummer-Prüfsummen validieren ( * siehe Unterstützte Länder )
- Informationen über die Bank basierend auf der lokalen Bank/Filialnummer abrufen.
- Generiert automatisch ein gültiges IBAN-Format für die angegebene Bankleitzahl und Kontonummer
- System unterstützt Multiple Response Formatierung ( JSON / XML)
3. Unterstützte Länder
Die IBAN Calculation API unterstützt derzeit die folgenden Länder und die von unserer API benötigten Felder zur Berechnung einer IBAN.| Ländercode | Ländername | BankCode | Filiale | Account | Prüfziffer ** |
|---|---|---|---|---|---|
| AT | Österreich | JA | JA | ||
| BE | Belgien | JA | JA | JA | |
| CH | Schweiz | JA | JA | ||
| DE | Deutschland | JA | JA | ||
| EE | Estland | JA | |||
| EG | Egypt | JA | JA | JA | |
| ES | Spanien | JA | JA | JA | JA |
| FI | Finnland | JA | JA | ||
| FR | Frakreich | JA | JA | JA | JA |
| GB | Großbritannien | JA | JA | JA | |
| HU | Ungarn | JA | JA | ||
| IE | Irland | JA | JA | JA | |
| IT | Italien | JA | JA | JA | JA |
| MC | Monaco | JA | JA | JA | JA |
| MR | Mauretanien | JA | JA | JA | |
| MT | Malta | JA | JA | ||
| NO | Norwegen | JA | JA | ||
| PT | Portugal | JA | JA | JA | JA |
| SM | San Marino | JA | JA | JA | |
| CZ | Tschechische Republik | JA | JA | JA | |
| AL | Albanien | JA | JA | ||
| SK | Slowakische Republik | JA | JA | JA | |
| SI | Slowenien | JA | JA | JA | |
| PL | Polen | JA | JA | JA | |
| PK | Pakistan | JA | JA | ||
| SE | Schweden | JA | JA | JA | |
| NL | Niederlande | JA | JA |
Die Prüfziffernvalidierung ist ein zusätzlicher Schutz der Datenintegrität gegen Tippfehler.
4. API Inputs
Die API akzeptiert sowohl HTTP GET- als auch POST-Anfragen für Eingabedaten.Die akzeptierten Parameter sind in der folgenden Tabelle aufgeführt:
| Feldname | Typ | DBeschreibung |
|---|---|---|
| api_key | String | Ihr persönlicher API-Schlüssel. Erhältlich im Kundenbereich. |
| format | String | API-Antwortformat ( xml oder json) |
| country | String | 2 Buchstaben Ländercode ( UK/US/DE/FR ) |
| bankcode | String | Eine eindeutige Bankkennung. Für jedes Land anders. (optional). Einige Länder benötigen nur eine Kontonummer. |
| branch | String | Eine eindeutige lokale Filialkennung (optional) |
| account | String | Persönliche Kontonummer |
| cd | Integer | Prüfziffern, die in einigen Ländern verwendet werden. |
| prefix | Integer | Derzeit nur für die Tschechische Republik erforderlich (optional) |
Die API unterstützt mehrere Antwortformate, um die Integration zu erleichtern. Derzeit werden XML und JSON unterstützt.
Die Länderargumente müssen aus einem 2-stelligen ISO-Ländercode bestehen, z.B. UK für Großbritannien, DE für Deutschland, FR für Frankreich …
Die Bankleitzahl hat für jedes Land eine andere Länge und Struktur.
Filialcode ist ein optionales Argument, das nur für einige Länder benötigt wird (siehe Beispiele)
Die Kontonummer wird für alle Länder benötigt und ist in einigen Fällen der einzige Parameter zur Berechnung einer IBAN.
Prüfziffern sind nur für bestimmte Länder erforderlich, die solche Validierungsalgorithmen in ihre inländische Kontonummerstruktur integriert haben. ( siehe Beispiele )
Das Präfix ist ein Feld, das optional nur für die IBAN-Berechnung in der Tschechischen Republik benötigt wird.
5. API Beispiele
In der folgenden Tabelle finden Sie das Beispiel einer funktionierenden GET-Abfrage an unsere API für jedes Land.| Country | Example query (GET REQUEST) |
|---|---|
| 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-Antwortstruktur
Eine detaillierte Beschreibung der möglichen zurückgegebenen Felder finden Sie in der folgenden Tabelle:| Feldname | Typ | Beschreibung |
|---|---|---|
| Adresse | String | Adresse der Bankfiliale oder Zentrale |
| bank | String | Name der Bank oder des Finanzinstituts |
| bic | String | BIC ("Bankleitzahl") der Bank |
| Filiale | String | Name der durch die Bankleitzahl identifizierten Filiale |
| Stadt | String | Der Name der Stadt, in der sich die Filiale befindet. |
| Land | String | Zweibuchstabige Abkürzung des Ländercodes z.B. US, UK, AU, FR ... etc. |
| String | Benannte Kontakt-E-Mail-Adresse für die Bank oder Filiale | |
| Fax | String | Faxnummer der Bank/FilialeBestellte Kontakt-E-Mail-Adresse der Bank oder Filiale |
| Telefon | String | Kontakt-Telefonnummer der Bank / Filiale |
| Staat | String | Staat der Bank/Filiale Adresse |
| Website | String | Internetadresse der Bank / Filiale |
| plz | String | PLZ oder Postleitzahl der Bankfiliale |
Eine Beispiel-XML-Antwort von der API für eine SORT-Code und Kontonummer-Suche in Großbritannien lautet:
URL abfragen:
?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>
Die Antwort für die gleiche Abfrage, wenn der Benutzer eine JSON-Formatierung angegeben hat, wird sein:
"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 Errors
Im Fehlerfall gibt die IBAN Calculation API eine XML- oder JSON-Antwort mit der Fehlermeldung zurück.Die <error></error> XML-Tags werden ohne weitere Felder in der XML-Antwort zurückgegeben. Nachfolgend finden Sie eine Beschreibung aller möglichen Fehlermeldungen, die zurückgegeben werden können:
<error>Kontonummer-Prüfsumme ist ungültig.</error>
<error>Kontonummer (Prüfsumme) nicht korrekt.</error>
<error>Die Kontonummer muss 11 Zeichen lang sein.</error>
<error>Die Kontonummer muss 14 Zeichen lang sein.</error>
<error>Die Kontonummer muss 24 Zeichen lang sein.</error>
<error>Kontonummer ist nicht gültig</error>
<error>Kontonummer des Sortiercodes ist ungültig</error>
<error>Kontonummer-Präfix zu lang.</error>
<error>Kontonummer zu lang.</error>
<error>Bankleitzahl / KIB (Prüfsumme) nicht korrekt.</error>
<error>Bankleitzahl/ Filialnummer/ Kontonummer zu lang.</error>
<error>Bankleitzahl/Filialcode (Prüfsumme) ist nicht korrekt.</error>
<error>Bankleitzahl nicht gültig</error>
<error>Bankleitzahl zu lang.</error>
<error>Bank nicht gefunden</error>
<error>Bank nicht anerkannt</error>
<error>BBAN / NIB (Prüfsumme) nicht korrekt.</error>
<error>BLZ/Bankleitzahl nicht gültig</error>
<error>Filiale/Agencia nicht gefunden</error>
<error>Filialcode zu lang.</error>
<error>Filiale nicht gefunden</error>
<error>Prüfziffer zu lang.</error>
<error>Clearingnummer/Kontonummer ist nicht gültig. Prüfziffer falsch.</error>
<error>Clearingnummer / BankCode kann nicht identifiziert werden. IBAN kann nicht berechnet werden.</error>
<error>Clearingnummer oder Kontonummer zu lang.</error>
<error>Codice ABI della Banca/Bankleitzahl nicht gültig</error>
<error>Codice CAB della Filiale/Filialcode nicht gültig</error>
<error>Ländercode ist nicht gültig</error>
<error>Land oder Bank nicht unterstützt</error>
<error>IIBAN ist nicht gültig</error>
<error>Kontonummer/Kontonummer ungültig</error>
<error>Fehlende Felder</error>
<error>Keine FR IBAN</error>
<error>Keine FR IBAN Land</error>
<error>Pflichtfeld fehlt. Bitte Bankleitzahl und Kontonummer eingeben</error>
<error>Pflichtfelder nicht ausgefüllt.</error>
<error>RIB ist nicht gültig</error>
<error>SortCode / BankCode kann nicht identifiziert werden. IBAN kann nicht berechnet werden.</error>
<error>Sortcode kann nicht gefunden werden</error>