Girocheckout API

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Zuletzt angesehen:
girocheckout:bluecode: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
Letzte Überarbeitung Beide Seiten der Revision
girocheckout:bluecode:start [2019/06/11 18:39]
michaelheumann 		girocheckout:bluecode:start [2023/03/24 20:37]
michaelheumann
Zeile 1: Zeile 1:
-====== Blue Code ======+====== Bluecode ======
  
-Informationen zu Blue Code sind unter https://www.bluecode.com/ zu finden.+Informationen zu Bluecode sind unter https://www.bluecode.com/ zu finden.
  
 ===== Testdaten ===== ===== Testdaten =====
Zeile 18: Zeile 18:
 </uml> </uml>
  
-===== Initialisierung einer Blue Code Zahlung =====+===== Initialisierung einer Bluecode 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. 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.
  
Zeile 32: Zeile 32:
 participant "Shop" as shop participant "Shop" as shop
 participant "GiroCheckout" as girocheckout participant "GiroCheckout" as girocheckout
-participant "Blue Code" as bc+participant "Bluecode" as bc
  
 autonumber autonumber
Zeile 54: Zeile 54:
 </uml> </uml>
  
-  - Käufer wählt Zahlart Blue Code aus +  - Käufer wählt Zahlart Bluecode aus 
-  - Shop initiiert Blue Code Transaktion ([[girocheckout:bluecode:start#initialisierung_einer_Blue_Code_Zahlung|Initialisierung]])+  - Shop initiiert Bluecode Transaktion ([[girocheckout:bluecode:start#initialisierung_einer_Bluecode_Zahlung|Initialisierung]])
   - Shop bekommt Rückmeldung über Initialisierungsausgang (bei Fehler ist Transaktion beendet) und sendet Redirect URL an Kundenbrowser    - Shop bekommt Rückmeldung über Initialisierungsausgang (bei Fehler ist Transaktion beendet) und sendet Redirect URL an Kundenbrowser 
-  - Kundenbrowser leitet zur Bezahlseite für Blue Code weiter, wo ein QR-Code angezeigt wird +  - Kundenbrowser leitet zur Bezahlseite für Bluecode weiter, wo ein QR-Code angezeigt wird 
-  - Kunde scannt mit dem Smartphone (Blue Code App) QR-Code ab +  - Kunde scannt mit dem Smartphone (Bluecode App) QR-Code ab 
-  - Blue Code sendet Mittelung an Smartphone des Kunden und wartet auf Bestätigung+  - Bluecode sendet Mittelung an Smartphone des Kunden und wartet auf Bestätigung
   - Kunde autorisiert auf dem Smartphone die Transaktion   - Kunde autorisiert auf dem Smartphone die Transaktion
-  - Blue Code führt Transaktion durch+  - Bluecode führt Transaktion durch
   - Kunde klickt "Zurück zum Shop" ([[girocheckout:bluecode:start#rueckleitung_des_kunden_zum_haendler|Rücksprung]])   - Kunde klickt "Zurück zum Shop" ([[girocheckout:bluecode:start#rueckleitung_des_kunden_zum_haendler|Rücksprung]])
-  - Blue Code übermittelt Ergebnis an GiroCheckout+  - Bluecode übermittelt Ergebnis an GiroCheckout
   - GiroCheckout benachrichtigt Shop über Transaktionsausgang ([[girocheckout:bluecode:start#benachrichtigung_ueber_den_zahlungsausgang|Benachrichtigung]])   - GiroCheckout benachrichtigt Shop über Transaktionsausgang ([[girocheckout:bluecode:start#benachrichtigung_ueber_den_zahlungsausgang|Benachrichtigung]])
   - Shop verarbeitet Transaktionsausgang   - Shop verarbeitet Transaktionsausgang
Zeile 83: Zeile 83:
  
 ^Name           ^Pflicht  ^Type        ^Beschreibung   ^ ^Name           ^Pflicht  ^Type        ^Beschreibung   ^
-|merchantId     |Ja       |Integer     |Händler-ID eines Blue Code-Projekts | +|merchantId     |Ja       |Integer     |Händler-ID eines Bluecode-Projekts | 
-|projectId      |Ja       |Integer     |Projekt-ID eines Blue Code-Projekts | +|projectId      |Ja       |Integer     |Projekt-ID eines Bluecode-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 |
Zeile 91: Zeile 91:
 |urlRedirect    |Ja       |String      |URL, an die der Kunde nach der Zahlung weitergeleitet werden soll. | |urlRedirect    |Ja       |String      |URL, an die der Kunde nach der Zahlung weitergeleitet werden soll. |
 |urlNotify      |Ja       |String      |URL, an die der Zahlungsausgang gemeldet werden soll. | |urlNotify      |Ja       |String      |URL, an die der Zahlungsausgang gemeldet werden soll. |
 +|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      |HMAC MD5 Hash über alle Werte des Aufrufs. Siehe  [[girocheckout:general:start#hash_generieren|hash generieren]] | |hash           |Ja       |String      |HMAC MD5 Hash über alle Werte des Aufrufs. Siehe  [[girocheckout:general:start#hash_generieren|hash generieren]] |
  
Zeile 97: Zeile 98:
  
 ==== Antwort ==== ==== 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 zur Blue Code-Bezahlseite zurück.+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 zur Bluecode-Bezahlseite zurück.
  
 === Parameter === === Parameter ===
Zeile 104: Zeile 105:
 |msg            |Ja       |String    |zusätzliche Informationen im Fehlerfall | |msg            |Ja       |String    |zusätzliche Informationen im Fehlerfall |
 |reference      |Optional |String    |eindeutige GiroCheckout Transaktions-ID | |reference      |Optional |String    |eindeutige GiroCheckout Transaktions-ID |
-|redirect       |Optional |String    |Redirect URL zur Weiterleitung des Kunden auf die Blue Code-Bezahlseite|+|redirect       |Optional |String    |Redirect URL zur Weiterleitung des Kunden auf die Bluecode-Bezahlseite|
 ^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    |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]] |
Zeile 176: Zeile 177:
 |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 |
girocheckout/bluecode/start.txt · Zuletzt geändert: 2023/05/08 02:01

Seiten-Werkzeuge