Girocheckout API

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Zuletzt angesehen:
girocheckout:paypal:start

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
Nächste Überarbeitung 		Vorhergehende Überarbeitung
girocheckout:paypal:start [2017/01/05 18:10]
michaelheumann 		girocheckout:paypal:start [2023/05/08 04:14] (aktuell)
michaelheumann
Zeile 1: Zeile 1:
 ~~NOCACHE~~ ~~NOCACHE~~
 ====== PayPal ====== ====== PayPal ======
-Informationen zu PayPal sind unter https://www.girosolution.de/girocheckout/fuer-haendler/ zu finden. 
  
 ===== Testdaten ===== ===== Testdaten =====
Zeile 36: Zeile 35:
  
  
-center footer (c)2013 by GiroSolution AG+center footer (c)2021 by GiroSolution GmbH
 </uml> </uml>
  
Zeile 71: Zeile 70:
 ==== Initialisierung einer PayPal Zahlung ==== ==== Initialisierung einer PayPal Zahlung ====
  
-Durch eine erfolgreiche Initialisierung wird eine Referenznummer erstellt sowie ein Weiterleitunsurl (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. +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 === === Anfrage ===
Zeile 82: Zeile 81:
 |merchantId     |Ja       |Integer     |Händler-ID eines PayPal Projekts | |merchantId     |Ja       |Integer     |Händler-ID eines PayPal Projekts |
 |projectId      |Ja       |integer     |Projekt-ID eines PayPal Projekts | |projectId      |Ja       |integer     |Projekt-ID eines PayPal Projekts |
-|merchantTxId   |Ja       |String(255) |Eindeutige Transaktions-ID des Händlers |+|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| |amount         |Ja       |Integer     |Betrag in Cent|
 |currency       |Ja       |String(3)   |Währung der Transaktion\\ EUR = Euro| |currency       |Ja       |String(3)   |Währung der Transaktion\\ EUR = Euro|
 |purpose        |Ja       |String(27)  |Verwendungszweck der PayPal Transaktion | |purpose        |Ja       |String(27)  |Verwendungszweck der PayPal Transaktion |
-|urlRedirect    |Ja       |String      |URL, an die der Kunde nach der Zahlung geschickt werden soll. | +|type           |Optional |String(4) |Transaktionsart (siehe [[girocheckout:transactiontypes:start]]) \\ SALE = Verkauf wird sofort gebucht (default) \\ AUTH = Reservierung des Betrags| 
-|urlNotify      |Ja       |String      |URL, an die der Zahlungsausgang gemeldet werden soll. | +|urlRedirect    |Ja       |String(2048)      |URL, an die der Kunde nach der Zahlung geschickt werden soll. | 
-|hash           |Ja       |String      |HMAC MD5 hash über alle Werte des Aufrufs. Siehe  [[girocheckout:general:start#hash_generieren|hash generieren]] |+|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 == == Beispiel ==
Zeile 100: Zeile 101:
 ^Name           ^Pflicht  ^Type      ^Beschreibung   ^ ^Name           ^Pflicht  ^Type      ^Beschreibung   ^
 |rc             |Ja       |Integer   |[[girocheckout:errorcodes|Fehlernummer]] | |rc             |Ja       |Integer   |[[girocheckout:errorcodes|Fehlernummer]] |
-|msg            |Ja       |String    |zusätzliche Informationen im Fehlerfall | +|msg            |Ja       |String(255)    |zusätzliche Informationen im Fehlerfall | 
-|reference      |Optional |String    |eindeutige GiroCheckout Transaktions-ID | +|reference      |Optional |String(36)    |eindeutige GiroCheckout Transaktions-ID | 
-|redirect       |Optional |String    |Redirect URL zur Weiterleitung des Kunden zu PayPal|+|redirect       |Optional |String(2048)    |Redirect URL zur Weiterleitung des Kunden zu PayPal|
 ^HEADER Parameter^^^^ ^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]] |+|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 == == Beispiel im Erfolgsfall ==
Zeile 111: Zeile 112:
 == Beispiel im Fehlerfall == == Beispiel im Fehlerfall ==
 {{page>codesamples:paypal#transactionstart.response.false&noheader&nofooter}} {{page>codesamples:paypal#transactionstart.response.false&noheader&nofooter}}
- 
  
 ==== Benachrichtigung über den Zahlungsausgang ==== ==== Benachrichtigung über den Zahlungsausgang ====
Zeile 126: Zeile 126:
 == GET Parameter == == GET Parameter ==
 ^Name             ^Pflicht    ^  Type        ^Beschreibung   ^ ^Name             ^Pflicht    ^  Type        ^Beschreibung   ^
-|gcReference      |Ja       |String      | GiroCheckout Transaktions-ID | +|gcReference      |Ja       |String(36)      | GiroCheckout Transaktions-ID | 
-|gcMerchantTxId   |Ja       |String      | Händler Transaktions-ID | +|gcMerchantTxId   |Ja       |String(255)      | Händler Transaktions-ID | 
-|gcBackendTxId    |Ja       |String      | Zahlungsabwickler 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 | |gcAmount         |Ja       |Integer     | bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny |
-|gcCurrency       |Ja       |String      | Währung |+|gcCurrency       |Ja       |String(3)      | Währung |
 |gcResultPayment  |Ja       |Integer     | [[girocheckout:resultcodes#zahlungsausgang|Ergebniscodes der Zahlung]]| |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]] |+|gcHash           |Ja       |String(32)      | HMAC MD5 hash über alle Werte des Aufrufs. Siehe  [[girocheckout:general:start#hash_generieren|hash generieren]] |
  
 === Antwort === === Antwort ===
Zeile 152: Zeile 152:
 == GET Parameter == == GET Parameter ==
 ^Name             ^Pflicht  ^Type        ^Beschreibung   ^ ^Name             ^Pflicht  ^Type        ^Beschreibung   ^
-|gcReference      |Ja       |String      | GiroCheckout Transaktions-ID | +|gcReference      |Ja       |String(36)      | GiroCheckout Transaktions-ID | 
-|gcMerchantTxId   |Ja       |String      | Händler Transaktions-ID | +|gcMerchantTxId   |Ja       |String(255)     | Händler Transaktions-ID | 
-|gcBackendTxId    |Ja       |String      | Zahlungsabwickler 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 | |gcAmount         |Ja       |Integer     | bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny |
-|gcCurrency       |Ja       |String      | Währung |+|gcCurrency       |Ja       |String(3)      | Währung |
 |gcResultPayment  |Ja       |Integer     | [[girocheckout:resultcodes#zahlungsausgang|Ergebnis der Zahlung]]| |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]] |+|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.txt · Zuletzt geändert: 2023/05/08 04:14

Seiten-Werkzeuge