Integration
Grundlagen
FAQ
eps
giropay
iDEAL
Kreditkarte
Lastschrift
Bluecode
Maestro
Payment Page
PayPal
Tools
Fehlernummern
Ergebniscode
Testdaten
Seitenleiste
de
engirocheckout:eps:start
Inhaltsverzeichnis
eps
eps kann ausschließlich mit der Währung EURO verwendet werden.
Testdaten
| Formularfeld | Eingabewert |
|---|---|
| BIC | HYPTAT22XXX |
| Verfügernummer/-name und PIN | lediglich auf Login klicken |
| mobile TAN | beliebig oder leer |
Transaktionsausgang
| ResultCode | Antwortcode | Hinweis |
|---|---|---|
| 4000 | erfolgreiche Transaktion | Nach Eingabe der oben genannten Daten erfolgt eine erfolgreiche Transaktion. |
| 4900 | erfolglose Transaktion | Eine nicht erfolgreiche Transaktion wird nach drücken des Buttons Zahlung abbrechen ausgelöst. |
Workflow
- Käufer/Kunde wählt eps und gibt BIC seiner Bank ein
- Shop initiiert eps Transaktion (Initialisierung)
- GiroCheckout initialisiert Transaktion bei eps
- eps übermittelt Ergebnis an GiroCheckout
- Shop bekommt Rückmeldung über Initialisierungsausgang (bei Fehler ist Transaktion beendet)
- Shop sendet Redirect URL an Käufer-/Kundenbrowser
- Käufer-/Kundenbrowser leitet zu eps weiter, wo die Bankauswahl erfolgt (optional, falls nicht schon im Browser gesp[eichert)
- eps leitet dann an das Online-Banking der entsprechenden Bank weiter
- Online-Banking zeigt Loginseite an
- Käufer/Kunde autorisiert Transaktion
- Bank führt Auftrag durch
- Bank übermittelt Ergebnis an eps
- eps übermittelt Ergebnis an GiroCheckout
- GiroCheckout benachrichtigt Shop über Ausgang (Benachrichtigung)
- Shop verarbeitet Ausgang
- Shop sendet HTTP Statuscode an GiroCheckout
- GiroCheckout sendet Rücksprung zum Händler an eps
- Käufer/Kunde klickt „Zurück zum Shop“ (Rücksprung)
API-Funktionen
Übersicht
Wie im Workflow dargestellt gibt es mehrere API-Aufrufe während einer eps Transaktion.
- Bankstatus prüfen
- Transaktion initiieren
- Bezahlinformation an Händler übermitteln
- Bezahlinformation mit Käuferbrowserweiterleitung zurück zum Händler (durch Käufer nach Zahlung ausgelöst)
Im Folgenden werden die API-Felder und Aufrufe näher erleutert.
Bankstatus prüfen
Dieser Aufruf sollte nicht mehr verwendet werden, alle eps-Transaktionen werden jetzt mit einer externen Bankenabfrage durchgeführt!
Es wird geprüft ob eine Bank am eps Bezahlverfahren teilnimmt. Diesbezüglich wird die BIC des Käufer-Girokontos übermittelt. Die Antwort zeigt ob eine eps Transaktion möglich ist. Es wid empfohlen vor jeder Initiierung einer eps Transaktion den Bankstatus zu prüfen, da dadurch unnötige Verkaufsabbrüche verhindert werden können.
API-Aufruf
URL: https://payment.girosolution.de/girocheckout/api/v2/eps/bankstatus
Bereitzustellen von: GiroCheckout
Aufzurufen von: Händler
POST-Parameter
| Name | Pflicht | Type | Beschreibung |
|---|---|---|---|
| merchantId | Ja | Integer | Händler-ID eines eps Projekts |
| projectId | Ja | Integer | Projekt-ID eines eps Projekts |
| bic | Ja | String(11) | BIC der Käuferbank (8 oder 11-stellig), die geprüft werden soll |
| hash | Ja | String(32) | HMAC MD5 hash über alle Werte des Aufrufs (siehe hash generieren) |
Beispiel
curl -d "merchantId=1234567" \
-d "projectId=1234" \
-d "merchantTxId=1234567890" \
-d "bic=HYPTAT22" \
-d "hash=818a60dde0fbaeb5e7f5affe7c2a28a7" \
https://payment.girosolution.de/girocheckout/api/v2/eps/bankstatus
Antwort
Die Antwort besteht aus einem JSON Objekt. Das Feld rc liefert einen Fehlercode. Wird rc = 0 zurückgeliefert, unterstützt die angefragte Bank eps, sonst enthält er einen entsprechenden Fehlercode. Zusätzliche Informationen zur Unterstützung von eps ist dem Element eps zu entnehmen. Sind zusätzliche Informationen zur Bank bekannt, werden diese ebenfalls zurückgeliefert.
JSON-Parameter
| Name | Pflicht | Type | Beschreibung |
|---|---|---|---|
| rc | Ja | Integer | Fehlernummer |
| msg | Ja | String(255) | zusätzliche Informationen im Fehlerfall |
| bankcode | Optional | Integer | Bankleitzahl |
| bic | Optional | String(11) | BIC, wenn vorhanden |
| bankname | Optional | String(100) | Bankname |
| eps | Optional | Integer | 0 = eps Zahlung wird nicht unterstützt 1 = eps Zahlung wird unterstützt |
| HEADER Parameter | |||
| hash | Ja | String(32) | HMAC MD5 hash über alle Werte der Rückmeldung. Siehe hash der Rückantwort |
Beispiel im Erfolgsfall
hash : 9c26067e25e2d273c6da1fb2be35999a
{"bankcode":"57000","bic":"HYPTAT22XXX","bankname":"HYPO TIROL BANK AG","eps":"1","rc":0,"msg":""}
eps Bankenabfrage
Dieser Aufruf sollte nicht mehr verwendet werden, alle eps-Transaktionen werden jetzt mit einer externen Bankenabfrage durchgeführt!
Gibt eine Liste zurück, welche alle eps Banken enthält. Aus dieser Bankenliste muss der Käufer seine Bank auswählen.
URL: https://payment.girosolution.de/girocheckout/api/v2/eps/issuer
Bereitzustellen von: GiroSolution AG
Aufzurufen von: Händler
POST Parameter
| Name | Pflicht | Type | Beschreibung |
|---|---|---|---|
| merchantId | Ja | Integer | Händler-ID eines eps Projekts |
| projectId | Ja | Integer | Projekt-ID eines eps Projekts |
| hash | Ja | String(32) | HMAC MD5 hash über alle Werte des Aufrufs. Siehe hash generieren |
Beispiel
curl -d "merchantId=1234567" \
-d "projectId=1234" \
-d "hash=02f123fdb8b2056596abc0e6ebb1a8c3" \
https://payment.girosolution.de/girocheckout/api/v2/eps/issuer
Antwort
Die Antwort enthält ein JSON Objekt. Wenn rc = 0 zurückgeliefert wird, enthält das Element issuer die zur Verfügung stehenden Banken.
Parameter
| Name | Pflicht | Type | Beschreibung |
|---|---|---|---|
| rc | Ja | Integer | Fehlernummer |
| msg | Ja | String(255) | Zusätzliche Informationen im Fehlerfall |
| issuer | Optional | Array | Liste der eps issuer Banken bestehend aus dem Key BIC und dem Bankname |
| HEADER Parameter | |||
| hash | Ja | String(32) | HMAC MD5 hash über alle Werte der Rückmeldung. Siehe hash der Rückantwort |
Beispiel
hash : 68fef295c525df124fe47760fcf12396
{"issuer":{"BAWAATWWXXX":"BAWAG P.S.K. Bank für Arbeit und Wirtschaft und Österreich", "OBKLAT2LXXX":"Oberbank AG","BTVAAT22XXX":"Bank für Tirol und Vorarlberg AG", [...]},"rc":0,"msg":""}
Initialisierung einer eps Zahlung
Durch eine erfolgreiche Initialisierung wird eine Referenznummer erstellt sowie ein Weiterleitunslink (redirect) an den Händler übermittelt. Der übermittelte Link führt zum Onlinebanking des Käufers. Er muss an diese URL weitergeleitet werden. Dies kann durch einen HTTP-Redirect-Header, eine HTML-Seite mit entsprechendem Meta-Tag oder Javascript erfolgen.
Anfrage
URL: https://payment.girosolution.de/girocheckout/api/v2/transaction/start
Bereitzustellen von: GiroCheckout
Aufzurufen von: Händler
POST Parameter
| Name | Pflicht | Type | Beschreibung |
|---|---|---|---|
| merchantId | Ja | Integer | Händler-ID eines eps Projekts |
| projectId | Ja | integer | Projekt-ID eines eps Projekts |
| merchantTxId | Ja | String(255) | eindeutige Transaktions-ID des Händlers. Zulässige Zeichen: beliebige Buchstaben (inkl. sprachl. Sonderzeichen), 0-9, Zeichen & = + , : ; . _ ! ? # / |
| amount | Ja | Integer | Bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny |
| currency | Ja | String(3) | Währung der Transaktion EUR = Euro |
| purpose | Ja | String(27) | Verwendungszweck der eps Überweisung |
| bic | deprecated | String(11) | Dieser Parameter darf nicht mehr verwendet werden, alle eps-Transaktionen werden jetzt mit einer externen Bankenabfrage durchgeführt! BIC der Käuferbank (8 oder 11-stellig) |
| urlRedirect | Ja | String(2048) | URL, an die der Kunde nach der Zahlung geschickt werden soll. |
| urlNotify | Ja | String(2048) | URL, an die der Zahlungsausgang gemeldet werden soll. |
| kassenzeichen | Optional | String(255) | Optionales Feld für die Übergabe eines Kassenzeichens. Dieses wird dann im GiroCockpit in den Transaktionsdetails angezeigt (und bald auch exportiert) und es kann dort auch danach gesucht werden. Zulässige Zeichen sind alle UTF-8-Zeichen. |
| hash | Ja | String(32) | HMAC MD5 hash über alle Werte des Aufrufs. Siehe hash generieren |
Beispiel
curl -d "merchantId=1234567" \
-d "projectId=1234" \
-d "merchantTxId=1234567890" \
-d "amount=100" \
-d "currency=EUR" \
-d "purpose=Beispieltransaktion" \
-d "bic=HYPTAT22" \
-d "urlRedirect=http://www.my-domain.de/girocheckout/redirect" \
-d "urlNotify=http://www.my-domain.de/girocheckout/notify" \
-d "hash=0399f30dab1a1c296703bb571a790fb2" \
https://payment.girosolution.de/girocheckout/api/v2/transaction/start
Antwort
Die Antwort besteht aus einem JSON Objekt. Das Feld rc liefert einen Fehlercode zurück. Wird rc = 0 zurückgeliefert, wurde die Transaktion erfolgreich initialisiert. Es wird als Antwort eine Transaktionsnummer und die redirectURL zum Online Banking des Käufers zurückgeliefert.
Parameter
| Name | Pflicht | Type | Beschreibung |
|---|---|---|---|
| rc | Ja | Integer | Fehlernummer |
| msg | Ja | String(255) | zusätzliche Informationen im Fehlerfall |
| reference | Optional | String(36) | eindeutige GiroCheckout Transaktions-ID |
| redirect | Optional | String(2048) | Redirect URL zur Weiterleitung des Kunden an sein Online Banking |
| HEADER Parameter | |||
| hash | Ja | String(32) | HMAC MD5 hash über alle Werte der Rückmeldung. Siehe hash der Rückantwort |
Beispiel im Erfolgsfall
hash : b9d6a1e619ddb6a232274213885f5bb0
{"reference":"189d3a91-a760-4d3e-af7d-1fa7c57e1d2e","redirect":"https:\/\/www.banking.co.at\/appl\/ebp-vorproduktion\/logout\/so\/loginPrepare\/eps.html?resource=2\u0026cai=%2Bj8PpBHwCEBITWwYdtds2zIMtbNm7jfX4DOX1AQA1HdJ-","rc":"0","msg":""}
Beispiel im Fehlerfall
hash : 98d9d8b133acf97eb92601fa72d804a0
{"reference":"f84e606f-817d-439f-ada1-d37e85cb6314","redirect":"","rc":"5100","msg":""}
Benachrichtigung über den Zahlungsausgang
Der Ausgang einer eps Zahlung wird, an die im urlNotify Paramter angegebene URL, übermittelt. Diese Rückmeldung dient dazu, dem Händler den Ausgang der Transaktion mitzuteilen. Durch diese Information kann der Transaktionsstatus beim Händler geändert werden.
Der Zahlungausgang der eps Transaktion steht im Feld gcResultPayment.
Aufgrund des eps Ablaufes findet keine automatische Rückleitung des Käufers an die im Parameter urlRedirect angegebene URL statt. Eine Weiterleitung erfolgt erst, wenn der Käufer den „Abbrechen“ oder „Zurück zum Shop“ Button drückt.
Anfrage
URL: notifyUrl aus der Transaktionsinitialisierung
Bereitzustellen von: Händler
Aufzurufen von: GiroCheckout
GET Parameter
| Name | Pflicht | Type | Beschreibung |
|---|---|---|---|
| gcReference | Ja | String(36) | GiroCheckout Transaktions-ID |
| gcMerchantTxId | Ja | String(255) | Händler Transaktions-ID |
| gcBackendTxId | Ja | String(10) | Zahlungsabwickler Transaktions-ID |
| gcAmount | Ja | Integer | bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent |
| gcCurrency | Ja | String(3) | Währung |
| gcResultPayment | Ja | Integer | Ergebniscodes der eps Zahlung |
| gcHash | Ja | String(32) | HMAC MD5 hash über alle Werte des Aufrufs. Siehe hash generieren |
Antwort
Als Antwort auf den GET-Request wird einer der folgenden HTTP Statuscodes erwartet.
| HTTP Statuscode | Beschreibung |
|---|---|
| 200 (OK) | Die Benachrichtigung wurde korrekt verarbeitet. |
| 400 (Bad Request) | Der Händler hat die Benachrichtigung nicht verarbeitet, möchte aber auch nicht erneut benachrichtigt werden. |
| Alle anderen | Die Benachrichtigung wird max. 10 Mal alle 30 Minuten wiederholt, bis der Händler den HTTP Statuscode 200 oder 400 zurückgibt. |
Rückleitung des Kunden zum Händler
Nach Beendigung der eps Zahlung kann der Kunde über einen Link zurück zum Händler kommen. Eine Weiterleitung erfolgt erst, wenn der Käufer den „Abbrechen“ oder „Zurück zum Shop“ Button drückt. Diese Rückleitung erfolgt nicht automatisch.
Anfrage
URL: redirectUrl aus der Transaktionsinitialisierung
Bereitzustellen von: Händler
Aufzurufen von: GiroCheckout
GET Parameter
| Name | Pflicht | Type | Beschreibung |
|---|---|---|---|
| gcReference | Ja | String(36) | GiroCheckout Transaktions-ID |
| gcMerchantTxId | Ja | String(255) | Händler Transaktions-ID |
| gcBackendTxId | Ja | String(10) | Zahlungsabwickler Transaktions-ID |
| gcAmount | Ja | Integer | bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent |
| gcCurrency | Ja | String(3) | Währung |
| gcResultPayment | Ja | Integer | Ergebniscodes der eps Zahlung |
| gcHash | Ja | String(32) | HMAC MD5 hash über alle Werte des Aufrufs. Siehe hash generieren |
Senderinformationen abrufen
Mit dieser Funktion können die Senderinformationen einer erfolgreich durchgeführten Transaktion abgerufen werden. Anhand der angegebenen Referenz wird Kontoinhaber, IBAN und BIC des Absenders geliefert. Diese Information kann dann für eine Rücküberweisung an den Zahler genutzt werden.
API-Aufruf
URL: https://payment.girosolution.de/girocheckout/api/v2/eps/senderinfo
Bereitzustellen von: GiroCheckout
Aufzurufen von: Händler
POST-Parameter
| Name | Pflicht | Type | Beschreibung |
|---|---|---|---|
| merchantId | Ja | Integer | Händler-ID eines eps Projekts |
| projectId | Ja | Integer | Projekt-ID eines eps Projekts |
| reference | Ja | String(36) | GiroCheckout Transaktions-ID |
| hash | Ja | String(32) | HMAC MD5 hash über alle Werte des Aufrufs (siehe hash generieren) |
Beispiel
curl -d "merchantId=1234567" \
-d "projectId=1234" \
-d "reference=9ce6c641-4082-4f75-ae54-333309febcc5" \
-d "hash=246d1fa2ed97ecff895de974c560f9ec" \
https://payment.girosolution.de/girocheckout/api/v2/eps/senderinfo
Antwort
Die Antwort besteht aus einem JSON Objekt. Das Feld rc liefert einen Fehlercode. Wird rc = 0 zurückgeliefert, enthalten die entsprechenden Felder die Senderinformationen.
JSON-Parameter
| Name | Pflicht | Type | Beschreibung |
|---|---|---|---|
| rc | Ja | Integer | Fehlernummer |
| msg | Ja | String(255) | zusätzliche Informationen im Fehlerfall |
| accountholder | Optional | String(255) | Inhaber des Absenderkontos |
| iban | Optional | String(34) | IBAN des Absenderkontos |
| bic | Optional | String(11) | BIC des Absenderkontos |
| HEADER Parameter | |||
| hash | Ja | String(32) | HMAC MD5 hash über alle Werte der Rückmeldung. Siehe hash der Rückantwort |
Beispiel im Erfolgsfall
hash : cde71b6b98e8dae709fdc1e17aef885f
{"accountholder":"Max Mustermann","iban":"DE87123456781234567890","bic":"TESTDETT421","rc":0,"msg":""}
Beispiel im Fehlerfall
hash : f1d186103b8c4cb59c54ae7b987a9d4c
{"accountholder":null,"iban":null,"bic":null,"rc":5034,"msg":"Transaktion nicht vorhanden"}
girocheckout/eps/start.txt · Zuletzt geändert: 2023/05/05 03:19