Girocheckout API

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Zuletzt angesehen: • Payment Page

Seitenleiste

Einführung

Integration

Grundlagen
FAQ

eps
giropay
iDEAL
Kreditkarte
Lastschrift
Bluecode
Maestro
Payment Page
PayPal

Tools

Fehlernummern
Ergebniscode
Testdaten

Erweiterungen

UATP
Vertriebspartner
Risikoprüfung
Formularservice

SDK

PHP SDK
Java SDK
.NET SDK

Andere

API Changelog
Plugins Changelog

Impressum
Datenschutz
S-Public Services GmbH

Übersetzungen dieser Seite:
girocheckout:paypage:start

Dies ist eine alte Version des Dokuments!

Inhaltsverzeichnis

Payment Page

In diesem Dokument werden alle Abläufe und Schnittstellen beschrieben, die zur Integration der GiroCheckout Payment Page notwendig sind.

Diese Payment Page ermöglicht eine viel einfachere Anbindung von Shops an GiroCheckout, ohne dass innerhalb des Shops alle Zahlungsarten einzeln konfiguriert werden müssen. Die GiroCheckout Payment Page bietet dem Endkunden alle beim Händler verfügbaren Zahlungsarten zur Auswahl an und initialisiert die entsprechende Zahlung nach Auswahl.

Beispiel

Beispiel Payment Page

Unterstützte Zahlungsarten

Es werden die folgenden Zahlarten unterstützt:

Zahlungsart Code
giropay 1
giropay-ID + giropay 17
giropay mit Zahlungsbestätigung 18
eps 2
iDEAL 12
Kreditkarte 11
Lastschrift 6
Lastschrift mit Sperrdatei 7
Bluecode 26
Maestro 33
PayPal 14
paydirekt 23
SOFORT-Überweisung 27

Initialisierung einer Zahlung über die Payment Page

Eine Payment Page muss initialisiert werden, damit eine Payment-Page-URL generiert wird. Diese Payment-Page-URL ist das Ergebnis einer erfolgreichen Payment-Page-Initialisierung. Der Endkunde muss anschließend auf diese URL weitergeleitet werden.

Bereitzustellen von: GiroCheckout
Aufzurufen von: Händler

Workflow

KundeShopGiroCheckoutPayment PageZahlungsabwickler1 2 3 4 5 6 7 8 9 10 11 12 13 (c)2017 by GiroSolution AG

  1. Käufer besucht Shop-Checkout um zu bezahlen
  2. Shop initialisiert Paypage-Transaktion (Initialisierung)
  3. GiroCheckout initialisiert Transaktion intern und liefert Paypage-URL zurück
  4. Shop leitet Kunden zur Paypage weiter, Kunde wählt Zahlungsart
  5. Paypage initialisiert Zahlung bei GiroCheckout
  6. GiroCheckout liefert URL des Zahlungsformulars an Paypage
  7. Paypage leitet Kunden auf Zahlungsformular beim Abwickler weiter, Kunde gibt Daten ein und bezahlt
  8. Zahlungsabwickler informiert GiroCheckout über Transaktionsausgang
  9. GiroCheckout benachrichtigt Shop über Transaktionsausgang (Benachrichtigung)
  10. Shop verarbeitet Transaktionsausgang
  11. Shop sendet HTTP Statuscode an GiroCheckout
  12. GiroCheckout leitet Käufer zurück auf den Shop
  13. Shop zeigt Kunde Ergebnis an

API-Funktionen

Projektabfrage

Sollte bei Ihnen der Bedarf bestehen, in Ihrer Payment- oder Spenden-Page nur bestimmte Projekte aus Ihrem GiroCockpit zu verwenden und dies in Ihrer Implementierung auswählen zu lassen, können Sie diese Abfrage verwenden, um sich Ihre Projekte zurückliefern zu lassen.

URL: https://payment.girosolution.de/girocheckout/api/v2/paypage/projects
Bereitzustellen von: GiroSolution AG
Aufzurufen von: Händler

POST Parameter
Name Pflicht Type Beschreibung
merchantId Ja Integer Händler-ID eines giropay Projekts
projectId Ja Integer Projekt-ID eines giropay Projekts
hash Ja String(32)HMAC MD5 hash über alle Werte des Aufrufs. Siehe hash generieren
Beispiel
curl -d "merchantId=1234567" \
     -d "projectId=1234" \
     -d "hash=9d7cc3729790bfdbe68a7156bb4d386b" \
     https://payment.girosolution.de/girocheckout/api/v2/paypage/projects

Antwort

Die Antwort enthält ein JSON Objekt. Wenn rc = 0 zurückgeliefert wird, enthält das Element projects die zur Verfügung stehenden Projekte.

Parameter
Name Pflicht Type Beschreibung
rc Ja Integer Fehlernummer
msg Ja String Zusätzliche Informationen im Fehlerfall
projects Optional Array Liste der GiroCockpit-Projekte bestehend aus der Id (id), dem Projektnamen (name), der Nummer der zugehörigen Zahlungsart (paymethod, s. Liste der Zahlungsarten) und dem Modus (mode) = TEST oder LIVE.
HEADER Parameter
hash Ja String HMAC MD5 hash über alle Werte der Rückmeldung. Siehe hash der Rückantwort
Beispiel
{"projects":[{"id":"12345","name":"iDEAL - ICEPAY","paymethod":"12","mode":"LIVE"},{"id":"12346","name":"giropay","paymethod":"1","mode":"TEST"},{"id":"12347","name":"Kreditkarte","paymethod":"11","mode":"TEST"}],"rc":0,"msg":""}

Initialisierung

POST Parameter

URL https://payment.girosolution.de/girocheckout/api/v2/paypage/init

Name Pflicht Type Beschreibung
merchantId Ja Integer Händler-ID eines Paypage-Projekts
projectId Ja Integer Projekt-ID eines Paypage-Projekts
merchantTxId Ja String(255) Eindeutige Transaktions-ID des Händlers
amount Optional Integer Bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny, also ohne Nachkommastellen. Dieser Parameter ist PFLICHT, außer es handelt sich um eine Spendenpage mit freier Betragseingabe oder mit mindestens einem fest vorgegebenen Betrag (also optional wenn pagetype == 2 und (freeamount=1 oder fixedvalues nicht leer)).
currency Ja String(3) Währung der Transaktion, gemäß ISO 4217.
EUR = Euro
purpose Ja String(27) Verwendungszweck der Transaktion. Diese Information erscheint auf der Kartenabrechnung bzw. dem Kontoauszug. Es sind nur SEPA-konforme Zeichen zulässig (s. SEPA-konforme Zeichen). Wenn pagetype=2 und projectlist nicht leer, kann der Platzhalter {SPENDENPROJEKT} verwendet werden, der dann mit dem Namen des vom Kunden gewählten Projekts gefüllt wird.
Der Inhalt dieses Feldes (erste 20 Zeichen) wird auch verwendet, um die orderid bei der Zahlungsart Paydirekt zu befüllen, wenn diese nicht explizit angegeben ist (s. Parameter orderid).
description Optional String(120) Beschreibung für die Bezahlung. Wird nur auf der Payment Page angezeigt. Zulässige Zeichen s. Zulässige Beschreibungszeichen
pagetype Optional Integer Typ der zu erzeugenden Bezahlseite: 0=normale API-Paypage (kompatibel zu früheren Paypages, Defaultwert), 1=Bezahlseite, 2=Spendenseite
expirydate Optional String(10) Verfallsdatum: Leer=Bezahlseite ist immer gültig, JJJJ-MM-TT=Datumsangabe im Format Jahr-Monat-Tag, bis zu diesem Datum ist die Bezahlseite gültig.
Funktioniert nur bei pagetype 1 oder 2.
Die Option 'once' ist deprecated, sollte also nicht mehr genutzt werden, weil sie in einer nächsten API-Version nicht mehr zur Verfügung stehen wird. Statt dessen, bitte single=2 verwenden.
single Optional Integer Steuert, ob und wie der Link wiederverwendet werden darf.
0 = Link is beliebig oft wiederholbar (default)
1 = Erlaubt nur einen einzigen Bezahlversuch für diesen Payment-Link, egal ob erfolgreich oder nicht
2 = Bezahlseite kann nur für eine erfolgreiche Bezahlung genutzt werden, danach ungültig.
timeout Optional Integer (Verfügbar ab API 2.1.33) Erlaubt die Angabe eines Timeouts für die Auswahl einer Zahlungsart auf der Payment Page. Der Timeout wird in Sekunden angegeben und wird aktiv, sobald die Seite angezeigt wird. Er wird dort angezeigt und bei Ablauf wird auf eine Fehlermeldung weitergeleitet. Neu Laden der Seite startet den Timeout NICHT neu, nur ein Löschen der Cookies hätte diesen Effekt. Wurde die Payment Page mit Parameter single=1 intialisiert, führt ein Ablauf des Timeouts dazu, dass der Link invalidiert wird. Für bestimmte Zahlungsarten (Lastschrift, Paypal, Kreditkarte) wird der Timeout ausgesetzt, sobald die Kachel der Zahlungsart aktiviert wird. Im Hintergrund läuft er aber weiter und greift wieder, sobald eine andere Zahlungsart gewählt wird. Für die genannten 3 Zahlungsarten gibt es separate Timeouts, die für jede Zahlungsart im GiroCockpit konfiguriert werden können (nur durch administrative Mitarbeiter der GS).
type Optional String(4) Transaktionsart (siehe Transaktionsarten), SALE = Verkauf wird sofort gebucht (default), AUTH = Reservierung des Betrags (nicht bei allen Zahlarten verfügbar)
locale Optional String(4) Sprache der Payment Page
de = deutsch (default)
en = englisch
paymethods Optional String Kommaseparierte Liste der Zahlarten, die angezeigt werden sollen. Wird hier nichts angegeben, werden alle beim Händler unterstützen Zahlarten zur Auswahl angeboten. Jede Zahlungsart ist als Zahl anzugeben, s. Zahlungsarten
payprojects Optional String Kommaseparierte Liste der Projekt-IDs, deren zugehörige Zahlungsarten in der Payment Page verfügbar sein sollen. Wird hier nichts angegeben, werden alle Projekte des Händlers berücksichtigt. Die Projekt-Ids können entweder manuell im GiroCockpit oder über Aufruf der Funktion Projektabfrage ermittelt werden.
organization Optional String(70)Name des Anbieters der Bezahl- oder Spendenseite. Wenn nicht angegeben, wird der Name aus dem GiroCockpit verwendet.
freeamount Optional Integer Gibt an, ob der Anwender einen freien Betrag eingeben darf (=1) oder nicht (=0, Defaultwert).
fixedvalues Optional String JSON-codierter String, der einen Array der zur Auswahl stehenden Beträge enthält. z.B. '[„10000“,„20000“,„50050“]', alle Beträge sind in Cent anzugeben. Ist dieses Feld leer, wird der Inhalt des Amount-Feldes als einziger fester Wert verwendet. Enthält dieses Feld Werte, wird der Betrag im Feld Amount ignoriert!
minamount Optional Integer Mindestwert, wenn ein freier Betrag eingegeben werden darf, also freeamount=1 ist. Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny, ohne Nachkommastellen. Fehlt dieser Wert, ist der Default 100, also z.B. 1,00 EUR.
maxamount Optional Integer Maximalwert, wenn ein freier Betrag eingegeben werden darf, also freeamount=1 ist. Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny, ohne Nachkommastellen.
orderid Optional String(20) Wird nur bei Zahlungsart Paydirekt verwendet, wenn leer wird die orderid aus dem Purpose erzeugt. Es sind nur SEPA-konforme Zeichen zulässig (s. SEPA-konforme Zeichen)
projectlist Optional String JSON-codierter String, der einen Array der Projekte enthält (Strings=Projektnamen), für die auf dieser Spendenseite gespendet werden kann. Macht nur Sinn, wenn pagetype=2.
Example: [„School in Namibia“,„Wildlife protection Southafrica“,„Childcare Honduras“]
pkn Optional String Das Feld dient dazu eine erneute Transaktion, ohne erneute Eingabe der Kreditkarten- oder Lastschriftdaten, zu starten.
create = neue Pseudo-Kartennummer für die verwendete Kreditkarte/Kontoverbindung generieren.
test Ja Integer 1 = Zahlarten im Test-Modus werden angezeigt
0 = Zahlarten im LIVE-Modus werden angezeigt
certdata Optional Integer 1 = Formular für Abfrage der Spendenbescheinigungsdaten anbieten
0 = Formular nicht anbieten (default)
otherpayments Optional String JSON-formatierter Array of objects, der es erlaubt, optional externe Zahlungsarten in der Payment Page zu integrieren. Ein Klick auf diese Zahlungsart innerhalb der Payment Page leitet dann direkt an den angegebenen Link weiter, anstatt wie bei den anderen Zahlungsarten intern über GiroCheckout verarbeitet zu werden. Aktuell sind hier nur Zahlungsarten erlaubt, die in der Liste der unterstützten Arten enthalten sind (s. Zahlungsarten).
Felder der Objekte:
id: Nummer der Zahlungsart lt. obiger Tabelle.
url: Link, zu dem nach Auswahl weitergeleitet werden soll. Dieser Link muss alles enthalten, was seitens des externen Anbieters (z.B. PayPal) notwendig ist, um die Zahlung zu verarbeiten, die Payment Page nimmt keine Ersetzung von Parametern o.ä. vor.
position: Position innerhalb der angebotenen Zahlungsarten (>=1)
Beispiel (PayPal und Kreditkarte):
[{"id":14, "url": "https://www.paypal.de/process/123456&param1=48399", "position":1}, {"id":11, "url":"https://www.visa.com/wasauchimmer", "position":2}]
paydirektShippingFirstName Optional String(100) Vorname für die Lieferadresse (nur für paydirekt PHYSICAL-Bestellungen)
paydirektShippingLastName Optional String(100) Nachname für die Lieferadresse (nur für paydirekt PHYSICAL-Bestellungen)
paydirektShippingZipCode Optional String(10) Postleitzahl für die Lieferadresse (nur für paydirekt PHYSICAL-Bestellungen)
paydirektShippingCity Optional String(100) Ort für die Lieferadresse (nur für paydirekt PHYSICAL-Bestellungen)
paydirektShippingCountry Optional String(2) Ländercode (ISO 2-stellig) für die Lieferadresse (nur für paydirekt PHYSICAL-Bestellungen)
successUrl Optional String URL, an die der Kunde nach erfolgreicher Zahlung weitergeleitet wird.
backUrl Optional String URL, an die der Kunde weitergeleitet wird, wenn er auf Zurück klickt.
failUrl Optional String URL, an die der Kunde nach erfolgloser Zahlung weitergeleitet wird.
notifyUrl Optional String URL, an die in einer Server-to-Server-Verbindung die Payment Notification geschickt wird.
tds2Address Optional String Für 3D Secure 2.0: Hauptadresszeile (i.d.R. Straße+Hausnummer) der Rechnungsadresse des Karteninhabers, Format A-Z, a-z, 0-9, Blank, [-/().,&'], max. 50. Wenn angegeben, müssen auch die restlichen tds2-Felder angegeben werden, außer tds2Optional.
tds2Postcode Optional String Für 3D Secure 2.0: Postleitzahl der Rechnungsadresse des Karteninhabers, Format A-Z, a-z, 0-9, Blank, [-], max. 11. Wenn angegeben, müssen auch die restlichen tds2-Felder angegeben werden, außer tds2Optional.
tds2City Optional String Für 3D Secure 2.0: Ort der Rechnungsadresse des Karteninhabers, Format A-Z, a-z, 0-9, Blank, [-/().,&'], max. 50. Wenn angegeben, müssen auch die restlichen tds2-Felder angegeben werden, außer tds2Optional.
tds2Country Optional String Für 3D Secure 2.0: Land der Rechnungsadresse des Karteninhabers, Format A-Z, max. 2. Zweibuchstabiges Länderkürzel nach dem aktuell gültigen Standard ISO 3166. Wenn angegeben, müssen auch die restlichen tds2-Felder angegeben werden, außer tds2Optional.
tds2Email Optional String Für 3D Secure 2.0: E-Mail-Adresse des Karteninhabers, Format A-Z, a-z, 0-9, [_.+-@], max. 254. Wenn angegeben, müssen auch die restlichen tds2-Felder angegeben werden, außer tds2Optional.
tds2Optional Optional String Für 3D Secure 2.0: JSON-String, der weitere optionale Felder enthält. Eine genaue Auflistung der Felder ist unter dieser Tabelle unter 3D Secure 2.0 Optionale Felder (tds2Optional) zu finden
hash Ja String HMAC MD5 hash über alle Werte des Aufrufs. Siehe hash generieren

SEPA-konforme Zeichen

In SEPA-Zahlungen sind gemäß Anlage 3 des DFÜ-Abkommens nur Zeichen des eingeschränkten SWIFT Latin Character Set zugelassen:

  • a b c d e f g h i j k l m n o p q r s t u v w x y z
  • A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
  • 0 1 2 3 4 5 6 7 8 9
  • ' : ? , - ( + . ) /

Zulässige Beschreibungszeichen

Folgende Zeichen sind für den Beschreibungstext (Feld description) zulässig:

  • Alle Buchstaben aller Sprachen, also auch Umlaute und spanische Sonderzeichen usw.
  • Alle Satzzeichen
  • Alle Ziffern
  • Symbole, die sich auf Währungen beziehen (also $ und € usw.)
  • Länge zwischen 1 und 60 Zeichen

3D Secure 2.0 Optionale Felder (tds2Optional)

Hierbei handelt es sich um ein JSON-formatiertes Objekt, das hierarchisch aufgebaut ist (2 Ebenen) und die folgenden Unterobjekte enthält:

  • billingAddress (Rechnungsadresse)
  • shippingddress (Lieferadresse)
  • homePhoneNumber (Telefon zuhause)
  • mobilePhoneNumber (Telefon mobil)
  • workPhoneNumber (Telefon Arbeit)
  • cardholderAccountInfo (Konteninformationen Karteninhaber)
  • tdsMerchantRiskIndicators (Risikoindikatoren des Händlers)
  • tdsRequestorAuthenticationInformation (Authentifizierungsinformationen des Anfragenden)
  • tdsTransactionAttributes (Transaktionsattribute)
  • tdsBrowserData (Browserdaten)
  • tdsCommunicationData (Kommunikationsdaten)

Insgesamt gibt es folgende Feldern (alle optional, Felder in Unterobjekten sind mit [Unterobjektname].[Feld] dargestellt):

Name Datentyp Beschreibung
addressesMatch Boolean Lieferadresse entspricht Rechnungsadresse, ja=„true“, nein=„false“, kein Unterobjekt sondern Feld direkt im Hauptobjekt.
billingAddress
billingAddress.line2 String Zeile 2 der Rechnungsadresse. Format A-Z, a-z, 0-9, Blank, [-/().,&'], max. 50
billingAddress.line3 String Zeile 3 der Rechnungsadresse. Format A-Z, a-z, 0-9, Blank, [-/().,&'], max. 50
billingAddress.state String Bundesland der Rechnungsadresse o.ä. Format A-Z, max. 3, Kürzel gemäß ISO 3166-2
shippingAddress
shippingAddress.line1 String Zeile 1 der Lieferadresse. Format A-Z, a-z, 0-9, Blank, [-/().,&'], max. 50
shippingAddress.line2 String Zeile 2 der Lieferadresse. Format A-Z, a-z, 0-9, Blank, [-/().,&'], max. 50
shippingAddress.line3 String Zeile 3 der Lieferadresse. Format A-Z, a-z, 0-9, Blank, [-/().,&'], max. 50
shippingAddress.postcode String Postleitzahl der Lieferadresse, Format A-Z, a-z, 0-9, Blank, [-], max. 11
shippingAddress.city String Ort der Lieferadresse, Format A-Z, a-z, 0-9, Blank, [-/().,&'], max. 50
shippingAddress.state String Bundesland der Lieferadresse o.ä. Format A-Z, max. 3, Kürzel gemäß ISO 3166-2
shippingAddress.country String Land der Lieferadresse, Format A-Z, max. 2. Zweibuchstabiges Länderkürzel nach dem aktuell gültigen Standard ISO 3166.
homePhoneNumber
homePhoneNumber.country Integer Ländervorwahl der Heim-Telefonnummer, Format 0-9, max. 3. z.B. 49 für Deutschland.
homePhoneNumber.regional String Rest der der Heim-Telefonnummer, Format 0-9, max. 15, ohne führende Nullen, z.B. 73482984938.
mobilePhoneNumber
mobilePhoneNumber.country Integer Ländervorwahl der Mobil-Telefonnummer, Format 0-9, max. 3. z.B. 49 für Deutschland.
mobilePhoneNumber.regional String Rest der der Mobil-Telefonnummer, Format 0-9, max. 15, ohne führende Nullen, z.B. 73482984938.
workPhoneNumber
workPhoneNumber.country Integer Ländervorwahl der Arbeits-Telefonnummer, Format 0-9, max. 3. z.B. 49 für Deutschland.
workPhoneNumber.regional String Rest der der Arbeits-Telefonnummer, Format 0-9, max. 15, ohne führende Nullen, z.B. 73482984938.
cardholderAccountInfo
cardholderAccountInfo.accountAgeIndicator String Alter des Kundenkontos. Mögliche Werte: „never“ - Kunde hat kein Kundenkonto, kauft z.B. als Gast ein, „now“ - Kunde hat während des aktuellen Einkaufs ein Konto angelegt, „less30“ - Konto ist weniger als 30 Tage alt, „more30less60“ - Konto ist mindestens 30 aber weniger als 60 Tage alt, „more60“ - Kundenkonto ist mindestens 60 Tage alt.
cardholderAccountInfo.passwordChangeIndicator String Gibt an, wann das Passwort des Kundenkontos zuletzt geändert oder zurückgesetzt wurde. Mögliche Werte: „never“ - Kunde hat nie sein Passwort geändert, „now“ - Kunde hat während des aktuellen Einkaufs sein Passwort geändert, „less30“ - Passwort wurde vor weniger als 30 Tagen geändert, „more30less60“ - Passwort wurde vor mindestens 30 aber weniger als 60 Tagen geändert, „more60“ - Passwort wurde seit mindestens 60 Tagen nicht geändert.
cardholderAccountInfo.paymentAccountAgeIndicator String Gibt an, wann das Zahlungskonto des Kunden angelegt wurde. Mögliche Werte: „never“ - Kunde hat kein Zahlungskonto, kauft z.B. als Gast ein, „now“ - Kunde hat das Zahlungskonto während des aktuellen Einkaufs angelegt, „less30“ - Zahlungskonto wurde vor weniger als 30 Tagen angelegt, „more30less60“ - Zahlungskonto wurde vor mindestens 30 aber weniger als 60 Tagen angelegt, „more60“ - Zahlungskonto wurde vor mindestens 60 Tagen angelegt.
cardholderAccountInfo.accountChange String Gibt an, wann das Kundenkonto im Shop zuletzt geändert wurde, z.B. Adressänderung oder neue Zahlungsdaten. Mögliche Werte: „now“ - Kunde hat während des aktuellen Einkaufs sein Konto geändert, „less30“ - Konto wurde vor weniger als 30 Tagen geändert, „more30less60“ - Konto wurde vor mindestens 30 aber weniger als 60 Tagen geändert, „more60“ - Kundenkonto wurde seit mindestens 60 Tagen nicht geändert.
cardholderAccountInfo.shippingAddressAgeIndicator String Gibt an, wann der Kunde die aktuelle Lieferadresse zum ersten Mal benutzt hat. Mögliche Werte: „now“ - Kunde benutzt die Lieferadresse zum ersten Mal, „less30“ - Lieferadresse wurde vor weniger als 30 Tagen zum ersten Mal benutzt, „more30less60“ - Lieferadresse wurde vor mindestens 30 aber weniger als 60 Tagen zuerst benutzt, „more60“ - Lieferadresse wurde vor mindestens 60 Tagen zuerst benutzt.
cardholderAccountInfo.shippingNameIndicator String Gibt an, ob der Name des Karteninhabers und der Name der Lieferadresse identisch sind. Mögliche Werte: „identical“ - Namen sind identisch, „different“ - Namen sind unterschiedlich.
cardholderAccountInfo.suspiciousAccountActivity Boolean Gibt an, ob für diesen Kunden verdächtige Aktivitäten beobachtet wurden. Mögliche Werte: „false“ - nein, „true“ - ja.
cardholderAccountInfo.provisioningDayCount Integer Anzahl der „Karte hinzufügen“ Versuche in den letzten 24 Stunden. Format 0-9, max. 3.
tdsMerchantRiskIndicators
tdsMerchantRiskIndicators.deliveryTimeframe String Zeitraum, in dem die Ware an den Kunden geliefert wird. Mögliche Werte: „electronic“ - sofortige elektronische Lieferung, „moreThanOneDay“ - mehr als ein Tag, „overnight“ - über Nacht, „sameDay“ - am selben Tag.
tdsMerchantRiskIndicators.deliveryEmailAddress String Liefer-E-Mail-Adresse des Kunden im Fall einer elektronischen Lieferung. Format A-Z, a-z, 0-9, [_.+-@], max. 254.
tdsMerchantRiskIndicators.giftCardAmount Integer Betrag der Geschenkkarte in größter Währungseinheit, z.B. 123 bei 123,45 EUR. Format 0-9, max. 10.
tdsMerchantRiskIndicators.giftCardCount Integer Anzahl der gekauften Geschenkkarten. Format 0-9, max. 2.
tdsMerchantRiskIndicators.giftCardCurrency Integer Währungscode der Geschenkkarte gemäß ISO 4217. Format A-Z, max. 3.
tdsMerchantRiskIndicators.preOrderDate Date Im Fall einer Vorbestellung: Datum, an dem die Ware voraussichtlich verfügbar ist. Format JJJJ-MM-TT.
tdsMerchantRiskIndicators.preOrderPurchaseIndicator String Mögliche Werte: „available“ - die Ware ist bereits verfügbar, „future“ - die Ware ist erst in der Zukunft verfügbar.
tdsMerchantRiskIndicators.reorderItemsIndicator String Gibt an, ob der Kunde Artikel bereits zuvor bestellt hat. Mögliche Werte: „first“ - erste Bestellung, „reordered“ - erneute Bestellung.
tdsMerchantRiskIndicators.shippingIndicator String Gibt an, wohin die Ware geliefert wird. Mögliche Werte: „digital“ - digitale Lieferung, „billingAddress“ - an die Rechnungsadresse, „differentAddress“ - an eine andere Adresse, „verifiedAddress“ - an eine geprüfte Adresse, „store“ - in ein Geschäft, „other“ - sonstiges.
tdsRequestorAuthenticationInformation
tdsRequestorAuthenticationInformation.authenticationData String Authentifizierungsdaten des Kunden. Format A-Z, a-z, 0-9 [!„#$%$'()*+,./:;⇔?@[\]^`{|}~-], max. 2048
tdsRequestorAuthenticationInformation.authenticationTimestamp DateTime Datum und Uhrzeit, wann sich der Kunde im Shop authentifiziert hat. Format JJJJ-MM-TTTHH:mm:ss
tdsRequestorAuthenticationInformation.authenticationMethod String Gibt an, wie sich der Kunde in Ihrem Shop authentifiziert hat. Mögliche Werte: „none“ - gar nicht, z.B. Kunde kauft als Gast ein, „ownCredentials“ - Kunde ist mit seinen Daten, z.B. Login-Name und Passwort angemeldet, „federatedId“ - föderierte Identität, „issuerCredentials“, „thirdParty“, „fido“, „fidoSigned“, „srcAssurance“.
tdsTransactionAttributes
tdsTransactionAttributes.purchaseInstalmentData Integer Maximal erlaubte Anzahl von Autorisierungen bei Ratenzahlungen. Format 0-9, max. 3, Wert muss > 1 sein.
tdsTransactionAttributes.recurringExpiry Date Datum, nach dem keine weiteren Autorisierungen mehr stattfinden sollen. Format JJJJ-MM-TT.
tdsTransactionAttributes.recurringFrequency Integer Minimale Anzahl von Tagen zwischen zwei Autorisierungen. Format 0-9, max. 4.
tdsTransactionAttributes.type String Art der 3-D Secure 2.0 Zahlung. Mögliche Werte: „purchase“ - Einkauf, „checkAcceptance“, „accountFunding“, „quasiCash“, „prepaidActivation“.
tdsBrowserData
tdsBrowserData.browserAcceptHeader String „Accept“ HTTP-Header des Browsers des Kunden. Format A-Z, a-z, 0-9, [/;=-], max. 80.
tdsBrowserData.browserColorDepth Integer Farbtiefe des Browsers des Kunden in Bit. Gültige Werte: 1, 4, 8, 15, 16, 24, 32, 48.
tdsBrowserData.browserIP String IP-Adresse (IPv4 oder IPv6) des Browsers des Kunden. Format A-Z, a-z, 0-9, [.:], max. 39.
tdsBrowserData.browserJavaEnabled Boolean Gibt an, ob im Browser des Kunden Java aktiv ist (true) oder nicht (false).
tdsBrowserData.browserJavaScriptEnabled Boolean Gibt an, ob im Browser des Kunden JavaScript aktiv ist (true) oder nicht (false).
tdsBrowserData.browserLanguage String Sprache des Browsers des Kunden. Format A-Z, a-z, [-], Max. 8., Bsp. en-US
tdsBrowserData.browserScreenHeight Integer Höhe des Bildschirms des Kunden in Pixeln. Format 0-9, Max. 6.
tdsBrowserData.browserScreenWidth Integer Breite des Bildschirms des Kunden in Pixeln. Format 0-9, Max. 6.
tdsBrowserData.browserTimeZone Integer Differenz in Minuten zwischen der Zeitzone des Kunden und UTC. Wird von der JavaScript-Methode getTimezoneOffset() zurückgegeben. Format 0-9, [-], Max. 5.
tdsBrowserData.browserUserAgent String „User-Agent“ HTTP-Header des Browsers des Kunden. Format A-Z, a-z, Blank, [().:;/,_-], Max. 2048.
tdsCommunicationData
tdsCommunicationData.cResNotificationURL String URL des Shops, an welche der ACS die CRes-Nachricht senden soll. Format A-Z, a-z, 0-9, [:./-?;&=%], Max. 2048.
tdsCommunicationData.methodNotificationURL String URL des Shops, an welche der ACS die Benachrichtigung über die „3DS Method“ senden soll. Format A-Z, a-z, 0-9, [:./-?;&=%], Max. 2048.
tdsCommunicationData.challengeWindowSize String Größe des Fensters, das dem Kunden zur Autorisierung einer 3-D Secure 2.0 Zahlung angezeigt werden soll. Falls nicht angegeben wird „FullScreen“ angenommen. Format: Einer der Werte „size250x400“, „size390x400“, „size500x600“, „size600x400“, „FullScreen“
Beispiel eines tds2Optional-Strings (zu Demonstrationszwecken formatiert, sollte normalerweise in einer Zeile angegeben werden)
{
  "addressesMatch": "false",
  "billingAddress": {
    "line2": "Beim Nachbarn klingeln",
    "line3": "zw. 22-24 Uhr",
    "state": "BW"
  },
  "shippingAddress": {
    "city": "Berlin",
    "country": "DE",
    "line1": "Unter den Linden 1",
    "line2": "Brandenburger Tor",
    "line3": "(linker Bogen)",
    "state": "BER"
  },
  "homePhoneNumber": {
    "country": "49",
    "regional": "75519209309"
  },
  "mobilePhoneNumber": {
    "country": "49",
    "regional": "17093902978"
  },
  "workPhoneNumber": {
    "country": "49",
    "regional": "8938928938"
  },
  "cardholderAccountInfo": {
    "accountAgeIndicator": "more30less60",
    "passwordChangeIndicator": "never",
    "paymentAccountAgeIndicator": "less30",
    "accountChange": "now",
    "shippingAddressAgeIndicator": "more60",
    "shippingNameIndicator": "different",
    "suspiciousAccountActivity": "false",
    "provisioningDayCount": 10
  },
  "tdsMerchantRiskIndicators": {
    "deliveryTimeframe": "overnight",
    "deliveryEmailAddress": "hans-mueller@example.com",
    "giftCardAmount": 0,
    "giftCardCount": 2,
    "giftCardCurrency": "EUR",
    "preOrderDate": "2020-12-20",
    "preOrderPurchaseIndicator": "available",
    "reorderItemsIndicator": "first",
    "shippingIndicator": "store"
  },
  "tdsRequestorAuthenticationInformation": {
    "authenticationData": "123Hdajkd/dasjdkk",
    "authenticationTimestamp": "2020-11-09T12:09:09",
    "authenticationMethod": "ownCredentials"
  },
  "tdsTransactionAttributes": {
    "purchaseInstalmentData": 2,
    "recurringExpiry": "2020-11-30",
    "recurringFrequency": 1234,
    "type": "quasiCash"
  },
  "tdsBrowserData": {
    "browserAcceptHeader": "anything",
    "browserColorDepth": 24,
    "browserIP": "192.168.0.43",
    "browserJavaEnabled": "true",
    "browserJavaScriptEnabled": "true",
    "browserLanguage": "en-US",
    "browserScreenHeight": 2048,
    "browserScreenWidth": 4096,
    "browserTimeZone": "120",
    "browserUserAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0"
  },
  "tdsCommunicationData": {
    "cResNotificationURL": "https://www.example.com/resnot.php?param1=value1¶m2=value2",
    "methodNotificationURL": "https://www.example.com/methnot.php?param1=value1¶m2=value2",
    "challengeWindowSize": "FullScreen"
  }
}
Beispiel
curl -d "merchantId=1234567" \
     -d "projectId=1234" \
     -d "merchantTxId=1234567890" \
     -d "amount=100" \
     -d "currency=EUR" \
     -d "purpose=Beispieltransaktion" \
     -d "description=Fahrradleuchte klein" \
     -d "type=SALE" \
     -d "locale=de" \
     -d "paymethods=1,2,6,11,14" \
     -d "test=1" \
     -d "successUrl=http://www.my-domain.de/girocheckout/success" \
     -d "backUrl=http://www.my-domain.de/girocheckout/back" \
     -d "failUrl=http://www.my-domain.de/girocheckout/fail" \
     -d "notifyUrl=http://www.my-domain.de/girocheckout/notify" \
     -d "hash=9d7cc3729790bfdbe68a7156bb4d386b" \
     https://payment.girosolution.de/girocheckout/api/v2/paypage/init

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 Referenznummer für die Payment Page und die redirectURL zum Formular zurück.

Parameter
Name Pflicht Type Beschreibung
rc Ja Integer Fehlernummer
msg Ja String zusätzliche Informationen im Fehlerfall
reference Optional String eindeutige Payment Page ID
url Optional String URL zur Payment Page, an die der Kunde weitergeleitet werden muss.
HEADER Parameter
hash Ja String HMAC MD5 hash über alle Werte der Rückmeldung. Siehe hash der Rückantwort
Beispiel im Erfolgsfall

hash : 6c4da0504e8e6a359c7f2df86cb5318d 

{"reference":"4f88b6c8-6209-4c96-a450-b6de22633f6b","url":"http:\/\/pay.girosolution.de\/v1\/paypage\/en\/EG-ddvXSrAHmXRClBeamKGAyzXU-uAYbNYFLQ3uz_zj_J4rYCb0GIrWIQ-H_g8h3_-yf3WvSenh2Dg6TLhmTAA","rc":0,"msg":""}
Beispiel im Fehlerfall

hash : f55ce87e132ebb7eb20004c6b186ce09 

{"reference":null,"redirect":null,"rc":5030,"msg":"Betrag ungültig"}

Benachrichtigung über den Transaktionsausgang

Der Ausgang einer Transaktion wird auf 2 parallelen Wegen übermittelt. Der Notification und dem Redirect.

Notification

Der erste Kommunikationsweg ist eine Host-to-Host-Meldung an die im notifyUrl-Parameter angegebene URL. Diese Rückmeldung dient dazu, dem Händler den Ausgang der Transaktion mitzuteilen, auch wenn der Käufer nicht mehr auf die Shopseite zurückkehrt. Durch diese Information kann der Transaktionsstatus beim Händler geändert werden. Der Zahlungsausgang einer Transaktion steht im Feld gcResultPayment.

Anfrage

URL: notifyUrl aus der Payment-Page-Initialisierung
Bereitzustellen von: Händler
Aufzurufen von: GiroCheckout
Methode: GET

Name Pflicht Typ Beschreibung
gcPaymethod Ja Integer ID der Zahlungsart der Transaktion
gcType Ja String Transaktionsart:
SALE
AUTH
gcProjectId Ja String GiroCheckout Projekt-Id, über die die Transaktion abgewickelt wurde.
gcReference Ja String GiroCheckout Transaktions-ID
gcMerchantTxId Ja String Händler Transaktions-ID
gcBackendTxId Ja String Zahlungsabwickler Transaktions-ID
gcAmount Ja Integer bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny
gcCurrency Ja String Währung
gcResultPayment Ja Integer Ergebniscodes der Zahlung
gcPkn Optional String Pseudokartennummer, wenn pkn aktiv
gcCardnumber Optional String Maskierte Kreditkartennummer, wenn pkn aktiv
gcCardExpDate Optional String Gültigkeitsdatum der Kreditkarte im Format Monat/Jahr, wenn pkn aktiv
gcAccountHolder Optional String Kontoinhaber bei Lastschrift, wenn pkn aktiv
gcIban Optional String IBAN bei Lastschrift, wenn pkn aktiv
gcHash Ja String HMAC MD5 hash über alle Werte des Aufrufs. Siehe hash generieren

Redirect

Der zweite Kommunikationsweg ist die Rückleitung des Käufers in seinem Browser auf eine der drei bei der Initialisierung angegebenen Weiterleitungsadressen:

  • successUrl: Hierher wird weitergeleitet, wenn die Zahlung erfolgreich war.
  • failUrl: Hierher wird weitergeleitet, wenn die Zahlung nicht erfolgreich war oder auf der Seite des Zahlungsanbieters (Bank, Kreditkartenbetreiber usw.) abgebrochen wurde.
  • backUrl: Hierher wird weitergeleitet, wenn der Käufer auf der Payment Page beschließt, den Vorgang abzubrechen und auf den Zurück-Button klickt (nicht zu verwechseln mit dem Abbruch der Zahlung im entsprechenden Zahlungsformular NACH Auswahl der Zahlart, denn dieser Abbruch entspricht dann einem Transaktionsabbruch, der an die failUrl weitergeleitet wird).

Die success- und failUrl werden mit der POST-Methode aufgerufen und erhalten die selben Parameter wie oben beim Notify angegeben. Bei der backUrl wurde ja noch keine Zahlungsart ausgewählt und auch keine Transaktion initialisiert, somit wird hier lediglich ein Browser-Redirect ohne weitere Parameter durchgeführt.

girocheckout/paypage/start.1607965570.txt.gz · Zuletzt geändert: 2021/04/12 14:30

Seiten-Werkzeuge