BIC / SWIFT Code Validierung API

Wie Sie die BIC-Validierungs-API in Ihre Software integrieren können

1. Was ist die BIC-Validierungs-API?

Bei der Verarbeitung von Überweisungen und IBAN-bezogenen Transaktionen ist die Angabe des korrekten SWIFT / BIC-Codes entscheidend für den Erfolg von Zahlungen.
Unser Unternehmen hat das offizielle BIC-Verzeichnis von S.W.I.F.T. SCRL lizenziert, um eine leistungsstarke und einfache Möglichkeit zur automatischen Validierung von BIC zu bieten. Mit diesem Service können Sie die BIC-Codeverzeichnissuche für interne Zwecke in Ihre Software integrieren

Die BIC-Validierungs-API enthält SWIFTRef-Daten. BIC-Daten werden mit Genehmigung von S.W.I.F.T. SCRL verwendet. Datenbankrechte vorbehalten 2018

2. Merkmale

BIC Validation API Hauptmerkmale:

  • Informationen über die Bank basierend auf dem BIC abrufen.
  • Das BIC-Verzeichnis nach einem Teil des Banknamens und des Landes durchsuchen.
  • Das BIC-Verzeichnis nach historischen Datensätzen durchsuchen.
  • Verwenden Sie sowohl die vollständige als auch die vereinfachte API-Antwort für eine einfachere Integration.


3. API Verwendung

Die BIC-Validierungs-API ist REST-basiert und unterstützt einfache HTTP-GET- oder POST-Anfragen.

Die akzeptierten Parameter sind in der folgenden Tabelle aufgeführt:

Feldname Länge Typ Beschreibung
bic 11 String BIC / SWIFT-Code zum Nachschlagen. Kann 8 oder 11 Zeichen sein
bank_name 256 String Teil eines Banknamens für die Suche im BIC-Direktorium.
Land 2 String Zwei Buchstaben Ländercode. Erforderlich bei der Suche nach Banknamen.
api_key 128 String Ihr persönlicher API-Schlüssel.
Format 4 String Erforderlich, um das Format der zurückgegebenen Daten anzugeben. Momentan unterstützte Werte: json, xml
limit Integer Optional: kann verwendet werden, um die Anzahl der Ergebnisse bei der Suche nach Banknamen zu begrenzen.
hist integer Optional: kann verwendet werden, um historische Datensätze aus der Datenbank sowohl für die Bank- als auch für die BIC-Suche anzuzeigen.
In Ihrem Online-Portal finden Sie Ihren API-Schlüssel und die Endpunkt-URL, die zur Sicherung der Suchanfragen verwendet wird.


4, API XML-Antwortstruktur

Sie können ein XSD Schema der API response herunterladen.
Eine detaillierte Beschreibung der zurückgegebenen Felder finden Sie in der folgenden Tabelle:

Feldname Typ Länge Immer präsent Beschreibung
MODIFIKATIONS-FLAGGE Alphabetisch 1 Ja In Deltadateien:
• Z (Zusatz)
• M (Modifikation)
• L (Löschen) in vollständigen Dateien In vollständigen Dateien:
• Z (Zusatz)
GEÄNDERTES FELD Numerisch 186 Nein Speichert das Feld (oder TAG), das sich entweder durch eine Änderung eines Datensatzes oder durch ein neues EVENT geändert hat.
Eine oder mehrere Spalten werden als eine Folge von Zahlen angezeigt, wobei jede Zahl die Spalte darstellt, die von der vorherigen Datensatzinstanz oder dem vorherigen EVENT geändert wurde.
Beispiel "6,7,8,9"
Dies bedeutet, dass VERANSTALTUNGSTYP, VERANSTALTUNGSTERMIN, BIC8, und BRANCHEN BIC sich
geändert haben.
Die folgenden Felder sind von dem Datensatz in das GEÄNDERTE FELD ausgeschlossen:
• DATENSATZKEY
• GEÄNDERTES FELD
• MODIFIKATIONS-FLAGGE
DATENSATZKEY Alphanumerisch 12 Ja Der einmalige Key des Datensatzes in der Datei
Jeder Datensatz repräsentiert ein Ereignis im BIC-Lebenszyklus.
Einmal zugewiesen, ändert sich der DATENSATZKEY nie.
VORHERIGER DATENSATZKEY Alphanumerisch 12 Nein Der DATENSATZKEY des vorher verknüpften EVENTS
Alle zugehörigen Ereignisse sind verlinkt und können über diese Informationen gefunden werden.
NÄCHSTER DATENSATZKEY Alphanumerisch 12 Nein Der DATENSATZKEY des nächsten verknüpften Ereignisses
Alle zugehörigen Ereignisse sind verlinkt und können mit diesen Informationen gefunden werden.
VERANSTALTUNGSTYP Alphabetisch 32 Ja Das EVENT oder die Änderungsbeschreibung des BIC, die in der Vergangenheit, in der Gegenwart oder in der Zukunft aufgetreten ist.
Ereignis Typen:
• BIC AUSGEGEBEN
• BIC ABGELAUFEN
• BIC AKTIVIERT AUF FIN
• BIC AKTIVIERT AUF FA
• BIC AKTIVIERT AUF IA
• BIC DAKTIVIERT AUF FIN
• BIC DEAKTIVIERT AUF FA
• BIC DEAKTIVIERT AUF IA
• BIC DEAKTIVIERT
• BIC EINGESTELLT
• BIC REAKTIVIERT
• BIC VERÖFFENTLICHT
• BIC RECHTLICHER NAME GEÄNDERT
. • BIC INSTITUTION NAME GEÄNDERT
• BIC-ADRESSE GEÄNDERT
• FIN-SERVICE-CODE GEÄNDERT
Das letzte Fortschreibungsdatum ist die letzte Zeile der BIC-Sequenz (d.h. der letzte Eintrag).
Wenn ein neues EVENT hinzugefügt wird, wird das ÄNDERUNGSKENNZEICHEN und GEÄNDERT
FELD im unmittelbar vorhergehenden zugehörigen EVENT aktualisiert.
EVENT-Datum Alphanumerisch 8 Ja Das Datum des EVENTS
BIC8 Alphanumerisch 8 Ja BIC (Institution, Land und Parteisuffix), wobei:
• Partei-Präfix (4 Zeichen)
• Landesvorwahl (2 Zeichen)
• Parteisuffix (2 Zeichen)
BRANCHEN BIC Alphanumerisch 3 Ja Die dem 8-stelligen BIC zugeordnete BIC-Zweigkennung. Wenn kein Zweigbezeichner vorhanden ist, wird XXX verwendet.
BIC Alphanumerisch 11 Ja Der volle BIC: 8-stelliger BIC und Branchenkennung
DATENSATZ STATUS Alphabetisch 1 Ja Zeigt den Status des Datensatzes an:
• [A] = Aktuelles, das das letzte Ereignis in der Kette bis zum Datum der Veröffentlichung darstellt, mit Ausnahme von [Z]ukünftigen Events
• [H] = Historische Aufzeichnungen in der Ereigniskette
• [Z] = Zukünftiges Event, das nach dem Veröffentlichungsdatum des Verzeichnisses eintritt. Das zuvor angegebene [A]ktuelle Event gilt bis zu dem unter [Z]ukünftigen Event angegebenen Datum.
Bei ZUKÜNFTIGEN Events gibt das Datum an, wann die Änderung GÜLTIG ist.
OPERATIONELL AKTIVER DATENSATZ Alpha 1 Ja Es gibt mehrere Datensätze für das gleiche BIC. Dieses Feld gibt an, welcher der Datensätze des gleichen BIC der operativ aktive BIC ist und verwendet werden soll.
• [Y] Betrieblich aktiv
> • [N] Betrieblich inaktiv
Für jeden eindeutigen BIC gibt es einen einzigen Eintrag, der einen AKTIV-Status (Y) angibt.
Datensätze mit[H]istorischem Status zeigen immer [N] an.
Datensätze mit [A]ktuellem können [Y] oder [N] anzeigen.
Datensätze mit [Z] zeigen immer [N] an.
SUBTYP INDIKATOR Jeder Typ 4 Ja Der Geschäftstyp der Entität. Das Subtypkennzeichen wird nur für Sätze mit BIC angeboten.
SWIFT FIN Alphabetisch 1 Ja Status der Verbindung einer Entität zu FIN:
• [Y] verbunden mit FIN
• [N] nicht mit FIN verbunden
SWIFT FA Alphabetisch 1 Ja Status der Erreichbarkeit eines Objektes durch FileAct:
• [Y] verbunden mit FileAct
• [N] nicht mit FileAct verbunden
SWIFT IA Alpha 1 Ja Status der Erreichbarkeit einer Instanz durch InterAct:
• [Y] verbunden mit InterAct
• [N] nicht mit InterAct verbunden
RECHTLICHER NAME Beliebig 105 Nein Institution rechtlicher Name
INSTITUTION NAME Beliebig 105 Ja Handelsname der Institution (veröffentlichter Name)
INSTITUTIONSTYP Alphabetisch 12 Ja Organisation, die hauptsächlich in der Finanzintermediation und/oder in der Hilfsfinanzierung tätig ist
Einrichtungsart:
• FINANZIELL
BR • NICHT FINANZIELL
ENTITÄT TYP Alphabetisch 16 Ja Identifiziert den Typ der Finanzinstitution:
• Juristische Person
• Branche
• Betriebsbereit
RE HAUSANSCHRIFT 1 Beliebig 35 Nein [Registrierung] Hausname
RE HAUSANSCHRIFT 2 Beliebig 35 Nein [Registrierung] Hausnummer
RE HAUSANSCHRIFT 3 Beliebig 35 Nein [Registrierung] Gebäude, Gebäudename, Etage
RE HAUSANSCHRIFT 4 Beliebig 35 Nein [Registrierung] Gebiet
RE STADT Beliebig 35 Nein [Registrierung] Stadtname der Institution/Filiale
RE CPS Beliebig 90 Nein [Registrierung] Landkreis, Provinz, Bundesland oder andere Verwaltungsregion des Eigentümers Institution/Filiale
RE POSTLEITZAHL Beliebig 15 Nein [Registrierung] Postleitzahl der Institution/ Filiale
RE POSTFACH Beliebig 35 Nein Komma-getrenntes Feld mit dem Postfach der Institution/Filiale und der zugehörigen Postleitzahl.
Beispiel
"Postfach 103352, 40024"
Damit kann der Kunde die volle Postfach-Adresse nutzen:
. Postfach 103352
40024, DUESSELDORF (STADT)
OP HAUSADRESSE 1 Beliebig 35 Nein [Operational] Straßenname
OP HAUSADRESSE 2 Beliebig 35 Nein [Betrieblich] Hausnummer
OP HAUSNUMMER 3 Beliebig 35 Nein [Betrieb] Gebäude, Gebäudename, Etage
OP HAUSADRESSE 4 Beliebig 35 Nein [Betrieb] Gebiet
OP STTADT Beliebig 35 Nein [Operational] Ortsname der Institution/Filiale
OP CPS Beliebig 90 Nein [Operational] Landkreis, Provinz, Bundesland oder andere Verwaltungsregion der Eigentümerinstitution/Filiale
OP POSTLEITZAHL Beliebig 15 Nein [Operational] Postleitzahl der Institution/ Filiale
OP POSTFACH Beliebig 35 Nein Komma-getrenntes Feld mit dem Postfach der Institution/Filiale und der zugehörigen Postleitzahl.
Beispiel
"Postfach 103352, 40024"
Damit kann der Kunde die volle Postfach-Adresse nutzen:
POB 103352
40024, DUESSELDORF (STADT)
BR HAUSADRESSE 1 Beliebig 35 Nein [Niederlassung] Straßenname
BR HAUSADRESSE 2 Beliebig 35 Nein [Filiale] Hausnummer
BR HAUSNUMMER 3 Beliebig 35 Nein [Branche] Gebäude, Gebäudename, Stockwerk
BR HAUSADRESSE 4 Beliebig 35 Nein [Branche] Gebiet
BR STADT Beliebig 35 Nein [Filiale] Ortsname der Institution/ Filiale
BR CPS Beliebig 90 Nein [Branche] Landkreis, Provinz, Bundesland oder andere Verwaltungsregion der Eigentümerinstitution/Filiale
BR POSTLEITZAHL Beliebig 15 Nein [Branche] Postleitzahl der Institution/ Branche
BR POSTFACH Beliebig 35 Nein Komma-getrenntes Feld mit dem Postfach der Institution/Filiale und der zugehörigen Postleitzahl.
Beispiel
"Postfach 103352, 40024"
Damit kann der Kunde die volle Postfach-Adresse nutzen:
POB 103352
40024, DUESSELDORF (STADT)
BRANCHENINFORMATIONEN Beliebig 70 Nein Brancheninformationen
Dies ist eine Freitextbeschreibung der Branche, wie sie von dem Finanzinstitut, zu dem sie gehört, zur Verfügung gestellt wird. Diese wird vorerst nur für Einträge mit einem BIC und nur dann zur Verfügung gestellt, wenn das betreffende Finanzinstitut diese zusätzlichen Informationen zur Verfügung stellen möchte. Die Informationen stammen aus dem BIC-Verzeichnis.
LÄNDERNAME Beliebig 70 Ja Der Ländername der Institution/Zweigstelle gemäß ISO 3166
ISO-LÄNDERCODE Alphabetisch 2 Ja Der ISO 3166-1-Alpha-2-Code des Landes der Institution/Branche
STANDORTCODE Jeder Typ 1 Ja Enthält den Standort (formal in Position 7 des BIC-Standards:2009)
Beispiele:
• Auf FR, BICs in Paris = P
• In BE, BICs in Brüssel = B
• In den USA, BICs in Ost Kosten = 3
FIN SERVICECODES Jeder Typ 60 Nein FIN-Servicecodes (auch Value Added Service Codes genannt). Servicecodes werden nur für Datensätze bereitgestellt, die einen BIC enthalten.
Das Feld kann bis zu 20 dreistellige Codes in alphabetischer Reihenfolge enthalten.
DATENSATZKEY BDP Alphanumerisch 12 Nein Der eindeutige Schlüssel des Bank Directory Plus-Datensatzes in der Datei.
FELD A Beliebig 1 Nein Reserviert für zukünftige Verwendung
FELD B Beliebig 64 Nein Reserviert für zukünftige Verwendung
FELD C Beliebig 128 Nein Reserviert für zukünftige Verwendung
FELD D Beliebig 256 Nein Reserviert für zukünftige Verwendung
FELD E Beliebig 11 Nein Reserviert für zukünftige Verwendung
FELD F Beliebig 12 Nein Reserviert für zukünftige Verwendung
Das API-System liefert Ergebnisse im XML-Format, das sich leicht in verschiedenen Programmiersprachen und Plattformen analysieren lässt. Eine XML-Beispielantwort von der API für eine BIC-Suche lautet:


<result>
<bicdata>
<row>
<modification_flag>A</modification_flag>
<changed_field>34</changed_field>
<record_key>BP0000004OQQ</record_key>
<previous_record_key>BP00000030XZ</previous_record_key>
<next_record_key/>
<event_type>BIC ADDRESS CHANGED</event_type>
<event_date>20150606</event_date>
<bic8>BARCGB22</bic8>
<branch_bic>XXX</branch_bic>
<bic>BARCGB22XXX</bic>
<record_status>C</record_status>
<operationally_active_record>Y</operationally_active_record>
<subtype_indicator>SUPE</subtype_indicator>
<swift_fin>Y</swift_fin>
<swift_fa>N</swift_fa>
<swift_ia>N</swift_ia>
<legal_name>BARCLAYS BANK PLC</legal_name>
<institution_name>BARCLAYS BANK PLC</institution_name>
<institution_type>FINANCIAL</institution_type>
<entity_type>Legal Entity</entity_type>
<re_street_address_1>1, CHURCHILL PLACE</re_street_address_1>
<re_street_address_2/>
<re_street_address_3/>
<re_street_address_4/>
<re_city>LONDON</re_city>
<re_cps/>
<re_zip_code>E14 5HP</re_zip_code>
<re_pob_number/>
<op_street_address_1>1 CHURCHILL PLACE</op_street_address_1>
<op_street_address_2/>
<op_street_address_3/>
<op_street_address_4/>
<op_city>LONDON</op_city>
<op_cps>LONDON E14 5HP</op_cps>
<op_zip_code/>
<op_pob_number/>
<br_street_address_1/>
<br_street_address_2/>
<br_street_address_3/>
<br_street_address_4/>
<br_city/>
<br_cps/>
<br_zip_code/>
<br_pob_number/>
<branch_information>(ALL U.K. OFFICES)</branch_information>
<country_name>UNITED KINGDOM</country_name>
<iso_country_code>GB</iso_country_code>
<location_code>2</location_code>
<fin_service_codes>EBAERPFINSCOSTGTGT</fin_service_codes>
<record_key_bdp>BD00000006FO</record_key_bdp>
<field_a/>
<field_b/>
<field_c/>
<field_d/>
<field_e/>
<field_f></field_f>
</row>
</bicdata>
<errors/>
</result>




5. API Errors

Im Fehlerfall gibt die API eine XML-Antwort mit der Fehlermeldung zurück

Die 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:

Status-Code Typ Beschreibung
301 Konto Fehler API Key ist ungültig
302 Konto Fehler Abonnement abgelaufen
303 Konto Fehler Keine Abfragen vorhanden
304 Konto Fehler Sie haben keinen Zugriff auf diese API
401 Eingabefehler Akzeptierte SWIFT Länge 8 oder 11 Zeichen'
402 Eingabefehler Bank Name Ungültig! Die Bankensuche sollte mindestens 4 Zeichen lang sein.
Erlaubte Zeichen a-z, A-Z, 0-9, [Leerzeichen]!
403 Eingabefehler Ländercode falsch! Erlaubt ist ein 2-stelliger Ländercode. Beispiel: Vereinigtes Königreich, DE, FR