Rechnung mit Bezahlcode erstellen

Zahlen mit Code / Girocode API Dokumentation

Mehr Informationen

Informationen zur Zahlen mit Code Girocode API

Diese Dokumentation beschreibt die Zahlen-mit-Code.com API und bietet darüber hinaus Codebeispiele in verschiedenen Programmiersprachen für eine einfache Einbindung.

Die Zahlen-mit-Code.com API ist eine REST-API, die es Entwicklern ermöglicht, den Girocode in ihre Anwendungen zu integrieren.
Auf eine erfolgreiche API Anfrage wird der fertige QR-Code als PNG Grafik oder im „Base 64 Code“ Format zurückgeliefert.
Dieser Code lässt sich in allen gängigen Programmiersprachen als Grafik ausgeben und so in einer beliebigen Anwendung / Rechnungssoftware auf der Rechnung / dem Zahlschein platzieren.
Die Antworten der API sind als JSON formatiert.

Die Zahlen-mit-Code.com API wird von einem Gateway bereitgestellt, der sich unter https://zahlen-mit-code.com/api befindet.
In den Anfragebeispielen in dieser Dokumentation verwenden wir Platzhaltervariablen wie {apiurl}, um auf die Zahlen-mit-Code.com API-URL zu verweisen, {iban} um z.B.: auf die IBAN des Zahlungsempfängers und {user} bzw. {secret}, um auf den API user sowie das secret zu verweisen.
Nutzer der Zahlen-mit-Code.com API können ihre privaten API-Schlüssel unter info@zahlen-mit-code.com anfordern oder schnell und unkompliziert einen Testzugang (siehe weiter unten) erhalten.

Die von der API zurückgegebenen QR-Code Daten im „Base 64 Code“ Format können für einen einfachen Test z.B.: mit https://base64.guru/converter/decode/image in ein Bild umgewandelt und dann mit einer Banking App abgescannt werden. (Die Anführungszeichen vor und hinter dem Base 64 Code müssen hier gelöscht werden.)

Girocode API Anfrage / Antwort


Anfrage:
Parameter Beschreibung
apiurl Die Zahlen-mit-Code API URL: https://zahlen-mit-code.com/api
user Kennung des API Nutzers, siehe API user und secret
secret Privater Schlüssel des API Nutzers, siehe API user und secret
iban IBAN des Zahlungsempfängers
bic BIC des Zahlungsempfängers
paymentrecipient Name des Zahlungsempfängers (Gültigen SEPA Zeichensatz beachten!)
purpose Verwendungszweck der Überweisung (Gültigen SEPA Zeichensatz beachten!)
amount Betrag der Überweisung in € mit Punkt als Dezimaltrennzeichen.
Achtung: Beträge mit mehr als 2 Nachkommastellen werden von der API gerundet.
imageformat Optional: Das gewünschte Bildformat. Erlaubte Werte: "png" oder "base64".
Ohne diesen Parameter wird standardmäßig Base64 zurückgegeben.


Die API Antwort ist vom Parameter "imageformat" abhängig


Antwort (imageformat=base64)

Die Daten werden als JSON-Objekt zurückgeliefert.

Parameter Beschreibung
response_code Statuscode der Anfrage, z.B.: 200 für einen erfolgreichen Aufruf.
response_desc Informationen zum Aufruf bzw. zu Fehlern.
qr_data QR-Code als PNG im „Base 64 Code“ Format.

Beispielanfrage:


Beispielantwort:


Antwort (imageformat=png)

Der QR-Code wird im Erfolgsfall als PNG-Bild zurückgeliefert, nur im Fehlerfall werden Daten als JSON-Objekt zurückgeliefert:

Parameter Beschreibung
response_code Fehlercode der Anfrage, z.B.: 401 für einen fehlerhaften Aufruf.
response_desc Informationen zum Aufruf bzw. zu Fehlern.
qr_data NULL

Beispielanfrage:


Erfolg - Beispielantwort:

Fehler - Beispielantwort:


API user und secret


API Zugangsdaten anfordern:

Sie können einen API Testzugang erhalten, indem Sie hier Ihre E-Mail Adresse eingeben. User und secret werden umgehend verschickt und sind für 6 Stunden gültig. Nach Ablauf der Zugangsdaten können hier neue Daten angefordert werden.

Falls Sie Tests und Integration abgeschlossen haben und einen permanenten API Zugang benötigen, kontaktieren Sie uns bitte unter: info@zahlen-mit-code.com


Codebeispiele

PHP:

C#

C++:

VBA für MS-Access:

Folgender Code wird beim Formatieren des Detailbereiches im Bericht aufgerufen.
Es muss ein Verweis auf Microsoft XML v3.0 gesetzt werden.

SEPA Zeichensatz

Nach Anlage 3 des DFÜ Abkommens sind für SEPA Zahlungen folgende Zeichen erlaubt:

  • ABCDEFGHIJKLMNOPQRSTUVWXYZ
  • abcdefghijklmnopqrstuvwxyz
  • 0123456789
  • ':?,-(+.)/
  • Leerzeichen