Girocheckout API

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Zuletzt angesehen:
girocheckout:ideal: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:ideal:start [2017/01/05 18:09]
michaelheumann 		girocheckout:ideal:start [2023/05/07 08:01] (aktuell)
michaelheumann
Zeile 1: Zeile 1:
 ~~NOCACHE~~ ~~NOCACHE~~
 ====== iDEAL ====== ====== iDEAL ======
- 
-Informationen zu iDEAL sind unter https://www.girosolution.de/girocheckout/fuer-haendler/ zu finden. 
  
 ===== Testdaten ===== ===== Testdaten =====
Zeile 99: Zeile 97:
 ^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 iDEAL issuer Banken | |issuer         |Optional |Array     |Liste der iDEAL issuer Banken |
 ^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 122: Zeile 120:
 |merchantId     |Ja       |Integer     |Händler-ID eines iDEAL Projekts | |merchantId     |Ja       |Integer     |Händler-ID eines iDEAL Projekts |
 |projectId      |Ja       |integer     |Projekt-ID eines iDEAL Projekts | |projectId      |Ja       |integer     |Projekt-ID eines iDEAL 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     |Betrag in Cent\\ Wenn kind = 2, dann als Betrag 0 angeben |
 |currency       |Ja       |String(3)   |Währung der Transaktion\\ EUR = Euro (default) | |currency       |Ja       |String(3)   |Währung der Transaktion\\ EUR = Euro (default) |
 |purpose        |Ja       |String(27)  |Verwendungszweck der iDEAL Überweisung | |purpose        |Ja       |String(27)  |Verwendungszweck der iDEAL Überweisung |
-|issuer         |Ja       |String      |iDEAL Issuer Bank | +|issuer         |Optional       |String(20) |iDEAL Issuer Bank. Wenn nicht angegeben, wird zu einer Bankauswahlseite weitergeleitet. | 
-|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 140: Zeile 140:
 ^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      |Ja       |String(36)  |Eindeutige GiroCheckout Transaktions-ID | 
-|redirect       |Ja       |String    |Redirect URL zur Weiterleitung des Kunden zum Online Banking|+|redirect       |Ja       |String(2048)|Redirect URL zur Weiterleitung des Kunden zum 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 151: Zeile 151:
 == Beispiel im Fehlerfall == == Beispiel im Fehlerfall ==
 {{page>codesamples:ideal#transactionstart.response.false&noheader&nofooter}} {{page>codesamples:ideal#transactionstart.response.false&noheader&nofooter}}
- 
  
 ==== Benachrichtigung über den Zahlungsausgang ==== ==== Benachrichtigung über den Zahlungsausgang ====
Zeile 166: Zeile 165:
 == 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(8)    | 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  |Ja       |Integer     | [[girocheckout:resultcodes#zahlungsausgang|Ergebniscodes der iDEAL Zahlung]]| |gcResultPayment  |Ja       |Integer     | [[girocheckout:resultcodes#zahlungsausgang|Ergebniscodes der iDEAL 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 192: Zeile 191:
 == 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(8)   | 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  |Ja       |Integer     | [[girocheckout:resultcodes#zahlungsausgang|Ergebnis der iDEAL Zahlung]]| |gcResultPayment  |Ja       |Integer     | [[girocheckout:resultcodes#zahlungsausgang|Ergebnis der iDEAL 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 ===== ===== Weitere Transaktionsarten =====
Zeile 240: Zeile 239:
 |merchantId     |Ja       |Integer     |Händler-ID eines Kreditkarten Projekts | |merchantId     |Ja       |Integer     |Händler-ID eines Kreditkarten Projekts |
 |projectId      |Ja       |Integer     |Projekt-ID eines Kreditkarten Projekts | |projectId      |Ja       |Integer     |Projekt-ID eines Kreditkarten 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     |Bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny | |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 | |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 | +|reference      |Ja       |String(36)  |GiroCheckout Transaktions-ID, für die eine Buchung oder Erstattung durchgeführt werden soll | 
-|hash           |Ja       |String      |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]] |
  
 == Beispiel == == Beispiel ==
Zeile 254: Zeile 253:
 === Parameter === === Parameter ===
 ^Name             ^Pflicht  ^Type        ^Beschreibung   ^ ^Name             ^Pflicht  ^Type        ^Beschreibung   ^
-|reference      |Ja       |String      | GiroCheckout Transaktions-ID | +|reference      |Ja       |String(36)  | GiroCheckout Transaktions-ID | 
-|merchantTxId   |Ja       |String      | Händler Transaktions-ID | +|merchantTxId   |Ja       |String(255) | Händler Transaktions-ID | 
-|backendTxId    |Ja       |String      | Zahlungsabwickler Transaktions-ID |+|backendTxId    |Ja       |String(8)   | Zahlungsabwickler Transaktions-ID |
 |amount         |Ja       |Integer     | bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny | |amount         |Ja       |Integer     | bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny |
-|currency       |Ja       |String      | Währung |+|currency       |Ja       |String(3)   | Währung |
 |resultPayment  |Ja       |Integer     | [[girocheckout:resultcodes#zahlungsausgang|Ergebnis der Transaktion]]| |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]] |+|hash           |Ja       |String(32)  | HMAC MD5 hash über alle Werte des Aufrufs. Siehe  [[girocheckout:general:start#hash_generieren|hash generieren]] |
  
 == Beispiel im Erfolgsfall == == Beispiel im Erfolgsfall ==
Zeile 268: Zeile 267:
 {{page>codesamples:ideal#refund.response.false&noheader&nofooter}} {{page>codesamples:ideal#refund.response.false&noheader&nofooter}}
  
 +===== 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/ideal/senderinfo \\
 +**Bereitzustellen von:** GiroCheckout \\
 +**Aufzurufen von:** Händler
 +
 +== POST-Parameter ==
 +^Name           ^Pflicht  ^Type      ^Beschreibung   ^
 +|merchantId     |Ja       |Integer   |Händler-ID eines iDEAL Projekts |
 +|projectId      |Ja       |Integer   |Projekt-ID eines iDEAL 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:ideal#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(36)  |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:ideal#senderinfo.response.true&noheader&nofooter}}
 +
 +== Beispiel im Fehlerfall ==
 +{{page>codesamples:ideal#senderinfo.response.false&noheader&nofooter}}
  
girocheckout/ideal/start.txt · Zuletzt geändert: 2023/05/07 08:01

Seiten-Werkzeuge