API-Dokumentation der IBAN-Validierung



Spezifikation der API-Integration


1. Was ist die Invers-IBAN-Validierungs-API?


Invers IBAN ist ein Online-System, das Unternehmen eine Online-Schnittstelle bietet, mit der sie die IBAN-Validierung und -Identifikation Echtzeit durchführen können.

Diese Funktionen liegen in Form von Add-On-Modulen vor, welche die Funktionalität Ihres Portals erweitern.

Die International Bank Account Number oder IBAN ist ein standardisierter Weg, eine Bankkontonummer abzubilden, die grenzüberschreitend funktioniert.

Ihre Struktur ist:

<ISO-Ländercode aus zwei Buchstaben> + <Prüfsumme mit zwei Ziffern] + <BBAN>


Der Begriff BBAN wird genutzt, um das Format der Bankkontonummer auf nationaler Ebene zu beschreiben, das sich zwischen Ländern unterscheidet (und teilweise nur geschaffen wurde, im mit IBAN genutzt zu werden!)
Beachten Sie, dass eine BBAN ihren eigenen Prüfsummenalgorithmus haben kann.

IBAN bietet mithilfe der Prüfsumme einen einfach Schutz vor Übertragungsfehlern (d.h.: manuelles Kopieren). Es bietet außerdem ein Register gültiger Zielländer und deren BBAN-Formate.
Wenn Sie also das IBAN-API-Modul anweisen, eine IBAN zu ‚validieren‘, stellt dieses sicher, dass die IBAN diese Prüfungen durchläuft.
Sie kann jedoch nicht sicherstellen, dass ein Bankkonto tatsächlich existiert – die einzige Partei, die das tun kann, ist die empfangende Bank oder das Land.



2. Funktionen


Die Invers-IBAN-Validierungs-API erlaubt Ihnen die folgenden Abfragen:




3. API-Nutzung


Das API-System erlaubt es Ihnen, die IBAN-Validierung mithilfe simpler HTTP GET oder POST-Anfragen zu automatisieren.
Die akzeptierten Parameter sind in der folgenden Tabelle aufgelistet:

Feldname Länge Typ Beschreibung
IBAN Maximal 100 Zeichenkette Die IBAN, die Sie validieren wollen.
api_key 128 Zeichenkette Ihr persönlicher API-Schlüssel

*Um einen API-Schlüssel zu erhalten, kontaktieren Sie uns bitte unter contact@iban.com oder

BEISPIEL – Validierung einer IBAN
Eine beispielhafte Nutzung der IBAN-Validierungs-API mithilfe einer GET-Anfrage finden Sie im Folgenden:
https://api.iban.com/clients/api/iban-api.php?api_key=BAPI_KEY&iban=IBAN

Wobei:

Sobald eine HTTP GET oder POST-Anfrage mit dem korrekten API-Schlüssel generiert wird, liefert das System die Ergebnisse in einem XML-Format. Ein Beispiel für eine XML-Antwort finden Sie im nächsten Abschnitt „Struktur der XML-Antwort der API“



4. Struktur der XML-Antwort der API


Ein XML-Schema der API-Antwort finden Sie im Dokumentationsarchiv.
Eine detaillierte Beschreibung der möglichen zurückgelieferten Felder lässt sich der folgenden Tabelle entnehmen:
Feldname Länge Typ Beschreibung
IBAN Maximal 100 Zeichenkette Die IBAN, die Sie übergeben haben, wird angezeigt.
BANK_NAME 256 Zeichenkette Bank Code, der die Bank identifiziert, zu welcher die IBAN gehört
SEPA 5 Zeichenkette Zeigt an, ob diese IBAN SEPA-Zahlungen unterstützt. Mögliche Werte sind wahr oder falsch
COUNTRY 32 Zeichenkette Der vollständige Name des Ursprungslandes, z.B. „Vereinigte Staaten“
COUNTRY_CODE 2 Zeichenkette Abkürzung des Ländercodes aus zwei Buchstaben, d.h. US, UK, AU, FR … etc.
CITY 128 Zeichenkette Der Name der Stadt des Standortes der ausstellenden Bank.
ADDRESS 128 Zeichenkette Die Adresse der ausstellenden Bank.
SWIFT 128 Zeichenkette Der SWIFT-Code der ausstellenden Bank.
VALID 5 Zeichenkette Wahr/Falsch-Ergebnis, das angibt, ob die IBAN-Prüfsummen korrekt sind.

Das API-System gibt Antworten im XML-Format zurück, das in vielen Programmiersprachen und auf vielen Plattformen einfach zu parsen ist.

Eine beispielhafte XML-Antwort der API für eine IBAN-Validierungsanfrage wäre:

<result>
<iban>DE08500700100094201100</iban>
<bank_name>DEUTSCHE BANK AG</bank_name>
<country>GERMANY</country>
<country_code>DE</country_code>
<city>60262 FRANKFURT AM MAIN</city>
<address>TAUNUSANLAGE 12</address>
<swift>DEUTDEFFXXX</swift>
<sepa>TRUE</sepa>
<valid>TRUE</valid>
</result>



5. API-Fehler


Im Falle eines Fehlers gibt die IBAN-API eine XML-Antwort zurück, welche die Fehlermeldung enthält.

Die <error></error>-XML-Tags werden ohne weitere Felder in der XML-Antwort zurückgegeben.

Im Folgenden finden Sie eine Beschreibung aller möglichen Fehlermeldungen, die zurückgegeben werden können:

<error>Abonnement abgelaufen</error>
<error>Ungültiger API-Schlüssel</error>
<error>Keine IBAN angegeben</error>