{{indexmenu_n>4}}
====== giropay ======
Informationen zu giropay sind unter https://www.girosolution.de/girocheckout/bezahlverfahren.html zu finden.
giropay kann **ausschließlich** mit der Währung **EURO** verwendet werden.
===== Testdaten =====
Eine giropay Zahlung kann mittels der folgenden Testdaten getestet werden:
^Formularfeld ^Eingabewert^
|Bankleitzahl |12345679|
|BIC |TESTDETT421|
|Kontonummer/ Anmeldename |sepatest1|
|PIN |beliebige 5-stellige Zahl|
|TAN |beliebige 6-stellige Zahl|
**Transaktionsausgang**
^ResultCode ^Antwortcode ^Hinweis ^
|4000 |erfolgreiche Transaktion |Nach Eingabe der oben genannten Daten erfolgt eine erfolgreiche Transaktion. |
|4502 |abgebrochene Transaktion |Eine abgebrochene Transaktion wird nach drücken des Buttons **giropay abbrechen und zurück zum Shop** ausgelöst. |
===== Workflow =====
hide footbox
participant "Kunde" as customer
participant "Shop" as shop
participant "GiroCheckout" as girocheckout
participant "giropay" as giropay
participant "Online-Banking" as bank
autonumber
customer -> shop:
shop -> girocheckout:
girocheckout -> shop:
shop -> girocheckout:
girocheckout -> giropay:
giropay -> girocheckout:
girocheckout -> shop:
shop -> customer:
customer -> bank:
bank -> customer:
customer -> bank:
bank -> bank:
bank -> giropay:
giropay -> girocheckout:
girocheckout -> shop
shop -> shop:
shop -> girocheckout:
girocheckout -> giropay:
giropay -> shop:
center footer (c)2013 by GiroSolution AG
- Käufer wählt Zahlart giropay und gibt BIC seiner Bank ein
- Shop prüft Bankstatus ([[girocheckout:giropay:functions#bankstatus_pruefen|-----]])
- Shop bekommt Rückmeldung, ob Bank giropay/giropay-ID unterstützt
- Shop initiiert giropay/giropay-ID Transaktion ([[girocheckout:giropay:functions#initialisierung_der_giropay_zahlung|-----]])
- GiroCheckout initialisiert Transaktion bei giropay
- giropay übermittelt Ergebnis an GiroCheckout
- Shop bekommt Rückmeldung über Initialisierungsausgang (bei Fehler ist Transaktion beendet)
- Shop sendet Redirect URL an Kundenbrowser
- Kundenbrowser leitet zum Online-Banking weiter
- Online-Banking zeigt Kundenloginseite an
- Kunde autorisiert Transaktion
- Bank führt Überweisung durch
- Bank übermittelt Ergebnis an giropay
- giropay übermittelt Ergebnis an GiroCheckout
- GiroCheckout benachrichtigt Shop über Transaktionsausgang ([[girocheckout:giropay:functions#benachrichtigung_ueber_den_ausgang_der_zahlung|-----]])
- Shop verarbeitet Transaktionsausgang
- Shop sendet HTTP Statuscode an GiroCheckout
- GiroCheckout sendet Rücksprung zum Händler an giropay
- Kunde klickt "Zurück zum Shop" ([[girocheckout:giropay:functions#rueckleitung_des_kunden_zum_shop|-----]])
===== API-Funktionen =====
==== Übersicht =====
Wie im Workflow dargestellt gibt es mehrere API-Aufrufe während einer giropay Transaktion oder giropay-ID Abfrage. Eine giropay Transaktion kann zusätzlich mit einer giropay-ID Abfrage kombiniert gesendet werden.
- 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 ====
Es wird geprüft ob eine Bank am giropay Bezahlverfahren oder einer giropay-ID Abfrage teilimmt. Diesbezüglich wird die BIC des Käufer-Girokontos übermittelt. Die Antwort zeigt ob eine giropay Transaktion oder giropay-ID Abfrage möglich ist. Es wid empfohlen vor jeder Initiierung einer giropay Transaktion oder giropay-ID Abfrage 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/giropay/bankstatus \\
**Bereitzustellen von:** GiroCheckout \\
**Aufzurufen von:** Händler
== POST-Parameter ==
^Name ^Pflicht ^Type ^Beschreibung ^
|merchantId |Ja |Integer |Händler-ID eines giropay, giropay-ID oder giropay-ID + giropay Projekts |
|projectId |Ja |Integer |Projekt-ID eines giropay, giropay-ID oder giropay-ID + giropay 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 [[girocheckout:general:start#hash_generieren|hash generieren]])|
== Beispiel ==
{{page>codesamples:giropay#bankstatus.request&noheader&nofooter}}
=== Antwort ===
Die Antwort besteht aus einem JSON Objekt. Das Feld rc liefert einen Fehlercode. Wird **rc = 0** zurückgeliefert, unterstützt die angefragte Bank giropay, sonst enthält er einen entsprechenden Fehlercode. Zusätzliche Informationen zur Unterstützung von giropay und giropay-ID sind den Elementen //giropay// und //giropayid// zu entnehmen. Sind zusätzliche Informationen zur Bank bekannt, werden diese ebenfalls zurückgeliefert.
== JSON-Parameter ==
^Name ^Pflicht ^Type ^Beschreibung ^
|rc |Ja |Integer |[[girocheckout:errorcodes|Fehlernummer]] |
|msg |Ja |String |zusätzliche Informationen im Fehlerfall |
|bankcode |Optional |Integer |Bankleitzahl|
|bic |Optional |String |BIC, wenn vorhanden |
|bankname |Optional |String |Bankname |
|giropay |Optional |Integer |0 = giropay Zahlung wird nicht unterstützt \\ 1 = giropay Zahlung wird unterstützt |
|giropayid |Optional |Integer |0 = giropay-ID und giropay-ID + giropay wird nicht unterstützt \\ 1 = giropay-ID und giropay-ID + giropay wird unterstützt |
^HEADER Parameter^^^^
|hash |Ja |String |HMAC MD5 hash über alle Werte der Rückmeldung. Siehe [[girocheckout:general:start#hash_generieren|hash generieren]] |
== Beispiel im Erfolgsfall ==
{{page>codesamples:giropay#bankstatus.response.true&noheader&nofooter}}
== Beispiel im Fehlerfall ==
{{page>codesamples:giropay#bankstatus.response.false&noheader&nofooter}}
==== Initialisierung einer giropay Zahlung ====
Die Initialisierung einer giropay Zahlung kann mit oder ohne der Altersverifikation (giropay-ID) stattfinden. Diese Unterscheidung wird ausschließlich anhand der übermittelten projectId getroffen.
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
== Parameter ==
^Name ^Pflicht ^^^Type ^Beschreibung ^
^ ^Giropay^Giropay-ID^Giropay+Giropay-ID ^ ^ ^
|merchantId |Ja |Ja |Ja |Integer |Händler-ID eines giropay Projekts |
|projectId |Ja |Ja |Ja |integer |Projekt-ID eines giropay Projekts |
|merchantTxId |Ja |Ja |Ja |String(255) |eindeutige Transaktions-ID des Händlers |
|amount |Ja |Ja |Ja |Integer |Bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny |
|currency |Ja |Ja | |String(3) |Währung der Transaktion\\ EUR = Euro|
|purpose |Ja |Ja | |String(27) |Verwendungszweck der giropay Überweisung |
|bic |Ja |Ja |Ja |String(11) |BIC (8 oder 11-stellig) der Kundenbank |
|iban |Optional |Optional |Optional |String(34) |IBAN der Kundenbankverbindung **ohne Leerzeichen**|
|info[1..5]Label|Optional |Optional |Optional |String(30) |zusätzliche Information für die giropay Überweisungsseiten (Feldname) |
|info[1..5]Text |Optional |Optional |Optional |String(80) |zusätzliche Information für die giropay Überweisungsseiten (Information) |
|urlRedirect |Ja |Ja |Ja |String |URL, an die der Kunde nach der Zahlung geschickt werden soll. |
|urlNotify |Ja |Ja |Ja |String |URL, an die der Zahlungsausgang gemeldet werden soll. |
|hash |Ja |Ja |Ja |String |HMAC MD5 hash über alle Werte des Aufrufs. Siehe [[girocheckout:general:start#hash_generieren|hash generieren]] |
Mit den info Parametern können zusätzliche Informationen auf den giropay Überweisungsseiten angezeigt werden. Es sind max. 5 Elemente möglich. Eine Information besteht immer aus einem Label und einer Information.
== Beispiel ==
{{page>codesamples:giropay#transactionstart.request&noheader&nofooter}}
=== 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 |[[girocheckout:errorcodes|Fehlernummer]] |
|msg |Ja |String |zusätzliche Informationen im Fehlerfall |
|reference |Optional |String |eindeutige GiroCheckout Transaktions-ID |
|redirect |Optional |String |Redirect URL zur Weiterleitung des Kunden an sein Online Banking|
|hash |Ja |String |HMAC MD5 hash über alle Werte der Rückmeldung. Siehe [[girocheckout:general:start#hash_generieren|hash generieren]] |
== Beispiel im Erfolgsfall ==
{{page>codesamples:giropay#transactionstart.response.true&noheader&nofooter}}
== Beispiel im Fehlerfall ==
{{page>codesamples:giropay#transactionstart.response.false&noheader&nofooter}}
==== Benachrichtigung über den Zahlungsausgang ====
Der Ausgang einer giropay 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 giropay Transaktion steht im Feld gcResultPayment. Wurde zusätzlich die giropay-ID Überprüfung angefordert, steht das Ergebnis der Altersprüfung im Feld gcResultAVS.
Aufgrund des giropay 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 | GiroCheckout Transaktions-ID |
|gcMerchantTxId |Ja | String | Händler Transaktions-ID |
|gcBackendTxId |Ja |String | Zahlungsabwickler Transaktions-ID |
|gcAmount |Ja |Integer | bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent |
|gcCurrency |Ja |String | Währung |
|gcResultPayment |Optional |Integer | [[girocheckout:resultcodes#zahlungsausgang|Ergebniscodes der giropay Zahlung]]|
|gcResultAVS |Optional |Integer | [[girocheckout:resultcodes#altersverifikation|Ergebniscodes der giropay Altersverifikation]] |
|gcHash |Ja |String | HMAC MD5 hash über alle Werte des Aufrufs. Siehe [[girocheckout:general:start#hash_generieren|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 giropay 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 | GiroCheckout Transaktions-ID |
|gcMerchantTxId |Ja | String | Händler Transaktions-ID |
|gcBackendTxId |Ja |String | Zahlungsabwickler Transaktions-ID |
|gcAmount |Ja |Integer | bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent |
|gcCurrency |Ja |String | Währung |
|gcResultPayment |Optional |Integer | [[girocheckout:resultcodes#zahlungsausgang|Ergebnis der giropay Zahlung]]|
|gcResultAVS |Optional |Integer | [[girocheckout:resultcodes#altersverifikation|Ergebnis der giropay Altersverifikation]] |
|gcHash |Ja |String | HMAC MD5 hash über alle Werte des Aufrufs. Siehe [[girocheckout:general:start#hash_generieren|hash generieren]] |