Inhalt
- Download
- Beispiele und Einbindung
- Wichtiger Hinweis zu Notify und Redirect
- Requests und Responses
- Fehlerhandling
- Ergebniscodes / Zahlungsausgang
- Entwicklungsumgebungen
- Changelog
Das GiroCheckout SDK für Java ermöglicht die einfache Integration der GiroCheckout API in alle Arten von javabasierte Anwendungen. Das SDK umfasst alle Schnittstellen des GiroCheckout APIs der Girosolution AG zur Erzeugung von Requests und der Verarbeitung von Responses. Das SDK kümmert sich dabei um alle technischen Details, wie z.B. die Berechnung der Hash-Summen und die Thread-sichere Verarbeitung.
Download
Download GiroCheckout Java SDK 2.5.12
Download GiroCheckout Java SDK Dokumentation
Beispiele und Einbindung
Voraussetzung für die Verwendung von GiroCheckout ist die Anlage eines Benutzerkontos und entsprechender Projekte unter https://www.girocheckout.de.
Wichtiger Hinweis zu Notify und Redirect
GiroCheckout verwendet zwei parallele Kanäle zur Kommunikation zwischen dem GiroCheckout-Server und dem Shop: Die Notification (oder Notify) und das Redirect. Das Notify ist ein Server-to-Server-Aufruf im Hintergrund, wobei das Redirect über den Kundenbrowser läuft und diesem am Ende das Transaktionsergebnis anzeigt. Beide Kommunikationswege sollten auch unabhängig voneinander funktionieren, falls eine der beiden Meldungen nicht ankommt. Auf dieser Weise ist die Transaktion auch erfolgreich, wenn die Notification aus irgendeinem Grunde nicht ankommen konnte (also nur der Redirect erfolgen konnte), oder wenn der Kunde die Rückleitung zum Shop unterbricht (also nur ein Notify ankam). Aber natürlich sollte an beiden Stellen ein Check erfolgen, ob die Bestellung bereits im Shop abgearbeitet wurde, damit das nicht doppelt geschieht.
Siehe dazu auch API Grundlagen.
Einbindung des Jar-Files
Fügen Sie zunächst das File girocheckout.jar zum Build Path hinzu.
Referenz auf Ihr Händlerkonto und Ihr Projekt
Für alle Aufrufe des GiroCheckout APIs benötigen Sie eine Referenz auf Ihr Händlerkonto und das zu verwendende Projekt.
Merchant merchant = MerchantFactory.createMerchant(ihreHändlerID);
Project project = merchant.createProject(ihreProjektID, ihrProjektPasswort); Requests und Responses
Beim Absetzen von Requests in Richtung GiroCheckout definieren Sie die zunächst die für die Transaktion benötigten Daten und erstellen dann auf dem Project Objekt den entsprechenden Request.
Beispiel: Wero Zahlung
WeroTransactionRequest request = project.createWeroTransactionRequest(merchantTxId, amount, currency, purpose, urlRedirect, urlNotify);Jeder Request besitzt eine execute Methode, die das zugehörige Response Objekt zurückliefert.
Beispiel:
WeroTransactionResponse response = request.execute();
System.out.println("redirect: [" + response.getRedirect() + "]");
System.out.println("reference: [" + response.getReference() + "]"); Fehlerhandling
Sofern bei der Kommunikation mit dem GiroCheckout API Probleme auftreten wird eine GiroCheckoutProtocolException geworfen, die weitergehende Informationen zum Fehler enthält. Darüber hinaus zeigt die GiroCheckoutException interne Fehler an. Eine Auflistung der Fehlernummern finden Sie unter Fehlernummern,
Ergebniscodes / Zahlungsausgang
Das Ergebnis eines Zahlungsausgangs ist entweder in der notify/redirect URL oder bei direkten Zahlungen in der entsprechenden Response-Klasse enthalten. Der Code 4000 kennzeichnet dabei immer eine erfolgreiche Transaktion. Alle anderen Codes beschreiben, welcher Fehler aufgetreten ist. Eine Auflistung der Ergebniscodes finden Sie unter Ergebniscodes.
Entwicklungsumgebungen
Version 2.5.12 der SDKs hat die Möglichkeit eingeführt, anzugeben, gegen welche Serverumgebung die API-Calls gesendet werden sollen. Dies geschieht über das Setzen der „environment“-Property für das Projekt und einen der folgenden Werte zu wählen:
| Wert | Bedeutung |
|---|---|
| gc1-dev | GiroCheckout 1 Entwicklungsumgebung |
| gc1-prod | GiroCheckout 1 Produktion |
| gc2-preprod | GiroCheckout 2 Vorproduktion (demnächst verfügbar) |
| gc2-prod | GiroCheckout 2 Produktion (demnächst verfügbar) |
Bitte beachten, dass Credentials für die Umgebungen benötigt werden, die Sie einsetzen wollen.
Hinweis: In gc1 enthalten die URLs aus historischen Gründen den String „v2“. Bitte nicht mit gc2 verwechseln.
Changelog
(Klicken zum Öffnen)
Version 2.5.12 – 24.07.2026
- Werte für die environment Einstellung angepasst (siehe Entwicklungsumgebungen)
- Versions- und SDK-Header für Statistik und Support eingebaut
Version 2.5.11 – 09.06.2026
- Zahlungsarten bluecode, eps, iDEAL, Maestro und Klarna entfernt
- Korrektur Kassenzeichen im Refund für Kreditkarte, Lastschrift, Apple Pay, Google Pay, Klarna und Wero.
Version 2.5.9 – 06.02.2026
- Unterstützung für WERO-Erstattung hinzugefügt.