Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
girocheckout:giropay-id-kvs:start [2016/03/16 17:03] thorstenmarx [Initialisierung einer giropay-ID Altersverifikation] |
girocheckout:giropay-id-kvs:start [2021/04/12 14:32] |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
- | ====== giropay-ID Kontoverifikation ====== | ||
- | |||
- | Bei der giropay-ID Kontoverifikation bestätigt die Bank des Kunden die IBAN und BIC sowie den Namen des Kontoinhabers. Diese „Klarinformationen" | ||
- | |||
- | Man kann entweder: | ||
- | * direkt eine IBAN und BIC mitgeben und die so verifizieren lassen oder | ||
- | * gibt nichts mit und erhält die Kontoverbindung | ||
- | |||
- | ===== Testdaten ===== | ||
- | <WRAP center round important 60%> | ||
- | Es steht noch keine Testmöglichkeit zur Verfügung. | ||
- | </ | ||
- | |||
- | {{page> | ||
- | |||
- | |||
- | ===== Workflow ===== | ||
- | |||
- | <uml> | ||
- | hide footbox | ||
- | |||
- | participant " | ||
- | participant " | ||
- | participant " | ||
- | participant " | ||
- | participant " | ||
- | |||
- | autonumber | ||
- | |||
- | customer -> shop: | ||
- | shop -> girocheckout: | ||
- | girocheckout -> shop: | ||
- | shop -> girocheckout: | ||
- | girocheckout -> giropay: | ||
- | giropay -> girocheckout: | ||
- | girocheckout -> shop: | ||
- | shop -> customer: | ||
- | customer -> bank: | ||
- | bank -> customer: | ||
- | customer -> bank: | ||
- | bank -> bank: | ||
- | bank -> giropay: | ||
- | giropay -> girocheckout: | ||
- | girocheckout -> shop | ||
- | shop -> shop: | ||
- | shop -> girocheckout: | ||
- | girocheckout -> giropay: | ||
- | giropay -> shop: | ||
- | |||
- | |||
- | center footer (c)2016 by GiroSolution AG | ||
- | </ | ||
- | |||
- | - Kunde wählt seine Bank aus | ||
- | - Shop prüft Bankstatus ([[girocheckout: | ||
- | - Shop bekommt Rückmeldung, | ||
- | - Shop initiiert giropay-ID Kontoverifikation Transaktion ([[girocheckout: | ||
- | - GiroCheckout initialisiert Transaktion bei giropay | ||
- | - giropay übermittelt Ergebnis an GiroCheckout | ||
- | - Shop bekommt Rückmeldung über Initialisierungsausgang (bei Fehler ist Transaktion beendet) | ||
- | - Shop sendet Redirect URL an Käufer-/ | ||
- | - Käufer-/ | ||
- | - Online-Banking zeigt Loginseite an | ||
- | - Käufer/ | ||
- | - Bank führt Auftrag durch | ||
- | - Bank übermittelt Ergebnis an giropay | ||
- | - giropay übermittelt Ergebnis an GiroCheckout | ||
- | - GiroCheckout benachrichtigt Shop über Ausgang ([[girocheckout: | ||
- | - Shop verarbeitet Ausgang | ||
- | - Shop sendet HTTP Statuscode an GiroCheckout | ||
- | - GiroCheckout sendet Rücksprung zum Händler an giropay | ||
- | - Käufer/ | ||
- | |||
- | ===== API-Funktionen ===== | ||
- | |||
- | ==== Übersicht ===== | ||
- | |||
- | Wie im Workflow dargestellt gibt es mehrere API-Aufrufe während einer giropay Transaktion oder giropay-ID Abfrage. Eine giropay Transaktion kann zusätzlich mit einer giropay-ID Abfrage kombiniert gesendet werden. | ||
- | |||
- | - Bankstatus prüfen | ||
- | - Transaktion initiieren | ||
- | - 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. | ||
- | ==== Bankstatus prüfen ==== | ||
- | 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 === | ||
- | **URL:** https:// | ||
- | **Bereitzustellen von:** GiroCheckout \\ | ||
- | **Aufzurufen von:** Händler | ||
- | |||
- | == POST-Parameter == | ||
- | ^Name | ||
- | |merchantId | ||
- | |projectId | ||
- | |bic |Ja | ||
- | |hash | ||
- | |||
- | == Beispiel == | ||
- | {{page> | ||
- | |||
- | === Antwort === | ||
- | Die Antwort besteht aus einem JSON Objekt. Das Feld rc liefert einen Fehlercode. Wird **rc = 0** zurückgeliefert, | ||
- | |||
- | == JSON-Parameter == | ||
- | ^Name | ||
- | |rc | ||
- | |msg |Ja | ||
- | |bankcode | ||
- | |bic |Optional |String | ||
- | |bankname | ||
- | |giropay | ||
- | |giropayid | ||
- | ^HEADER Parameter^^^^ | ||
- | |hash | ||
- | |||
- | == Beispiel im Erfolgsfall == | ||
- | {{page> | ||
- | |||
- | == Beispiel im Fehlerfall == | ||
- | {{page> | ||
- | |||
- | |||
- | ==== giropay Bankenabfrage ==== | ||
- | 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:// | ||
- | **Bereitzustellen von:** GiroSolution AG \\ | ||
- | **Aufzurufen von:** Händler | ||
- | |||
- | == POST Parameter == | ||
- | ^Name | ||
- | |merchantId | ||
- | |projectId | ||
- | |hash | ||
- | |||
- | == Beispiel == | ||
- | {{page> | ||
- | |||
- | === Antwort === | ||
- | Die Antwort enthält ein JSON Objekt. Wenn **rc = 0** zurückgeliefert wird, enthält das Element **issuer** die zur Verfügung stehenden Banken. | ||
- | |||
- | == Parameter == | ||
- | ^Name | ||
- | |rc | ||
- | |msg |Ja | ||
- | |issuer | ||
- | ^HEADER Parameter^^^^ | ||
- | |hash | ||
- | |||
- | == Beispiel == | ||
- | {{page> | ||
- | |||
- | |||
- | ==== Initialisierung einer giropay-ID Kontoverifikation ==== | ||
- | |||
- | 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, | ||
- | |||
- | === Anfrage === | ||
- | **URL:** https:// | ||
- | **Bereitzustellen von:** GiroCheckout \\ | ||
- | **Aufzurufen von:** Händler | ||
- | |||
- | == POST Parameter == | ||
- | ^Name | ||
- | |merchantId | ||
- | |projectId | ||
- | |merchantTxId | ||
- | |bic |Optional |String(11) | ||
- | |iban | ||
- | |info1Label | ||
- | |info1Text | ||
- | |info2Label | ||
- | |info2Text | ||
- | |info3Label | ||
- | |info3Text | ||
- | |info4Label | ||
- | |info4Text | ||
- | |info5Label | ||
- | |info5Text | ||
- | |urlRedirect | ||
- | |urlNotify | ||
- | |hash | ||
- | |||
- | |||
- | <WRAP center round info 60%> | ||
- | 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. | ||
- | </ | ||
- | |||
- | |||
- | == Beispiel == | ||
- | {{page> | ||
- | |||
- | === Antwort === | ||
- | Die Antwort besteht aus einem JSON Objekt. Das Feld rc liefert einen Fehlercode zurück. Wird rc = 0 zurückgeliefert, | ||
- | |||
- | == Parameter == | ||
- | ^Name | ||
- | |rc | ||
- | |msg |Ja | ||
- | |reference | ||
- | |redirect | ||
- | ^HEADER Parameter^^^^ | ||
- | |hash | ||
- | |||
- | == Beispiel im Erfolgsfall == | ||
- | {{page> | ||
- | |||
- | == Beispiel im Fehlerfall == | ||
- | {{page> | ||
- | |||
- | ==== Benachrichtigung über Ergebnis der Kontoverifikation ==== | ||
- | |||
- | Der Ausgang einer Kontoverifikation wird an die im // | ||
- | |||
- | 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 // | ||
- | |||
- | |||
- | === Anfrage === | ||
- | **URL:** notifyUrl aus der Transaktionsinitialisierung \\ | ||
- | **Bereitzustellen von:** Händler \\ | ||
- | **Aufzurufen von:** GiroCheckout | ||
- | |||
- | == GET Parameter == | ||
- | ^Name | ||
- | |gcReference | ||
- | |gcMerchantTxId | ||
- | |gcBackendTxId | ||
- | |gcResultPayment | ||
- | |gcResultAVS | ||
- | |gcAccountHolder | ||
- | |gsAccountIban | ||
- | |gsAccountBic | ||
- | |gcHash | ||
- | |||
- | === Antwort === | ||
- | Als Antwort auf den GET-Request wird einer der folgenden HTTP Statuscodes erwartet. | ||
- | |||
- | ^HTTP Statuscode | ||
- | |200 (OK) |Die Benachrichtigung wurde korrekt verarbeitet. | | ||
- | |400 (Bad Request) | ||
- | |Alle anderen | ||
- | |||
- | ==== Rückleitung des Kunden zum Händler ==== | ||
- | 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 === | ||
- | **URL:** redirectUrl aus der Transaktionsinitialisierung \\ | ||
- | **Bereitzustellen von:** Händler \\ | ||
- | **Aufzurufen von:** GiroCheckout | ||
- | |||
- | == GET Parameter == | ||
- | ^Name | ||
- | |gcReference | ||
- | |gcMerchantTxId | ||
- | |gcBackendTxId | ||
- | |gcResultPayment | ||
- | |gcResultAVS | ||
- | |gcHash | ||