Girocheckout API

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Zuletzt angesehen:
girocheckout:paypal:start

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Nächste Überarbeitung 		Vorhergehende Überarbeitung
girocheckout:paypal:start [2013/07/18 08:05]
127.0.0.1 Externe Bearbeitung 		girocheckout:paypal:start [2023/05/08 04:14] (aktuell)
michaelheumann
Zeile 1: Zeile 1:
 +~~NOCACHE~~
 ====== PayPal ====== ====== PayPal ======
  
 +===== Testdaten =====
 +{{page>testdata:paypal&noheader&nofooter}}
 +
 +===== Workflow =====
 +
 +<uml>
 +hide footbox
 +
 +participant "Kunde" as customer
 +participant "Shop" as shop
 +participant "GiroCheckout" as girocheckout
 +participant "PayPal" as paypal
 +
 +autonumber
 +
 +customer -> shop: 
 +shop -> girocheckout: 
 +girocheckout -> paypal: 
 +paypal -> girocheckout: 
 +girocheckout -> shop: 
 +shop -> customer: 
 +customer -> paypal:
 +paypal -> customer: 
 +customer -> paypal
 +paypal -> paypal: 
 +paypal -> girocheckout:
 +girocheckout -> shop
 +shop -> shop: 
 +shop -> girocheckout: 
 +girocheckout -> paypal: 
 +paypal -> shop: 
 +
 +
 +center footer (c)2021 by GiroSolution GmbH
 +</uml>
 +
 +  - Käufer wählt Zahlart PayPal aus
 +  - Shop initiiert PayPal-Zahlung ([[girocheckout:paypal:start#initialisierung_einer_paypal_zahlung|Initialisierung]])
 +  - GiroCheckout initialisiert Transaktion bei PayPal
 +  - PayPal übermittelt Ergebnis an GiroCheckout
 +  - Shop bekommt Rückmeldung über Initialisierungsausgang (bei Fehler ist Transaktion beendet)
 +  - Shop sendet Redirect URL an Kundenbrowser 
 +  - Kundenbrowser leitet zu PayPal weiter
 +  - PayPal zeigt Zahlformular an
 +  - Kunde autorisiert Transaktion
 +  - PayPal führt Transaktion durch
 +  - PayPal übermittelt Ergebnis an GiroCheckout
 +  - GiroCheckout benachrichtigt Shop über Transaktionsausgang ([[girocheckout:paypal:start#benachrichtigung_ueber_den_zahlungsausgang|Banachrichtigung]])
 +  - Shop verarbeitet Transaktionsausgang
 +  - Shop sendet HTTP Statuscode an GiroCheckout
 +  - GiroCheckout sendet Rücksprung zum Händler an PayPal
 +  - Kunde klickt "Zurück zum Shop" ([[girocheckout:paypal:start#rueckleitung_des_kunden_zum_haendler|Rücksprung]])
 +
 +===== API-Funktionen =====
 +
 +==== Übersicht =====
 +
 +Wie im Workflow dargestellt gibt es mehrere API-Aufrufe während einer PayPal Transaktion.
 +
 +  - Transaktion initiieren
 +  - PayPal Bezahlung durchführen
 +  - 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.
 +
 +==== Initialisierung einer PayPal Zahlung ====
 +
 +Durch eine erfolgreiche Initialisierung wird eine Referenznummer erstellt sowie eine Weiterleitungs-URL (redirect) an den Händler übermittelt. 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. 
 +
 +=== 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 PayPal Projekts |
 +|projectId      |Ja       |integer     |Projekt-ID eines PayPal 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     |Betrag in Cent|
 +|currency       |Ja       |String(3)   |Währung der Transaktion\\ EUR = Euro|
 +|purpose        |Ja       |String(27)  |Verwendungszweck der PayPal Transaktion |
 +|type           |Optional |String(4) |Transaktionsart (siehe [[girocheckout:transactiontypes:start]]) \\ SALE = Verkauf wird sofort gebucht (default) \\ AUTH = Reservierung des Betrags|
 +|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  [[girocheckout:general:start#hash_generieren|hash generieren]] |
 +
 +== Beispiel ==
 +{{page>codesamples:paypal#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 eine redirectURL zum PayPal Formular zurück.
 +
 +== Parameter ==
 +^Name           ^Pflicht  ^Type      ^Beschreibung   ^
 +|rc             |Ja       |Integer   |[[girocheckout:errorcodes|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 zu PayPal|
 +^HEADER Parameter^^^^
 +|hash           |Ja       |String(32)    |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:paypal#transactionstart.response.true&noheader&nofooter}}
 +
 +== Beispiel im Fehlerfall ==
 +{{page>codesamples:paypal#transactionstart.response.false&noheader&nofooter}}
 +
 +==== Benachrichtigung über den Zahlungsausgang ====
 +
 +Der Ausgang einer 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 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(36)      | GiroCheckout Transaktions-ID |
 +|gcMerchantTxId   |Ja       |String(255)      | Händler Transaktions-ID |
 +|gcBackendTxId    |Ja       |String(22)      | Zahlungsabwickler Transaktions-ID |
 +|gcAmount         |Ja       |Integer     | bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny |
 +|gcCurrency       |Ja       |String(3)      | Währung |
 +|gcResultPayment  |Ja       |Integer     | [[girocheckout:resultcodes#zahlungsausgang|Ergebniscodes der Zahlung]]|
 +|gcHash           |Ja       |String(32)      | 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(36)      | GiroCheckout Transaktions-ID |
 +|gcMerchantTxId   |Ja       |String(255)     | Händler Transaktions-ID |
 +|gcBackendTxId    |Ja       |String(22)      | Zahlungsabwickler Transaktions-ID |
 +|gcAmount         |Ja       |Integer     | bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny |
 +|gcCurrency       |Ja       |String(3)      | Währung |
 +|gcResultPayment  |Ja       |Integer     | [[girocheckout:resultcodes#zahlungsausgang|Ergebnis der Zahlung]]|
 +|gcHash           |Ja       |String(32)      | 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 ====
 +
 +<uml>
 +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)2016 by GiroSolution AG
 +</uml>
 +
 +  - Shop sendet referenzierende Kreditkartentransaktion
 +  - 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. 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, gemäß [[http://de.wikipedia.org/wiki/ISO_4217#Aktuell_g.C3.BCltige_W.C3.A4hrungen|ISO 4217]].\\ EUR = Euro |
 +|purpose        |Optional |String(27)  |Verwendungszweck der Erstattung oder des Capture. Diese Information erscheint auf der Kreditkartenabrechnung. |
 +|reference      |Ja       |String(36)      |GiroCheckout Transaktions-ID, für die eine Buchung oder Erstattung durchgeführt werden soll |
 +|kassenzeichen  |Optional |String(255)      |(Nur Capture) 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. |
 +|hash           |Ja       |String(32)      |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 weitere Informationen zurück.
 +
 +== Parameter ==
 +^Name             ^Pflicht  ^Type        ^Beschreibung   ^
 +|rc             |Ja       |Integer   |[[girocheckout:errorcodes|Fehlernummer]] |
 +|msg            |Ja       |String(255)    |zusätzliche Informationen im Fehlerfall |
 +|reference      |Ja       |String(36)      | GiroCheckout Transaktions-ID |
 +|referenceParent      |Ja       |String(36)      | GiroCheckout Transaktions-ID der zugrundeliegenden Ursprungstransaktion |
 +|merchantTxId   |Ja       |String(255)      | Händler Transaktions-ID |
 +|backendTxId    |Ja       |String(22)      | Zahlungsabwickler Transaktions-ID |
 +|amount         |Ja       |Integer     | bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny |
 +|currency       |Ja       |String(3)      | Währung |
 +|resultPayment  |Ja       |Integer     | [[girocheckout:resultcodes#zahlungsausgang|Ergebnis der Transaktion]]|
 +|hash           |Ja       |String(32)      | 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}}
girocheckout/paypal/start.1374127538.txt.gz · Zuletzt geändert: 2021/04/12 14:30

Seiten-Werkzeuge