Zu Content springen
Deutsch
  • Es gibt keine Vorschläge, da das Suchfeld leer ist.

Was bietet die Bankdaten API?

Die GET AG Bankdaten-API stellt Funktionen zur Validierung von Bankverbindungsdaten bereit. Sie ermöglicht die Prüfung von Bankleitzahlen (BLZ), Kontonummern und International Bank Account Numbers (IBAN) sowie die Ermittlung zugehöriger Bankinformationen wie BIC, Bankname und Standort. Die API dient als zentrale Komponente zur Sicherstellung der Datenqualität in Prozessen des unbaren Zahlungsverkehrs.

Inhaltsverzeichnis

     

     

    Vorteile der API

      • Erhöhung der Datenqualität: Vermeidung von Fehlbuchungen durch frühzeitige Validierung von Kontoverbindungen.
      • Automatisierung: Nahtlose Integration in digitale Abschlussprozesse und Kundenportale.
      • Aktualität: Regelmäßige Synchronisation mit den offiziellen Datenbeständen der Deutschen Bundesbank.
      • Vollständigkeit: Lieferung ergänzender Informationen wie BIC und Bankname zur Verbesserung der User Experience.

     

    Fachlicher Hintergrund

    Im Rahmen von Vertragsabschlüssen und Lastschriftmandaten ist die Korrektheit der Bankdaten essenziell für reibungslose Abrechnungsprozesse. Die API nutzt als Referenz die quartalsweise aktualisierten Daten der Deutschen Bundesbank. Durch die Anwendung spezifischer Prüfzifferberechnungsmethoden wird sichergestellt, dass eingegebene Kontodaten formal korrekt und der jeweiligen Bank zugeordnet sind.


    Anwendungsfälle

    (1) Validierung von Bankverbindungen während des Onboarding-Prozesses oder bei der Änderung von Zahlungsdaten in Kundenportalen.

    Nutzen:
    Reduzierung von Rücklastschriften und manuellem Korrekturaufwand durch die sofortige Prüfung der formalen Korrektheit von BLZ, Kontonummer oder IBAN.

    Typische Nutzer:
    Anbieter von Kundenportalen, App-Entwickler, Fachabteilungen für Forderungsmanagement.

    Relevante API-Funktionen oder Endpunkte:
    checkBlzKonto, checkIBAN

     

    (2) Automatisierte Validierung von Zahlungsdaten um BIC und Banknamen basierend auf der IBAN oder BLZ zu prüfen.

    Nutzen:
    Verbesserung der Benutzerfreundlichkeit (Usability), da Kunden weniger Daten manuell eingeben müssen und eine sofortige visuelle Bestätigung ihrer Bank erhalten.

    Typische Nutzer:
    Softwarearchitekten, Product Owner für E-Commerce- und Self-Service-Lösungen.

    Relevante API-Funktionen oder Endpunkte:
    checkBlzKonto, checkIBAN (Response-Objekte)

     


    Datenbasis und Aktualisierung

    Die Daten werden durch die GET AG aufbereitet und kontinuierlich gepflegt. Als Primärquelle dienen die offiziellen Bankleitzahlendateien der Deutschen Bundesbank. Die Aktualisierung erfolgt quartalsweise (jeweils im März, Juni, September und Dezember), korrespondierend zu den Veröffentlichungszyklen der Bundesbank. Die API liefert zudem den Zeitstempel des aktuellen Datenstandes zurück, um Transparenz über die Aktualität zu gewährleisten.

     

    Wichtige Endpunkte und Funktionen

    Endpunkt / Methode

    Fachlicher Zweck

    checkBlzKonto

    Prüft die Kombination aus BLZ und Kontonummer auf formale Gültigkeit und liefert Bankdetails zurück.

    checkIBAN

    Validiert eine IBAN und extrahiert daraus BLZ, Kontonummer sowie Bankinformationen (BIC, Name).

    getVersion

    Liefert die aktuelle Version des Webservices zur Sicherstellung der Kompatibilität.

     

    Hinweise für Product Owner

    Die Bankdaten-API eignet sich hervorragend für alle Produktideen, bei denen Lastschriftmandate erteilt oder Auszahlungen vorgenommen werden. Sie sollte integriert werden, bevor Daten in nachgelagerte Abrechnungssysteme (ERP/Billing) fließen.

      • Datenbedarf: Die API benötigt lediglich die vom Nutzer eingegebenen Bankdaten.
      • Kombination: Ideal kombinierbar mit Adressvalidierungs-APIs der GET AG für einen vollständigen Stammdatencheck.

    Einschränkung: Die API prüft die formale Gültigkeit der Bankverbindung, jedoch nicht die Kontodeckung oder die Identität des Kontoinhabers.

     

    Technische Hinweise für Entwickler

    Die API ist sowohl als SOAP- als auch als REST-Service verfügbar. Für die Integration stehen Swagger-UI und WSDL/WADL-Beschreibungen zur Verfügung.

      • Authentifizierung: Erfolgt über auth_LoginName und auth_Passwort im AuthRequest-Objekt.
      • Fehlerhandling: Die API nutzt spezifische Status-IDs (z. B. 0 für OK, 700 für ungültige Parameter, 500/501 für Authentifizierungsfehler).
      • Clientgenerierung: Die Nutzung der Swagger-Definition wird für die Generierung von REST-Clients empfohlen.

     

    Tipp: Benötigen sie neben der Validierung einer Bankverbindung auch eine Validierung einer Postadresse in Deutschland, empfehlen wir Ihnen die Ortsinfo-API der Get AG.

     


    SwaggerUI und Systemumgebungen

    Cliententwicklung - Hinweise für Softwareentwickler

    Tipps für Softwareentwickler zur Clientgenerierung aus der OpenAPI-Beschreibung gibt es hier. Darüber hinaus empfehlen wir die technische Dokumentation zu lesen.

     

    Testsystem

     

    Stagesystem - nur nach Beauftragung

    https://webservicestaging.ag-server.de/bpwsbankdaten1.0/swagger-ui/ 

     

    Produktivsystem - nur nach Beauftragung

     

     

    Authentifizierung und Freischaltung

    Für die Nutzung der API ist ein gültiger Zugang erforderlich.

    • Testzugang: Kann für die initiale Entwicklung über das Kontaktformular angefragt werden.
    • Produktivzugang: Erfordert eine vertragliche Vereinbarung und die Freischaltung der zugreifenden IP-Adressen.
    • Zugangsdaten: Die Authentifizierungsparameter werden separat durch die GET AG bereitgestellt.

       

       

      Kernfragen und fachliche Einordnung

      Wofür wird die Bankdaten-API eingesetzt?
      Die API dient der automatisierten Validierung von Bankverbindungsdaten wie IBAN, Kontonummer und Bankleitzahl. Sie wird primär in digitalen Prozessen eingesetzt, um bereits bei der Dateneingabe sicherzustellen, dass die angegebenen Informationen formal korrekt sind und einer existierenden Bank zugeordnet werden können. Dies minimiert das Risiko von Fehlbuchungen und Rücklastschriften im Zahlungsverkehr. Sie dient primär der Validierung innerdeutscher Bankdaten, ist in Teilen aber auch für die Validierung internationaler IBANs (SEPA) nutzbar.

      Welche Daten stellt die API konkret bereit?
      Neben der Validierung (True/False-Prüfung) liefert die API umfangreiche Metadaten zu einer Bankverbindung. Dazu gehören der offizielle Bankname, der Kurzname, der BIC (Business Identifier Code), die Postleitzahl und der Ort der Bank. Diese Daten ermöglichen eine automatische Anreicherung von Nutzerprofilen und Formularen.

      Wie aktuell ist die Datenbasis der API?
      Die API basiert auf den offiziellen Daten der Deutschen Bundesbank, die quartalsweise aktualisiert werden. Die GET AG pflegt diese Daten zeitnah nach Veröffentlichung ein (März, Juni, September, Dezember). Über das Feld „stand“ in der API-Antwort können Nutzer jederzeit einsehen, auf welchem Datum der zugrunde liegende Datenbestand der Bundesbank basiert.

      Was sollten Product Owner vor der Integration klären?
      Product Owner sollten definieren, an welcher Stelle im Nutzerprozess die Validierung erfolgen soll – idealerweise direkt bei der Eingabe (Inline-Validierung). Zudem ist zu klären, ob neben der reinen Validierung auch die Anreicherung (z. B. automatische Anzeige des Banknamens) für die User Experience genutzt werden soll. Regulatorisch ist sicherzustellen, dass die Nutzung der API im Einklang mit den Datenschutzbestimmungen für Zahlungsdaten steht.

       

      Technische Dokumentation

      Objekt-Definitionen

      AuthRequest

      Parameter

      Typ

      Beschreibung

      auth_LoginName

      string

      Benutzername

      auth_Passwort

      string

      Passwort

      BLZKontoParameter

      Parameter

      Typ

      Beschreibung

      bankleitzahl

      string

      Bankleitzahl

      kontonummer

      string

      Kontonummer

      BLZKontoResponse

      Parameter

      Typ

      Beschreibung

      bankleitzahl

      string

      8-stellige Bankleitzahl

      bankname

      string

      Bezeichnung der Bank

      bic

      string

      11-stelliger Business Identifier Code (BIC)

      iban

      string

      22-stellige International Bank Account Number (IBAN)

      isValidBankleitzahl

      boolean

      Gültigkeit der Bankleitzahl

      isValidKontonummer

      boolean

      Gültigkeit der Kontonummer

      kontonummer

      string

      10-stellige Kontonummer

      kurzname

      string

      Kurzbezeichnung der Bank

      pan

      string

      5-stellige Institutionsnummer für Primary Account Number (PAN)

      plz

      string

      Postleitzahl der Bank

      pruefmethode

      int

      Prüfzifferberechnungsmethode

      stadt

      string

      Stadt der Bank

      stand

      datetime

      Datenstand der Deutschen Bundesbank

      statusID

      int

      siehe Fehlermeldungen

      IBANParameter

      Parameter

      Typ

      Beschreibung

      iban

      string

      22-stellige International Bank Account Number (IBAN)

      IBANResponse

      Parameter

      Typ

      Beschreibung

      bankleitzahl

      string

      8-stellige Bankleitzahl

      bankname

      string

      Bezeichnung der Bank

      bic

      string

      11-stelliger Business Identifier Code (BIC)

      iban

      string

      22-stellige International Bank Account Number (IBAN)

      isValidBankleitzahl

      boolean

      Gültigkeit der Bankleitzahl

      isValidIBAN

      boolean

      Gültigkeit der IBAN

      isValidKontonummer

      boolean

      Gültigkeit der Kontonummer

      kontonummer

      string

      10-stellige Kontonummer

      kurzname

      string

      Kurzbezeichnung der Bank

      pan

      string

      5-stellige Institutionsnummer für Primary Account Number (PAN)

      plz

      string

      Postleitzahl der Bank

      pruefmethode

      int

      Prüfzifferberechnungsmethode

      stadt

      string

      Stadt der Bank

      stand

      datetime

      Datenstand der Deutschen Bundesbank

      statusID

      int

      siehe Fehlermeldungen

      getVersion

      Parameter

      Typ

      Beschreibung

      version

      string

      Version des Webservices

       

      Fehlermeldungen

      Nachfolgend werden die einzelnen StatusIDs mit der entsprechenden Fehlerbegründung aufgelistet:

      Fehler Beschreibung
      FehlerCode 0 OK, Berechnung erfolgt.
      FehlerCode 1 Datenbankfehler.
      FehlerCode 500 Der Nutzer konnte nicht authentifiziert werden.
      FehlerCode 501 Nutzer konnte authentifiziert werden, hat aber nicht die erforderlichen Rechte.
      FehlerCode 700 Ungültige Eingabeparameter. 

       

      Kontaktformular

      Mit dem Kontaktformular können Sie ein Angebot oder Zugang zum Testsystem der "Bankdaten API" anfragen: