====== Kreditkarte ====== Informationen zu Kreditkarten sind unter https://www.girosolution.de/girocheckout/bezahlverfahren.html zu finden. ===== Testdaten ===== {{page>testdata:creditcard&noheader&nofooter}} ===== Transaktionstypen ===== Detaillierte Informationen zu den [[girocheckout:transactiontypes:start|Transaktionstypen]]. left to right direction skinparam packageStyle rect rectangle SALE{ (SALE) --> (REFUND) (SALE) --> (VOID) (REFUND) --> (VOID) } rectangle AUTH { (AUTH) --> (CAPTURE) (AUTH) --> (VOID ) (CAPTURE) --> (VOID ) (CAPTURE) --> (REFUND ) (REFUND ) --> (VOID ) } ===== Initialisierung einer Kreditkartenzahlung ===== Durch eine erfolgreiche Initialisierung wird eine Referenznummer erstellt sowie ein Weiterleitungslink (redirect) an den Händler übermittelt. Der übermittelte Link führt zum Bezahlformular. Der Kunde muss an diese URL weitergeleitet werden. Dies kann durch einen HTTP-Redirect-Header, eine HTML-Seite mit entsprechendem Meta-Tag oder Javascript erfolgen. Bereitzustellen von: GiroCheckout\\ Aufzurufen von: Händler\\ ==== Workflow ==== hide footbox participant "Kunde" as customer participant "Shop" as shop participant "GiroCheckout" as girocheckout participant "Kreditkartenabwickler" as cc autonumber customer -> shop: shop -> girocheckout: girocheckout -> cc: cc -> girocheckout: girocheckout -> shop: shop -> customer: customer -> cc: cc -> customer: customer -> cc: cc -> cc: cc -> girocheckout: girocheckout -> shop shop -> shop: shop -> girocheckout: girocheckout -> cc: cc -> shop: center footer (c)2013 by GiroSolution AG - Käufer wählt Zahlart Kreditkarte aus - Shop initiiert Kreditkartentransaktion ([[girocheckout:creditcard:start#initialisierung_einer_kreditkartenzahlung|Initialisierung]]) - GiroCheckout initialisiert Transaktion bei Kreditkartenabwickler - Kreditkartenabwickler übermittelt Ergebnis an GiroCheckout - Shop bekommt Rückmeldung über Initialisierungsausgang (bei Fehler ist Transaktion beendet) - Shop sendet Redirect URL an Kundenbrowser - Kundenbrowser leitet zum Kreditkartenabwickler weiter - Kreditkartenabwickler zeigt Zahlformular an - Kunde autorisiert Transaktion - Kreditkartenabwickler führt Transaktion durch - Kreditkartenabwickler übermittelt Ergebnis an GiroCheckout - GiroCheckout benachrichtigt Shop über Transaktionsausgang ([[girocheckout:creditcard:start#benachrichtigung_ueber_den_zahlungsausgang|Benachrichtigung]]) - Shop verarbeitet Transaktionsausgang - Shop sendet HTTP Statuscode an GiroCheckout - GiroCheckout sendet Rücksprung zum Händler an Kreditkartenabwickler - Kunde klickt "Zurück zum Shop" ([[girocheckout:creditcard:start#rueckleitung_des_kunden_zum_haendler|Rücksprung]]) ==== Reservierung (AUTH) ==== {{page>girocheckout:transactiontypes:descriptions#auth.desc&noheader&nofooter}} left to right direction skinparam packageStyle rect rectangle AUTH { (AUTH) --> (capture) (AUTH) --> (void) (AUTH) --> (refund) } ==== Verkauf (SALE) ==== {{page>girocheckout:transactiontypes:descriptions#sale.desc&noheader&nofooter}} left to right direction skinparam packageStyle rect rectangle SALE{ (SALE) --> (refund) (SALE) --> (void) } ==== POST Parameter ==== URL https://payment.girosolution.de/girocheckout/api/v2/transaction/start ^Name ^Pflicht ^Type ^Beschreibung ^ |merchantId |Ja |Integer |Händler-ID eines Kreditkarten Projekts | |projectId |Ja |Integer |Projekt-ID eines Kreditkarten Projekts | |merchantTxId |Ja |String(255) |eindeutige Transaktions-ID des Händlers | |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, gemäß [[http://de.wikipedia.org/wiki/ISO_4217#Aktuell_g.C3.BCltige_W.C3.A4hrungen|ISO 4217]].\\ EUR = Euro | |purpose |Ja |String(27) |Verwendungszweck der Kreditkartenransaktion. Diese Information erscheint auf der Kreditkartenabrechnung. | |type |Optional |String |Transaktionsart (siehe [[girocheckout:transactiontypes:start]]) \\ SALE = Verkauf wird sofort gebucht (default) \\ AUTH = Reservierung des Betrags| |locale |Optional |String(4) |Sprache des Kreditkartenformulars \\ de = deutsch (default) \\ en = englisch \\ es = spanisch \\ fr = französisch \\ it = italienisch \\ ja = japanisch \\ pt = portugiesisch \\ nl = niederländisch \\ cs = tschechisch \\ sv = schwedisch \\ da = dänisch \\ pl = polnisch \\ spde = deutsch Spende \\ spen = englisch Spende | |mobile |Optional |Integer |Bezahlseite für mobile Browser optimiert \\ 0 = nein (default) \\ 1 = ja | |pkn |Optional |String(50) |Das Feld dient dazu eine erneute Transaktion, ohne erneute Eingabe der Kreditkartendaten, zu starten. \\ create = neue Pseudo-Kartennummer für die verwendete Kreditkarte generieren \\ [Pseudo-Kartennummer] = Kartennumer der zu verwendenden Kreditkarte (siehe [[girocheckout:creditcard:start#pseudo-kartennummer_pkn|Pseudokartennummer]])\\ | |recurring |Optional |Boolean |wiederkehrende Zahlung \\ 0 = nein (default) \\ 1 = ja, weitere Informationen | |urlRedirect |Ja |String |URL, an die der Kunde nach der Zahlung geschickt werden soll. | |urlNotify |Ja |String |URL, an die der Zahlungsausgang gemeldet werden soll. | |hash |Ja |String |HMAC MD5 hash über alle Werte des Aufrufs. Siehe [[girocheckout:general:start#hash_generieren|hash generieren]] | == Beispiel == {{page>codesamples:creditcard#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. Sie bekommen als Antwort eine Transaktionsnummer und die redirectURL zum Kreditkartenformular zurück. === 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| ^HEADER Parameter^^^^ |hash |Ja |String |HMAC MD5 hash über alle Werte der Rückmeldung. Siehe [[girocheckout:general:start#uebermittlung_von_daten_ueber_einen_schnittstellenaufruf_an_den_haendler|hash der Rückantwort]] | == Beispiel im Erfolgsfall == {{page>codesamples:creditcard#transactionstart.response.true&noheader&nofooter}} == Beispiel im Fehlerfall == {{page>codesamples:creditcard#transactionstart.response.false&noheader&nofooter}} ==== Benachrichtigung über den Zahlungsausgang ==== Der Ausgang einer Zahlung wird, an die im //urlNotify// Parameter 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 einer Transaktion steht im Feld gcResultPayment. === 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, Penny | |gcCurrency |Ja |String | Währung | |gcResultPayment |Ja |Integer | [[girocheckout:resultcodes#zahlungsausgang|Ergebniscodes der Zahlung]]| |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 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, Penny | |gcCurrency |Ja |String | Währung | |gcResultPayment |Ja |Integer | [[girocheckout:resultcodes#zahlungsausgang|Ergebnis der Zahlung]]| |gcHash |Ja |String | HMAC MD5 hash über alle Werte des Aufrufs. Siehe [[girocheckout:general:start#hash_generieren|hash generieren]] | ===== Weitere Transaktionsarten ===== Diese Transaktionen referenzieren auf eine zuvor erfolgte Transaktion. Die Transaktion basiert auf einer Server zu Server Kommunikation und erfordert keine Kundenaktion (Eingabe von Daten). Bereitzustellen von: GiroCheckout \\ Aufzurufen von: Händler \\ ==== Workflow ==== hide footbox participant "Shop" as shop participant "GiroCheckout" as girocheckout participant "Kreditkartenabwickler" as cc autonumber shop -> girocheckout: girocheckout -> cc: cc -> girocheckout: girocheckout -> shop: center footer (c)2013 by GiroSolution AG - Shop sendet referenzierende Kreditkartentransaktion ([[girocheckout:creditcard:start#referenzierende_transaktionen|referenzierende Transaktionen]]) - GiroCheckout leitet Transaktion zu Kreditkartenabwickler - Kreditkartenabwickler übermittelt Ergebnis an GiroCheckout - Shop bekommt Rückmeldung über Transaktionsausgang ([[girocheckout:creditcard:start#benachrichtigung_ueber_den_zahlungsausgang|Benachrichtigung]]) ==== Buchung (CAPTURE) ==== {{page>girocheckout:transactiontypes:descriptions#capture.desc&noheader&nofooter}} ==== Erstattung (REFUND) ==== {{page>girocheckout:transactiontypes:descriptions#refund.desc&noheader&nofooter}} ==== POST Parameter ==== URL CAPTURE: https://payment.girosolution.de/girocheckout/api/v2/transaction/capture \\ URL REFUND: https://payment.girosolution.de/girocheckout/api/v2/transaction/refund ^Name ^Pflicht ^Type ^Beschreibung ^ |merchantId |Ja |Integer |Händler-ID eines Kreditkarten Projekts | |projectId |Ja |Integer |Projekt-ID eines Kreditkarten Projekts | |merchantTxId |Ja |String(255) |eindeutige Transaktions-ID des Händlers | |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, gemäß [[http://de.wikipedia.org/wiki/ISO_4217#Aktuell_g.C3.BCltige_W.C3.A4hrungen|ISO 4217]].\\ EUR = Euro | |reference |Ja |String |GiroCheckout Transaktions-ID, für die eine Buchung oder Erstattung durchgeführt werden soll | |hash |Ja |String |HMAC MD5 hash über alle Werte des Aufrufs. Siehe [[girocheckout:general:start#hash_generieren|hash generieren]] | == Beispiel == {{page>codesamples:creditcard#capture.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. Sie bekommen als Antwort eine Transaktionsnummer und die redirectURL zum Kreditkartenformular zurück. === Parameter === ^Name ^Pflicht ^Type ^Beschreibung ^ |rc |Ja |Integer |[[girocheckout:errorcodes|Fehlernummer]] | |msg |Ja |String |zusätzliche Informationen im Fehlerfall | |reference |Ja |String | GiroCheckout Transaktions-ID | |merchantTxId |Ja |String | Händler Transaktions-ID | |backendTxId |Ja |String | Zahlungsabwickler Transaktions-ID | |amount |Ja |Integer | bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny | |currency |Ja |String | Währung | |resultPayment |Ja |Integer | [[girocheckout:resultcodes#zahlungsausgang|Ergebnis der Transaktion]]| |hash |Ja |String | HMAC MD5 hash über alle Werte des Aufrufs. Siehe [[girocheckout:general:start#hash_generieren|hash generieren]] | == Beispiel im Erfolgsfall == {{page>codesamples:creditcard#transactionstart.response.true&noheader&nofooter}} == Beispiel im Fehlerfall == {{page>codesamples:creditcard#transactionstart.response.false&noheader&nofooter}} ===== Pseudo-Kartennummer (PKN) ===== Für diese Funktion ist eine separate Einrichtung erforderlich und es fallen einmalige Einrichtungsgebühren an. Eine Pseudo-Kartennummer ist eine Referenz auf eine vom Käufer verwendete Kreditkarte (Kreditkartennummer und Gültigkeitsdatum). Durch dieser Referenz wird dem Händler ermöglicht eine bereits verwendete Kreditkarte zur Auswahl anzubieten. Wird die Nummer bei der Initialisierung einer Kreditkartentransaktion mitgeschickt, wird die Kreditkartennummer und das Gültigkeitsdatum im Zahlformular vorausgefüllt. Der Kunde muss nur die Kartenprüfnummer eingeben und kann die Zahlung durchführen. ==== Pseudo-Kartennummer Informationen abfragen ==== Durch diese Funktion werden PKN-Informationen bereitgestellt. Sie liefert als Erbnis eine PKN sowie die hinterlegten Kreditkarteninformationen (maskierte Kreditkartennummer, Gültigkeitsdatum) , welche für eine bereits durchgeführte Transaktion verwendet wurde. **URL:** https://payment.girosolution.de/girocheckout/api/v2/creditcard/pkninfo \\ **Bereitzustellen von:** GiroCheckout \\ **Aufzurufen von:** Händler ==== POST Parameter ==== ^Name ^Pflicht ^Type ^Beschreibung ^ |merchantId |Ja |Integer |Händler-ID eines Kreditkarten Projekts | |projectId |Ja |Integer |Projekt-ID eines Kreditkarten Projekts | |reference |Ja |String(36)|Eindeutige GiroCheckout Transaktions-ID | |hash |Ja |String(32)|HMAC MD5 hash über alle Werte des Aufrufs. Siehe [[girocheckout:general:start#hash_generieren|hash generieren]]| == Beispiel == {{page>codesamples:creditcard#pkninfo.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 Anfrage erfolgreich abgesetzt. Die Antwort enthält die PKN-Nummer, die Kreditkartennummer und das Gültigkeitsdatum. == Parameter == ^Name ^Pflicht ^Type ^Beschreibung ^ |rc |Ja |Integer |[[girocheckout:errorcodes|Fehlernummer]] | |msg |Ja |String |zusätzliche Informationen im Fehlerfall | |pkn |Ja |String |Pseudo-Kartennummer | |cardnumber |Ja |String |maskierte Kreditkartennummer, z.B. 411111%%******%%1111 | |expiremonth |Ja |String |Monat des Gültigkeitsdatums der Kreditkarte | |expireyear |Ja |String |Jahr des Gültigkeitsdatums der Kreditkarte | ^HEADER Parameter^^^^ |hash |Ja |String |HMAC MD5 hash über alle Werte der Rückmeldung. Siehe [[girocheckout:general:start#uebermittlung_von_daten_ueber_einen_schnittstellenaufruf_an_den_haendler|hash der Rückantwort]] | == Beispiel im Erfolgsfall == {{page>codesamples:creditcard#pkninfo.response.true&noheader&nofooter}} == Beispiel im Fehlerfall == {{page>codesamples:creditcard#pkninfo.response.false&noheader&nofooter}} ===== Durchführen einer wiederkehrenden Kreditkartenzahlung (recurring payment) ===== Die Transaktionsdaten werden übermittelt und das Ergebnis der Kreditkartenzahlung wird umgehend zurückgeliefert. Diese Funktion wird für wiederkehrende Kreditkartenzahlungen, z.B. für Abonnements, verwendet. Folgende Schritte sind durchzuführen, um eine wiederkehrende Zahlung zu implementieren: - Normale Kreditkartentransaktion durchführen (s. [[#initialisierung_einer_kreditkartenzahlung|Initialisierung einer Zahlung]]) - Pseudokartennummer (PKN) ermitteln (s. [[#pseudo-kartennummer_informationen_abfragen|PKN-Infos abfragen]]) - Diese PKN speichern - Bei der nächsten wiederkehrenden Zahlung, eine Payment-Transaktion initialisieren (Endpoint beachten, s. [[#recurring_oder_pkn-transaktion|Recurring oder PKN-Transaktion]]), aber Parameter pkn setzen und Parameter recurring=1. ===== Recurring oder PKN-Transaktion ===== Um eine erneute Buchung auf eine über PKN gespeicherte Kreditkarte durchzuführen, bei der der Kunde lediglich seinen Sicherheitscode eingeben muss, oder um eine wiederkehrende (recurring) Zahlung ohne Kundenintervention durchzuführen, ist die folgende Schnittstelle zu verwenden. ==== POST Parameter ==== URL https://payment.girosolution.de/girocheckout/api/v2/transaction/payment ^Name ^Pflicht ^Type ^Beschreibung ^ |merchantId |Ja |Integer |Händler-ID eines Kreditkarten Projekts | |projectId |Ja |Integer |Projekt-ID eines Kreditkarten Projekts | |merchantTxId |Ja |String(255) |eindeutige Transaktions-ID des Händlers | |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, gemäß [[http://de.wikipedia.org/wiki/ISO_4217#Aktuell_g.C3.BCltige_W.C3.A4hrungen|ISO 4217]].\\ EUR = Euro | |purpose |Ja |String(27) |Verwendungszweck der Kreditkartenransaktion. Diese Information erscheint auf der Kreditkartenabrechnung. | |type |Optional |String |Transaktionsart (siehe [[girocheckout:transactiontypes:start]]) \\ SALE = Verkauf wird sofort gebucht (default) \\ AUTH = Reservierung des Betrags| |pkn |Optional |String(50) |Das Feld dient dazu eine erneute Transaktion, ohne erneute Eingabe der Kreditkartendaten, zu starten. \\ create = neue Pseudo-Kartennummer für die verwendete Kreditkarte generieren \\ [Pseudo-Kartennummer] = Kartennumer der zu verwendenden Kreditkarte (siehe [[girocheckout:creditcard:start#pseudo-kartennummer_pkn|Pseudokartennummer]])\\ | |recurring |Optional |Boolean |wiederkehrende Zahlung \\ 0 = nein (default) \\ 1 = ja, weitere Informationen | |urlNotify |Optional |String |URL, an die der Zahlungsausgang gemeldet werden soll. | |hash |Ja |String |HMAC MD5 hash über alle Werte des Aufrufs. Siehe [[girocheckout:general:start#hash_generieren|hash generieren]] | == Beispiel == {{page>codesamples:creditcard#recurringpayment.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. Sie bekommen als Antwort eine Transaktionsnummer und die das Transaktionsergebnis zurück. === Parameter === ^Name ^Pflicht ^Type ^Beschreibung ^ |rc |Ja |Integer |[[girocheckout:errorcodes|Fehlernummer]] | |msg |Ja |String |zusätzliche Informationen im Fehlerfall | |reference |Ja |String |eindeutige GiroCheckout Transaktions-ID | |backendTxId |Ja |String | Zahlungsabwickler Transaktions-ID | |resultPayment |Ja |Integer | [[girocheckout:resultcodes#zahlungsausgang|Ergebnis der Transaktion]]| ^HEADER Parameter^^^^ |hash |Ja |String |HMAC MD5 hash über alle Werte der Rückmeldung. Siehe [[girocheckout:general:start#uebermittlung_von_daten_ueber_einen_schnittstellenaufruf_an_den_haendler|hash der Rückantwort]] | == Beispiel im Erfolgsfall == {{page>codesamples:creditcard#recurringpayment.response.true&noheader&nofooter}} == Beispiel im Fehlerfall == {{page>codesamples:creditcard#recurringpayment.response.false&noheader&nofooter}}