Girocheckout API

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Zuletzt angesehen:
girocheckout:giropay-id-kvs:start

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Nächste Überarbeitung 		Vorhergehende Überarbeitung
girocheckout:giropay-id-kvs:start [2016/03/15 17:21]
thorstenmarx angelegt 		girocheckout:giropay-id-kvs:start [2021/04/12 14:32] (aktuell)
Zeile 5: Zeile 5:
 Man kann entweder: Man kann entweder:
   * direkt eine IBAN und BIC mitgeben und die so verifizieren lassen oder   * direkt eine IBAN und BIC mitgeben und die so verifizieren lassen oder
-  - gibt nichts mit und erhält die Kontoverbindung+  * gibt nichts mit und erhält die Kontoverbindung
  
 ===== Testdaten ===== ===== Testdaten =====
-{{page>testdata:giropay&noheader&nofooter}}+<WRAP center round important 60%> 
 +Es steht noch keine Testmöglichkeit zur Verfügung. 
 +</WRAP> 
 + 
 +{{page>testdata:giropay-id-kvs&noheader&nofooter}} 
  
 ===== Workflow ===== ===== Workflow =====
Zeile 44: Zeile 49:
  
  
-center footer (c)2013 by GiroSolution AG+center footer (c)2016 by GiroSolution AG
 </uml> </uml>
  
-  - Käufer/Kunde wählt giropay/giropay-ID und gibt BIC seiner Bank ein+  - Kunde wählt seine Bank aus
   - Shop prüft Bankstatus ([[girocheckout:giropay:start#bankstatus_prüfen|Bankstatus prüfen]])   - Shop prüft Bankstatus ([[girocheckout:giropay:start#bankstatus_prüfen|Bankstatus prüfen]])
-  - Shop bekommt Rückmeldung, ob Bank giropay/giropay-ID unterstützt +  - Shop bekommt Rückmeldung, ob Bank giropay-ID Kontoverifikation unterstützt 
-  - Shop initiiert giropay/giropay-ID Transaktion ([[girocheckout:giropay:start#initialisierung_einer_giropay_zahlung|Initialisierung]])+  - Shop initiiert giropay-ID Kontoverifikation Transaktion ([[girocheckout:giropay:start#initialisierung_einer_giropay_zahlung|Initialisierung]])
   - GiroCheckout initialisiert Transaktion bei giropay   - GiroCheckout initialisiert Transaktion bei giropay
   - giropay übermittelt Ergebnis an GiroCheckout   - giropay übermittelt Ergebnis an GiroCheckout
Zeile 78: Zeile 83:
   - Bezahlinformation mit Käuferbrowserweiterleitung zurück zum Händler (durch Käufer nach Zahlung ausgelöst)   - 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.+Im Folgenden werden die API-Felder und Aufrufe näher erläutert. 
 ==== Bankstatus prüfen ==== ==== Bankstatus prüfen ====
-Es wird geprüft ob eine Bank am giropay Bezahlverfahren oder einer giropay-ID Abfrage teilnimmt. 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.+**Dieser Aufruf sollte nicht mehr verwendet werden, alle giropay-Transaktionen werden jetzt mit einer externen Bankenabfrage durchgeführt!** 
 + 
 +Es wird geprüft ob eine Bank giropay-ID Kontoverifikation unterstützt. Diesbezüglich wird die BIC des Käufer-Girokontos übermittelt. Die Antwort zeigt ob eine giropay-ID Kontoverifikation Abfrage möglich ist. Es wid empfohlen vor jeder Initiierung einer giropay-ID Kontoverifikation Abfrage den Bankstatus zu prüfen, da dadurch unnötige Abbrüche verhindert werden können.
  
 === API-Aufruf === === API-Aufruf ===
Zeile 89: Zeile 97:
 == POST-Parameter == == POST-Parameter ==
 ^Name           ^Pflicht  ^Type      ^Beschreibung   ^ ^Name           ^Pflicht  ^Type      ^Beschreibung   ^
-|merchantId     |Ja       |Integer   |Händler-ID eines giropay, giropay-ID oder giropay-ID + giropay Projekts | +|merchantId     |Ja       |Integer   |Händler-ID eines giropay-ID Kontoverifikation Projekts | 
-|projectId      |Ja       |Integer   |Projekt-ID eines giropay, giropay-ID oder giropay-ID + giropay Projekts | +|projectId      |Ja       |Integer   |Projekt-ID eines giropay-ID Kontoverifikation Projekts | 
-|bic            |Ja       |String(11)|BIC der Käuferbank (8 oder 11-stellig), die geprüft werden soll (durch [[tools:bankstatus_widget|Bankauswahl Widget]] ermittelbar)|+|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]])| |hash           |Ja       |String(32)|HMAC MD5 hash über alle Werte des Aufrufs (siehe [[girocheckout:general:start#hash_generieren|hash generieren]])|
  
Zeile 120: Zeile 128:
  
 ==== giropay Bankenabfrage ==== ==== giropay Bankenabfrage ====
-Gibt eine Liste zurück, welche alle giropay Banken enthält. Aus dieser Bankenliste muss der Käufer seine Bank auswählen. +**Dieser Aufruf sollte nicht mehr verwendet werden, alle giropay-Transaktionen werden jetzt mit einer externen Bankenabfrage durchgeführt!** 
 + 
 +Gibt eine Liste zurück, welche alle giropay-ID Kontoverifikation Banken enthält. Aus dieser Bankenliste muss der Käufer seine Bank auswählen. 
  
 **URL:** https://payment.girosolution.de/girocheckout/api/v2/giropay/issuer \\ **URL:** https://payment.girosolution.de/girocheckout/api/v2/giropay/issuer \\
Zeile 128: Zeile 138:
 == POST Parameter == == POST Parameter ==
 ^Name           ^Pflicht  ^Type      ^Beschreibung   ^ ^Name           ^Pflicht  ^Type      ^Beschreibung   ^
-|merchantId     |Ja       |Integer   |Händler-ID eines giropay Projekts | +|merchantId     |Ja       |Integer   |Händler-ID eines giropay-ID Kontoverifikation Projekts | 
-|projectId      |Ja       |Integer   |Projekt-ID eines giropay Projekts |+|projectId      |Ja       |Integer   |Projekt-ID eines giropay-ID Kontoverifikation Projekts |
 |hash           |Ja       |String(32)|HMAC MD5 hash über alle Werte des Aufrufs. Siehe  [[girocheckout:general:start#hash_generieren|hash generieren]]| |hash           |Ja       |String(32)|HMAC MD5 hash über alle Werte des Aufrufs. Siehe  [[girocheckout:general:start#hash_generieren|hash generieren]]|
  
Zeile 150: Zeile 160:
  
  
-==== Initialisierung einer giropay Zahlung ==== +==== Initialisierung einer giropay-ID Kontoverifikation ====
- +
-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. +Durch eine erfolgreiche Initialisierung wird eine Referenznummer erstellt sowie ein Weiterleitungslink (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 === === Anfrage ===
Zeile 162: Zeile 170:
  
 == POST Parameter == == POST Parameter ==
-^Name           ^Pflicht  ^^^Type        ^Beschreibung   ^ +^Name           ^Pflicht  ^Type        ^Beschreibung   ^ 
-^           ^giropay^giropay-ID^giropay+giropay-ID  ^        ^   ^ +|merchantId     |Ja       |Integer     |Händler-ID eines giropay Projekts | 
-|merchantId     |Ja       |Ja       |Ja       |Integer     |Händler-ID eines giropay Projekts | +|projectId      |Ja       |integer     |Projekt-ID eines giropay Projekts | 
-|projectId      |Ja       |Ja       |Ja       |integer     |Projekt-ID eines giropay Projekts | +|merchantTxId   |Ja       |String(255) |eindeutige Transaktions-ID des Händlers | 
-|merchantTxId   |Ja       |Ja       |Ja       |String(255) |eindeutige Transaktions-ID des Händlers | +|bic            |**deprecated** |String(11)  |**Dieser Parameter darf nicht mehr verwendet werden, alle giropay-Transaktionen werden jetzt mit einer externen Bankenabfrage durchgeführt!** BIC der Käuferbank (8 oder 11-stellig) | 
-|amount         |Ja       |         |Ja       |Integer     |Bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny | +|iban           |Optional |String(34)  |IBAN der zu prüfenden Kontoverbindung **ohne Leerzeichen**| 
-|currency       |Ja       |         |Ja       |String(3)   |Währung der Transaktion\\ EUR = Euro| +|info1Label     |Optional |String(30)  |zusätzliche Information zur Anzeige im Online Banking (Feldname) | 
-|purpose        |Ja       |         |Ja       |String(27)  |Verwendungszweck der giropay Überweisung | +|info1Text      |Optional |String(80)  |zusätzliche Information zur Anzeige im Online Banking (Information) | 
-|bic            |Ja       |Ja       |Ja       |String(11)  |BIC der Käuferbank (8 oder 11-stellig) (durch [[tools:bankstatus_widget|Bankauswahl Widget]] ermittelbar)| +|info2Label     |Optional |String(30)  |zusätzliche Information zur Anzeige im Online Banking (Feldname) | 
-|iban           |Optional |Optional |Optional |String(34)  |IBAN der Kundenbankverbindung **ohne Leerzeichen**| +|info2Text      |Optional |String(80)  |zusätzliche Information zur Anzeige im Online Banking (Information) | 
-|info1Label|Optional |Optional |Optional |String(30)  |zusätzliche Information für die giropay Überweisungsseiten (Feldname) | +|info3Label     |Optional |String(30)  |zusätzliche Information zur Anzeige im Online Banking (Feldname) | 
-|info1Text |Optional |Optional |Optional |String(80)  |zusätzliche Information für die giropay Überweisungsseiten (Information) | +|info3Text      |Optional |String(80)  |zusätzliche Information zur Anzeige im Online Banking (Information) | 
-|info2Label|Optional |Optional |Optional |String(30)  |zusätzliche Information für die giropay Überweisungsseiten (Feldname) | +|info4Label     |Optional |String(30)  |zusätzliche Information zur Anzeige im Online Banking (Feldname) | 
-|info2Text |Optional |Optional |Optional |String(80)  |zusätzliche Information für die giropay Überweisungsseiten (Information) | +|info4Text      |Optional |String(80)  |zusätzliche Information zur Anzeige im Online Banking (Information) | 
-|info3Label|Optional |Optional |Optional |String(30)  |zusätzliche Information für die giropay Überweisungsseiten (Feldname) | +|info5Label     |Optional |String(30)  |zusätzliche Information zur Anzeige im Online Banking (Feldname) | 
-|info3Text |Optional |Optional |Optional |String(80)  |zusätzliche Information für die giropay Überweisungsseiten (Information) | +|info5Text      |Optional |String(80)  |zusätzliche Information zur Anzeige im Online Banking (Information) | 
-|info4Label|Optional |Optional |Optional |String(30)  |zusätzliche Information für die giropay Überweisungsseiten (Feldname) | +|urlRedirect    |Ja       |String      |URL, an die der Kunde nach der Kontoverifikation geschickt werden soll. | 
-|info4Text |Optional |Optional |Optional |String(80)  |zusätzliche Information für die giropay Überweisungsseiten (Information) | +|urlNotify      |Ja       |String      |URL, an die der Ausgang der Kontoverifikation gemeldet werden soll. | 
-|info5Label|Optional |Optional |Optional |String(30)  |zusätzliche Information für die giropay Überweisungsseiten (Feldname) | +|hash           |Ja       |String      |HMAC MD5 hash über alle Werte des Aufrufs. Siehe  [[girocheckout:general:start#hash_generieren|hash generieren]] |
-|info5Text |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]] |+
  
  
 <WRAP center round info 60%> <WRAP center round info 60%>
-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.+Mit den info Parametern können zusätzliche Informationen zur Anzeige im Online Banking übermitteln werden. Es sind max. 5 Elemente möglich. Eine Information besteht immer aus einem Label und einer Information.
 </WRAP> </WRAP>
  
Zeile 213: Zeile 217:
 {{page>codesamples:giropay#transactionstart.response.false&noheader&nofooter}} {{page>codesamples:giropay#transactionstart.response.false&noheader&nofooter}}
  
-==== Benachrichtigung über den Zahlungsausgang ====+==== Benachrichtigung über Ergebnis der Kontoverifikation ====
  
-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 Ausgang einer Kontoverifikation 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.+Der Transaktionsausgang der giropay-ID Kontoverifikation steht 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. 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.
Zeile 228: Zeile 232:
  
 == GET Parameter == == GET Parameter ==
-^Name           ^Pflicht  ^^^Type        ^Beschreibung   ^ +^Name           ^Pflicht  ^Type        ^Beschreibung   ^ 
-^           ^giropay^giropay-ID^giropay+giropay-ID  ^        ^   ^ +|gcReference      |Ja      |String      | GiroCheckout Transaktions-ID | 
-|gcReference      |Ja      |Ja      |Ja       |String      | GiroCheckout Transaktions-ID | +|gcMerchantTxId   |Ja      |String      | Händler Transaktions-ID | 
-|gcMerchantTxId   |Ja      |Ja      |Ja       |String      | Händler Transaktions-ID | +|gcBackendTxId    |Ja      |String      | Zahlungsabwickler Transaktions-ID | 
-|gcBackendTxId    |Ja      |Ja      |Ja       |String      | Zahlungsabwickler Transaktions-ID | +|gcResultPayment  |Optional|Integer     | [[girocheckout:resultcodes#zahlungsausgang|Ergebniscodes der giropay Zahlung]]| 
-|gcAmount         |Ja      |        |Ja       |Integer     | bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent | +|gcResultAVS      |Ja      |Integer     | [[girocheckout:resultcodes#kontoverifikation|Ergebniscodes der giropay Kontoverifikation]] | 
-|gcCurrency       |Ja      |        |Ja       |String      | Währung | +|gcAccountHolder  |Ja      |String      | Kontoinhaber des verifizierten Kontos | 
-|gcResultPayment  |Ja      |        |Ja       |Integer     | [[girocheckout:resultcodes#zahlungsausgang|Ergebniscodes der giropay Zahlung]]| +|gsAccountIban    |Ja      |String      | IBAN des verifizierten Kontos | 
-|gcResultAVS      |        |Ja      |Ja       |Integer     | [[girocheckout:resultcodes#altersverifikation|Ergebniscodes der giropay Altersverifikation]] | +|gsAccountBic     |Ja      |String      | BIC des verifizierten Kontos | 
-|gcObvName        | |Optional |Optional |String | Optional zuschaltbares Feld, welches den Namen der zu verifizierenden Person beinhaltet (giropay-ID) | +|gcHash           |Ja      |String      | HMAC MD5 hash über alle Werte des Aufrufs. Siehe  [[girocheckout:general:start#hash_generieren|hash generieren]] |
-|gcHash           |Ja      |Ja      |Ja       |String      | HMAC MD5 hash über alle Werte des Aufrufs. Siehe  [[girocheckout:general:start#hash_generieren|hash generieren]] |+
  
 === Antwort === === Antwort ===
Zeile 249: Zeile 252:
  
 ==== Rückleitung des Kunden zum Händler ==== ==== 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. +Nach Beendigung der giropay-ID Kontoverifikation 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 === === Anfrage ===
Zeile 257: Zeile 260:
  
 == GET Parameter == == GET Parameter ==
-^Name           ^Pflicht  ^^^Type        ^Beschreibung   ^ +^Name           ^Pflicht  ^Type        ^Beschreibung   ^ 
-^           ^giropay^giropay-ID^giropay+giropay-ID  ^        ^   ^ +|gcReference      |Ja      |String      | GiroCheckout Transaktions-ID | 
-|gcReference      |Ja      |Ja      |Ja       |String      | GiroCheckout Transaktions-ID | +|gcMerchantTxId   |Ja      |String      | Händler Transaktions-ID | 
-|gcMerchantTxId   |Ja      |Ja      |Ja       |String      | Händler Transaktions-ID | +|gcBackendTxId    |Ja      |String      | Zahlungsabwickler Transaktions-ID | 
-|gcBackendTxId    |Ja      |Ja      |Ja       |String      | Zahlungsabwickler Transaktions-ID | +|gcResultPayment  |Optional|Integer     | [[girocheckout:resultcodes#zahlungsausgang|Ergebniscodes der giropay Zahlung]]| 
-|gcAmount         |Ja      |        |Ja       |Integer     | bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent | +|gcResultAVS      |Ja      |Integer     | [[girocheckout:resultcodes#kontoverifikation|Ergebniscodes der giropay-ID Kontoverifikation]] | 
-|gcCurrency       |Ja      |        |Ja       |String      | Währung | +|gcHash           |Ja      |String      | HMAC MD5 hash über alle Werte des Aufrufs. Siehe  [[girocheckout:general:start#hash_generieren|hash generieren]] |
-|gcResultPayment  |Ja      |        |Ja       |Integer     | [[girocheckout:resultcodes#zahlungsausgang|Ergebniscodes der giropay Zahlung]]| +
-|gcResultAVS      |        |Ja      |Ja       |Integer     | [[girocheckout:resultcodes#altersverifikation|Ergebniscodes der giropay Altersverifikation]] | +
-|gcObvName        | |Optional | Optional|String | Optional zuschaltbares Feld, welches den Namen der zu verifizierenden Person beinhaltet (giropay-ID) | +
-|gcHash           |Ja      |Ja      |Ja       |String      | HMAC MD5 hash über alle Werte des Aufrufs. Siehe  [[girocheckout:general:start#hash_generieren|hash generieren]] |+
  
girocheckout/giropay-id-kvs/start.1458058906.txt.gz · Zuletzt geändert: 2021/04/12 14:30

Seiten-Werkzeuge