Girocheckout API

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Zuletzt angesehen:
girocheckout:eps:start

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Nächste Überarbeitung 		Vorhergehende Überarbeitung
girocheckout:eps:start [2014/07/12 21:08]
jeromejung angelegt 		girocheckout:eps:start [2023/05/05 03:19] (aktuell)
michaelheumann
Zeile 1: Zeile 1:
-====== EPS ======+~~NOCACHE~~ 
 +====== eps ======
  
-Informationen zu EPS sind unter https://www.girosolution.de/girocheckout/bezahlverfahren.html zu finden.+eps kann **ausschließlich** mit der Währung **EURO** verwendet werden.
  
 ===== Testdaten ===== ===== Testdaten =====
- 
 {{page>testdata:eps&noheader&nofooter}} {{page>testdata:eps&noheader&nofooter}}
  
 ===== Workflow ===== ===== Workflow =====
 +
 <uml> <uml>
 hide footbox hide footbox
  
-participant "Kunde" as customer+participant "Käufer/Kunde" as customer
 participant "Shop" as shop participant "Shop" as shop
 participant "GiroCheckout" as girocheckout participant "GiroCheckout" as girocheckout
-participant "EPS" as eps+participant "eps" as eps
 participant "Online-Banking" as bank participant "Online-Banking" as bank
  
 autonumber autonumber
  
-customer -> shop:  +customer -> shop:
-shop -> girocheckout:  +
-girocheckout -> shop: +
 shop -> girocheckout: shop -> girocheckout:
 girocheckout -> eps:  girocheckout -> eps: 
Zeile 27: Zeile 26:
 girocheckout -> shop:  girocheckout -> shop: 
 shop -> customer:  shop -> customer: 
-customer -> bank:+customer -> eps: 
 +eps -> bank:
 bank -> customer:  bank -> customer: 
 customer -> bank: customer -> bank:
Zeile 43: Zeile 43:
 </uml> </uml>
  
-  - Käufer wählt Zahlart EPS aus +  - Käufer/Kunde wählt eps und gibt BIC seiner Bank ein 
-  - Shop prüft teilnehmende Banken ([[girocheckout:eps:start#eps_bankenabfrage|Bankenabfrage]]) +  - Shop initiiert eps Transaktion ([[girocheckout:eps:start#initialisierung_einer_eps_zahlung|Initialisierung]])
-  - Shop bekommt Rückmeldung, welche Banken EPS unterstützt +
-  - Shop initiiert EPS Transaktion ([[girocheckout:eps:start#initialisierung_einer_eps_zahlung|Initialisierung]])+
   - GiroCheckout initialisiert Transaktion bei eps   - GiroCheckout initialisiert Transaktion bei eps
-  - EPS übermittelt Ergebnis an GiroCheckout+  - eps übermittelt Ergebnis an GiroCheckout
   - Shop bekommt Rückmeldung über Initialisierungsausgang (bei Fehler ist Transaktion beendet)   - Shop bekommt Rückmeldung über Initialisierungsausgang (bei Fehler ist Transaktion beendet)
-  - Shop sendet Redirect URL an Kundenbrowser  +  - Shop sendet Redirect URL an Käufer-/Kundenbrowser  
-  - Kundenbrowser leitet zum Online-Banking weiter +  - Käufer-/Kundenbrowser leitet zu eps weiter, wo die Bankauswahl erfolgt (optional, falls nicht schon im Browser gesp[eichert) 
-  - Online-Banking zeigt Kundenloginseite an +  - eps leitet dann an das Online-Banking der entsprechenden Bank weiter 
-  - Kunde autorisiert Transaktion +  - Online-Banking zeigt Loginseite an 
-  - Bank führt Überweisung durch +  - Käufer/Kunde autorisiert Transaktion 
-  - Bank übermittelt Ergebnis an EPS +  - Bank führt Auftrag durch 
-  - EPS übermittelt Ergebnis an GiroCheckout +  - Bank übermittelt Ergebnis an eps 
-  - GiroCheckout benachrichtigt Shop über Transaktionsausgang ([[girocheckout:eps:start#benachrichtigung_ueber_den_zahlungsausgang|Benachrichtigung]]) +  - eps übermittelt Ergebnis an GiroCheckout 
-  - Shop verarbeitet Transaktionsausgang+  - GiroCheckout benachrichtigt Shop über Ausgang ([[girocheckout:eps:start#Benachrichtigung_über_den_Zahlungsausgang|Benachrichtigung]]) 
 +  - Shop verarbeitet Ausgang
   - Shop sendet HTTP Statuscode an GiroCheckout   - Shop sendet HTTP Statuscode an GiroCheckout
-  - GiroCheckout sendet Rücksprung zum Händler an EPS +  - GiroCheckout sendet Rücksprung zum Händler an eps 
-  - Kunde klickt "Zurück zum Shop" ([[girocheckout:eps:start#rueckleitung_des_kunden_zum_händler|Rücksprung]])+  - Käufer/Kunde klickt "Zurück zum Shop" ([[girocheckout:eps:start#Rückleitung_des_Kunden_zum_Händler|Rücksprung]]) 
 ===== API-Funktionen ===== ===== API-Funktionen =====
  
 ==== Übersicht ===== ==== Übersicht =====
  
-Wie im Workflow dargestellt gibt es mehrere API-Aufrufe während einer EPS Transaktion.+Wie im Workflow dargestellt gibt es mehrere API-Aufrufe während einer eps Transaktion.
  
-  - EPS Bankenabfrage+  - Bankstatus prüfen
   - Transaktion initiieren   - Transaktion initiieren
   - Bezahlinformation an Händler übermitteln   - Bezahlinformation an Händler übermitteln
Zeile 75: Zeile 75:
 Im Folgenden werden die API-Felder und Aufrufe näher erleutert. Im Folgenden werden die API-Felder und Aufrufe näher erleutert.
  
 +==== Bankstatus prüfen ====
 +**Dieser Aufruf sollte nicht mehr verwendet werden, alle eps-Transaktionen werden jetzt mit einer externen Bankenabfrage durchgeführt!**
  
-==== EPS Bankenabfrage ==== +Es wird geprüft ob eine Bank am eps Bezahlverfahren teilnimmt. Diesbezüglich wird die BIC des Käufer-Girokontos übermittelt. Die Antwort zeigt ob eine eps Transaktion möglich ist. Es wid empfohlen vor jeder Initiierung einer eps Transaktion den Bankstatus zu prüfen, da dadurch unnötige Verkaufsabbrüche verhindert werden können. 
-Gibt eine Liste zurück, welche alle EPS Banken enthält. Aus dieser Bankenliste muss der Käufer seine Bank auswählen. + 
 +=== API-Aufruf === 
 +**URL:** https://payment.girosolution.de/girocheckout/api/v2/eps/bankstatus \\ 
 +**Bereitzustellen von:** GiroCheckout \\ 
 +**Aufzurufen von:** Händler 
 + 
 +== POST-Parameter == 
 +^Name           ^Pflicht  ^Type      ^Beschreibung   ^ 
 +|merchantId     |Ja       |Integer   |Händler-ID eines eps Projekts | 
 +|projectId      |Ja       |Integer   |Projekt-ID eines eps Projekts | 
 +|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]])| 
 + 
 +== Beispiel == 
 +{{page>codesamples:eps#bankstatus.request&noheader&nofooter}} 
 + 
 +=== Antwort === 
 +Die Antwort besteht aus einem JSON Objekt. Das Feld rc liefert einen Fehlercode. Wird **rc = 0** zurückgeliefert, unterstützt die angefragte Bank eps, sonst enthält er einen entsprechenden Fehlercode. Zusätzliche Informationen zur Unterstützung von eps ist dem Element //eps// zu entnehmen. Sind zusätzliche Informationen zur Bank bekannt, werden diese ebenfalls zurückgeliefert. 
 + 
 +== JSON-Parameter == 
 +^Name           ^Pflicht  ^Type      ^Beschreibung   ^ 
 +|rc             |Ja       |Integer    |[[girocheckout:errorcodes|Fehlernummer]] | 
 +|msg            |Ja       |String(255)|zusätzliche Informationen im Fehlerfall | 
 +|bankcode       |Optional |Integer    |Bankleitzahl| 
 +|bic            |Optional |String(11) |BIC, wenn vorhanden | 
 +|bankname       |Optional |String(100)|Bankname | 
 +|eps            |Optional |Integer    |0 = eps Zahlung wird nicht unterstützt \\ 1 = eps Zahlung wird unterstützt | 
 +^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:eps#bankstatus.response&noheader&nofooter}} 
 + 
 +==== eps Bankenabfrage ==== 
 +**Dieser Aufruf sollte nicht mehr verwendet werden, alle eps-Transaktionen werden jetzt mit einer externen Bankenabfrage durchgeführt!** 
 + 
 +Gibt eine Liste zurück, welche alle eps Banken enthält. Aus dieser Bankenliste muss der Käufer seine Bank auswählen. 
  
 **URL:** https://payment.girosolution.de/girocheckout/api/v2/eps/issuer \\ **URL:** https://payment.girosolution.de/girocheckout/api/v2/eps/issuer \\
Zeile 85: Zeile 123:
 == POST Parameter == == POST Parameter ==
 ^Name           ^Pflicht  ^Type      ^Beschreibung   ^ ^Name           ^Pflicht  ^Type      ^Beschreibung   ^
-|merchantId     |Ja       |Integer   |Händler-ID eines EPS Projekts | +|merchantId     |Ja       |Integer   |Händler-ID eines eps Projekts | 
-|projectId      |Ja       |Integer   |Projekt-ID eines EPS Projekts |+|projectId      |Ja       |Integer   |Projekt-ID eines eps 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 97: Zeile 135:
 == Parameter == == Parameter ==
 ^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 | 
-|issuer         |Optional |Array     |Liste der EPS issuer Banken |+|issuer         |Optional |Array      |Liste der eps issuer Banken bestehend aus dem Key BIC und dem Bankname |
 ^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 == == Beispiel ==
Zeile 107: Zeile 145:
  
  
- +==== Initialisierung einer eps Zahlung ====
-==== Initialisierung einer EPS Zahlung ==== +
 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 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. 
  
Zeile 119: Zeile 155:
 == POST Parameter == == POST Parameter ==
 ^Name           ^Pflicht  ^Type        ^Beschreibung   ^ ^Name           ^Pflicht  ^Type        ^Beschreibung   ^
-|merchantId     |Ja       |Integer     |Händler-ID eines EPS Projekts | +|merchantId     |Ja       |Integer     |Händler-ID eines eps Projekts | 
-|projectId      |Ja       |integer     |Projekt-ID eines EPS Projekts | +|projectId      |Ja       |integer     |Projekt-ID eines eps 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\\ Wenn kind = 2, dann als Betrag 0 angeben | +|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\\ EUR = Euro (default) | +|currency       |Ja       |String(3)   |Währung der Transaktion\\ EUR = Euro| 
-|purpose        |Ja       |String(27)  |Verwendungszweck der EPS Überweisung | +|purpose        |Ja       |String(27)  |Verwendungszweck der eps Überweisung | 
-|issuer         |Ja       |String      |EPS Issuer Bank | +|bic            |**deprecated** |String(11)  |**Dieser Parameter darf nicht mehr verwendet werden, alle eps-Transaktionen werden jetzt mit einer externen Bankenabfrage durchgeführt!** BIC der Käuferbank (8 oder 11-stellig)| 
-|urlRedirect    |Ja       |String      |URL, an die der Kunde nach der Zahlung geschickt werden soll. | +|urlRedirect    |Ja       |String(2048) |URL, an die der Kunde nach der Zahlung geschickt werden soll. | 
-|urlNotify      |Ja       |String      |URL, an die der Zahlungsausgang gemeldet werden soll. | +|urlNotify      |Ja       |String(2048) |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]] |+|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 134: Zeile 172:
  
 === Antwort === === Antwort ===
-Die Antwort enthält ein JSON Objekt. Das Feld rc liefert einen Fehlercode zurück. Wird rc = 0 zurückgeliefert, wurde die Transaktion erfolgreich initialisiert. Es wird als Antwort eine Transaktionsnummer und die redirectURL zum Online Banking des Käufers zurückgeliefert.+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. Es wird als Antwort eine Transaktionsnummer und die redirectURL zum Online Banking des Käufers zurückgeliefert.
  
 == Parameter == == Parameter ==
 ^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      |Ja       |String    |Eindeutige GiroCheckout Transaktions-ID | +|reference      |Optional |String(36) |eindeutige GiroCheckout Transaktions-ID | 
-|redirect       |Ja       |String    |Redirect URL zur Weiterleitung des Kunden |+|redirect       |Optional |String(2048) |Redirect URL zur Weiterleitung des Kunden an sein Online Banking|
 ^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 150: Zeile 188:
 == Beispiel im Fehlerfall == == Beispiel im Fehlerfall ==
 {{page>codesamples:eps#transactionstart.response.false&noheader&nofooter}} {{page>codesamples:eps#transactionstart.response.false&noheader&nofooter}}
- 
  
 ==== Benachrichtigung über den Zahlungsausgang ==== ==== Benachrichtigung über den Zahlungsausgang ====
  
-Der Ausgang einer EPS 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 der EPS Transaktion steht im Feld gcResultPayment. +Der Ausgang einer eps 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 der eps Transaktion steht im Feld gcResultPayment. 
 + 
 +Aufgrund des eps 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 EPS 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. 
  
 === Anfrage === === Anfrage ===
Zeile 164: Zeile 204:
  
 == 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(10)  | Zahlungsabwickler Transaktions-ID | 
-|gcAmount         |Ja       |Integer     | bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent | +|gcAmount         |Ja      |Integer     | bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent | 
-|gcCurrency       |Ja       |String      | Währung | +|gcCurrency       |Ja      |String(3)   | Währung | 
-|gcResultPayment  |Optional |Integer     | [[girocheckout:resultcodes#zahlungsausgang|Ergebniscodes der EPS Zahlung]]| +|gcResultPayment  |Ja      |Integer     | [[girocheckout:resultcodes#zahlungsausgang|Ergebniscodes der eps 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 182: Zeile 222:
  
 ==== Rückleitung des Kunden zum Händler ==== ==== Rückleitung des Kunden zum Händler ====
-Nach Beendigung der EPS 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 eps 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 === === Anfrage ===
Zeile 190: Zeile 230:
  
 == 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(10)  | Zahlungsabwickler Transaktions-ID | 
-|gcAmount         |Ja       |Integer     | bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent | +|gcAmount         |Ja      |Integer     | bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent | 
-|gcCurrency       |Ja       |String      | Währung | +|gcCurrency       |Ja      |String(3)   | Währung | 
-|gcResultPayment  |Optional |Integer     | [[girocheckout:resultcodes#zahlungsausgang|Ergebnis der EPS Zahlung]]| +|gcResultPayment  |Ja      |Integer     | [[girocheckout:resultcodes#zahlungsausgang|Ergebniscodes der eps 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]] | 
 + 
 +===== Senderinformationen abrufen ===== 
 +Mit dieser Funktion können die Senderinformationen einer erfolgreich durchgeführten Transaktion abgerufen werden. Anhand der angegebenen Referenz wird Kontoinhaber, IBAN und BIC des Absenders geliefert.  Diese Information kann dann für eine Rücküberweisung an den Zahler genutzt werden. 
 + 
 +=== API-Aufruf === 
 +**URL:** https://payment.girosolution.de/girocheckout/api/v2/eps/senderinfo \\ 
 +**Bereitzustellen von:** GiroCheckout \\ 
 +**Aufzurufen von:** Händler 
 + 
 +== POST-Parameter == 
 +^Name           ^Pflicht  ^Type      ^Beschreibung   ^ 
 +|merchantId     |Ja       |Integer   |Händler-ID eines eps Projekts | 
 +|projectId      |Ja       |Integer   |Projekt-ID eines eps Projekts | 
 +|reference      |Ja       |String(36)|GiroCheckout Transaktions-ID | 
 +|hash           |Ja       |String(32)|HMAC MD5 hash über alle Werte des Aufrufs (siehe [[girocheckout:general:start#hash_generieren|hash generieren]])| 
 + 
 +== Beispiel == 
 +{{page>codesamples:eps#senderinfo.request&noheader&nofooter}} 
 + 
 +=== Antwort === 
 +Die Antwort besteht aus einem JSON Objekt. Das Feld rc liefert einen Fehlercode. Wird **rc = 0** zurückgeliefert, enthalten die entsprechenden Felder die Senderinformationen. 
 + 
 +== JSON-Parameter == 
 +^Name           ^Pflicht  ^Type      ^Beschreibung   ^ 
 +|rc             |Ja       |Integer     |[[girocheckout:errorcodes|Fehlernummer]] | 
 +|msg            |Ja       |String(255) |zusätzliche Informationen im Fehlerfall | 
 +|accountholder  |Optional |String(255) |Inhaber des Absenderkontos| 
 +|iban           |Optional |String(34)  |IBAN des Absenderkontos | 
 +|bic            |Optional |String(11)  |BIC des Absenderkontos | 
 +^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:eps#senderinfo.response.true&noheader&nofooter}} 
 + 
 +== Beispiel im Fehlerfall == 
 +{{page>codesamples:eps#senderinfo.response.false&noheader&nofooter}}
  
girocheckout/eps/start.1405192126.txt.gz · Zuletzt geändert: 2021/04/12 14:30

Seiten-Werkzeuge