~~NOCACHE~~
====== Maestro ======
Informationen zur Bezahlung mit der Maestro-Karte sind unter https://www.girosolution.de/girocheckout zu finden.

===== Testdaten =====
{{page>testdata:maestro&noheader&nofooter}}

===== Transaktionstypen =====
Detaillierte Informationen zu den [[girocheckout:transactiontypes:start|Transaktionstypen]]. 

==== Reservierung (AUTH) ====
{{page>girocheckout:transactiontypes:descriptions#auth.desc&noheader&nofooter}}

<uml>
left to right direction
skinparam packageStyle rect

rectangle AUTH {
  (AUTH) --> (CAPTURE)
  (AUTH) --> (VOID )
  (CAPTURE) --> (VOID )
  (CAPTURE) --> (REFUND )
  (REFUND ) --> (VOID )
}
</uml>

==== Verkauf (SALE) ====
{{page>girocheckout:transactiontypes:descriptions#sale.desc&noheader&nofooter}}

<uml>
left to right direction
skinparam packageStyle rect

rectangle SALE{
  (SALE) --> (REFUND)
  (SALE) --> (VOID)
  (REFUND) --> (VOID)
}
</uml>

===== Initialisierung einer Maestro-Zahlung =====
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 ====

<uml>
hide footbox

participant "Kunde" as customer
participant "Shop" as shop
participant "GiroCheckout" as girocheckout
participant "Kartenabwickler" 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)2017 by GiroSolution AG
</uml>

  - Käufer wählt Zahlart Maestro aus
  - Shop initiiert Maestro-Transaktion ([[girocheckout:maestro:start#reservierung_sale|Initialisierung]])
  - GiroCheckout initialisiert Transaktion beim Kartenabwickler für Maestro
  - Kartenabwickler übermittelt Ergebnis an GiroCheckout
  - Shop bekommt Rückmeldung über Initialisierungsausgang (bei Fehler ist Transaktion beendet)
  - Shop sendet Redirect URL an Kundenbrowser 
  - Kundenbrowser leitet zum Kartenabwickler weiter
  - Kartenabwickler zeigt Zahlformular an
  - Kunde autorisiert Transaktion
  - Kartenabwickler führt Transaktion durch
  - Kartenabwickler übermittelt Ergebnis an GiroCheckout
  - GiroCheckout benachrichtigt Shop über Transaktionsausgang ([[girocheckout:maestro:start#benachrichtigung_ueber_den_zahlungsausgang|Benachrichtigung]])
  - Shop verarbeitet Transaktionsausgang
  - Shop sendet HTTP Statuscode an GiroCheckout
  - GiroCheckout sendet Rücksprung zum Händler an Kartenabwickler
  - Kunde klickt "Zurück zum Shop" ([[girocheckout:maestro:start#rueckleitung_des_kunden_zum_haendler|Rücksprung]])

===== API-Funktionen =====

==== Überblick =====

Wie im Workflow zu sehen ist, gibt es unterschiedliche API-Aufrufe während einer Maestro-Transaktion. Üblicherweise wird während des Bezahlvorganges noch eine zusätzliche 3D-Secure-Überprüfung stattfinden, die allerdings von Händler und PSP völlig unabhängig ist und nur vom kartenverarbeitenden Institut gesteuert wird.

  - Transaktion initialisieren
  - 3D-Secure-Check (optional)
  - Benachrichtigung des Zahlungsergebnisses an den Händler
  - Zurückleitung des Käufers auf die Händlerseiten (ausgelöst durch Käufer)

==== Reservierung/Sale =====

=== POST Parameter ===
URL https://payment.girosolution.de/girocheckout/api/v2/transaction/start 

^Name           ^Pflicht  ^Type        ^Beschreibung   ^
|merchantId     |Ja  |Integer     |Händler-ID eines Maestro-Projekts |
|projectId      |Ja  |Integer     |Projekt-ID eines Maestro-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 Transaktion. Diese Information erscheint auf der Kartenabrechnung bzw. dem Kontoauszug. |
|type           |Optional |String(4) |Transaktionsart (siehe [[girocheckout:transactiontypes:start]]) \\ SALE = Verkauf wird sofort gebucht (default) \\ AUTH = Reservierung des Betrags|
|locale         |Optional |String(4)   |Sprache des Formulars \\ 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 |
|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:maestro#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 Formular 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 auf das Formular|
^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:maestro#transactionstart.response.true&noheader&nofooter}}

== Beispiel im Fehlerfall ==
{{page>codesamples:maestro#transactionstart.response.false&noheader&nofooter}}


==== Benachrichtigung über den Zahlungsausgang ====

Der Ausgang einer Zahlung wird an die im Parameter //urlNotify// 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 Zahlungsausgang 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 ====

<uml>
hide footbox

participant "Shop" as shop
participant "GiroCheckout" as girocheckout
participant "Kartenabwickler" as cc

autonumber

shop -> girocheckout: 
girocheckout -> cc: 
cc -> girocheckout: 
girocheckout -> shop: 

center footer (c)2017 by GiroSolution AG
</uml>

  - Shop sendet referenzierende Maestro-Transaktion
  - GiroCheckout leitet Transaktion zu Kartenabwickler
  - Kartenabwickler übermittelt Ergebnis an GiroCheckout
  - Shop bekommt Rückmeldung über Transaktionsausgang ([[girocheckout:maestro: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 Maestro-Projekts |
|projectId      |Ja       |Integer     |Projekt-ID eines Maestro-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 |
|purpose        |Optional |String(27)  |Verwendungszweck der Erstattung. Diese Information erscheint auf der Kartenabrechnung. |
|hash           |Ja       |String      |HMAC MD5 hash über alle Werte des Aufrufs. Siehe  [[girocheckout:general:start#hash_generieren|hash generieren]] |

== Beispiel ==
{{page>codesamples:maestro#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    |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:maestro#transactionstart.response.true&noheader&nofooter}}

== Beispiel im Fehlerfall ==
{{page>codesamples:maestro#transactionstart.response.false&noheader&nofooter}}