Plugin-Dokumentation - GiroSolution: ePayment-Plugin

Page / - zuletzt bearbeitet von rth am 24.03.2020, 14:59

GiroSolution: ePayment-Plugin

zuletzt bearbeitet von rth

am 24.03.2020, 14:59

Inhaltsverzeichnis

Aktions-Plugin GiroSolution: Paypage: Initialisierung

Transaktionsdaten

Zielstatus

Übersteuerung globaler Einstellungen

Allgemeine Rückgabeparameter

Notification-Parameter

Globale Plugin-Einstellungen

Konfiguration der Plugin-Bundle Properties

Plugin-Download (erfordert Anmeldung)

Inhalt [ Verbergen ]

Aktions-Plugin GiroSolution: Paypage: Initialisierung

Transaktionsdaten

Zielstatus

Übersteuerung globaler Einstellungen

Allgemeine Rückgabeparameter

Notification-Parameter

Globale Plugin-Einstellungen

Konfiguration der Plugin-Bundle Properties

Das kostenpflichtige GiroSolution ePayment Plugin ermöglicht es, über die von GiroSolution bereitgestellte PayPage, einen Bezahlvorgang innerhalb eines Formularprozesses einzubauen.

Für die Nutzung des Plugins ist es im Vorfeld notwendig, dass ein Vertrag mit der Firma GiroSolution über zur Nutzung der Service-Schnittstelle abgeschlossen wird.

Aktions-Plugin GiroSolution: Paypage: Initialisierung

Mit der Einbindung des Aktions-Plugin GiroSolution: Paypage: Initialisierung ist es möglich ein Bezahl-Transaktion innerhalb der Xima® Formcycle Statusverarbeitung auszuführen. Nachfolgend werden die dafür notwendigen Konfigurations-Parameter näher beschrieben.

Transaktionsdaten

Konfiguration der Transaktionsdaten

Automatisch zur Paypage witerleiten

Diese Einstellung ist standardmäßig aktiviert. Dadurch wird nach dem Initialisieren der Bezahl-Transaktion automatisch auf die Payment-Page von GiroSolution weitergeleitet. Wenn dies nicht gewünscht ist, kann durch Deaktivierung dieser Einstellung eine Weiterleitung unterbunden werden.

Hinweis:

Wenn eine Transaktion auf Seiten von GiroSolution erfolgreich erzeugt wurde, wird die URL zur Paypage als Plugin-Rückgabe-Parameter zurückgeliefert. Diese kann dann zu einem späteren Zeitpunkt aufgerufen werden.

Betrag

Hier ist der zu bezahlende Betrag in der kleinsten Währungseinheit (z.B.: Cent, Penny) anzugeben. Es werden Platzhalter unterstützt.

Hinweis:

Wenn die Werte direkt aus dem Formular kommen, beachten Sie, dass diese durch den Nutzer manipuliert sein könnten. Es empfiehlt sich deshalb an dieser Stelle mit festen Werten zur arbeiten oder die Zahlbeträge serverseitig zu berechnen.

Verwendungszweck

Verwendungszweck der Transaktion, welcher später auf der Kartenabrechnung bzw. dem Kontoauszug erscheint. Es werden Platzhalter unterstützt. Maximal sind 20 (SEPA-konforme) Zeichen erlaubt:

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

Zahlen von 0 – 9

Sonderzeichen: ' : ? , - ( + . ) / |

Beschreibung für Bezahlung

Definiert die Beschreibung zum Zahlbetrag, welcher auf der Bezahlseite von GiroSolution angezeigt wird. Es werden Platzhalter unterstützt. Maximal sind 60 Zeichen zulässig. Unterstützt werden Buchstaben aller Sprachen, also beispielsweise auch Umlaute und spanische Sonderzeichen usw., Satzzeichen, Ziffern und Symbole, die sich auf Währungen beziehen (also $ und € etc.).

Zielstatus

Konfiguration des Zielstatus nach Rückkehr von der Bezahlseite in Xima® Formcycle

In diesem Bereich können Status festgelegt werden, in welchen der Vorgang versetzt wird, wenn Xima® Formcycle eine Rückmeldung von GiroSolution erhält:

Zielstatus für Payment Server Rückmeldung

Hier kann ein Status definiert werden, in dem gewechselt wird, wenn die Transaktions-Benachrichtigung bei einer Server-To-Server-Verbindung zurückgemeldet wird. In der jeweiligen Status-Verarbeitung stehen dann die unter Notification-Parameter aufgeführten Parameter zur Verfügung.

Zielstatus für erfolgreiche Zahlung

Hier kann ein Status festgelegt werden, in welchen gewechselt wird, wenn der Kunde die Zahlung erfolgreich abgeschlossen hat. In der jeweiligen Status-Verarbeitung stehen dann die unter Notification-Parameter aufgeführten Parameter zur Verfügung.

Zielstatus für abgebrochenen Zahlvorgang

Hier kann ein Status festgelegt werden, in welchen gewechselt wird, wenn der Kunde innerhalb der GiroSolution Bezahlseite auf "Zurück" klickt und damit den Bezahlvorgang abbricht.

Zielstatus für erfolglose Zahlung

Hier kann ein Status festgelegt werden, in welchen gewechselt wird, wenn der Bezahlvorgang erfolglos beendet wurde.

Nach dem Durchlaufen der jeweiligen Statusverarbeitung erfolgt standardmäßig eine Weiterleitung ins Formular.
Wenn in der Statusverarbeitung eine Aktion vom Typ "Abschlussseite (Template)" definiert ist, erfolgt die Weiterleitung zu dieser Abschluss-Seite anstatt ins Formular.

Übersteuerung globaler Einstellungen

Globale Einstellungen übersteuern

In diesem Bereich können die unter Globale Einstellungen für Anbindung einer Paypage getroffenen Einstellungen übersteuert werden.

Händler-ID

Händler-ID aus einem GiroSolution Payment Page Projekt.

Projekt-ID

Projekt-ID aus einem GiroSolution Payment Page Projekt.

Projekt-Passwort

Projekt-Passwort aus einem GiroSolution Payment Page Projekt.

Währung

Währung mit der alle Payment Page Transaktionen ablaufen. Angabe muss im ISO 4217 Format erfolgen.

Sprache

Sprache auf der Payment Page, mögliche Werte:

de: Anzeige in deutscher Sprache

en: Anzeige in englischer Sprache

Anbietername

Name des Anbieters auf der Bezahlseite. Wenn nichts festgelegt ist, wird der im GiroSolution GiroCockpit festgelegte Wert verwendet.

Test-Modus?

Legt fest, in welchem Modus die Zahlarten auf den Payment Page anzuzeigen sind. Wenn aktiviert ist der Test-Betrieb aktiv, sonst der Live-Betrieb.

Allgemeine Rückgabeparameter

Allgemeine Rückgabeparameter

In diesem Bereich werden die vom Plugin als Ergebnis zurückgelieferten Parameter aufgeführt. Für die einzelnen Parameter kann ein Alias vergeben werden. In weiteren Aktionen kann auf den entsprechenden Rückgabeparameter per Platzhalter-Syntax zugegriffen werden. Der Platzhalter wird dabei nach dem folgenden Muster gebildet:

[%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%]

Über den Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert
und an anderer Stelle, zum Beispiel im Text einer E-Mail-Aktion, mittels Ctrl+C eingefügt werden.

ResultCode

Enthält einen Zahlenwert, welcher den Abarbeitungs- bzw. Fehlerstatus des Plugins widergibt.

ResultMessage

Enthält eine Klartextmeldung, welche den zurückgelieferten ResultCode näher erläutert.

ResultMerchantTxID

Enthält die erzeugte Transaktions-ID enthält. Dieser Rückgabewert ist nur vorhanden, wenn auf Seiten von GiroSolution eine Transaktion erfolgreich erzeugt werden konnte.

ResultPaypageUrl

Enthält die Redirect-URL zur Payment-Page von GiroSolution. Dieser Rückgabewert ist nur vorhanden, wenn auf Seiten von GiroSolution eine Transaktion erfolgreich erzeugt werden konnte.

ResultPaypageReferenceID

Enthält die Referenznummer für die Payment Page. Dieser Rückgabewert ist nur vorhanden, wenn auf Seiten von GiroSolution eine Transaktion erfolgreich erzeugt werden konnte.

Notification-Parameter

Die nachfolgende Tabelle listet die garantierten bzw. optionalen Parameter auf, welche von der GiroSolution-Schnittstelle zurück übermittelt werden und damit den Status der Bezahl-Transaktion kennzeichnen.
Die Parameter stehen in den konfigurierten Zielstatus für Payment Page Rückmeldungen zur Verfügung und können über die Platzhalternotation [%<Parametername>%] angesprochen werden.

Parametername	Optional	Bedeutung
gcAccountHolder	ja	Kontoinhaber bei Lastschriftverfahren
gcAmount	nein	Rechnungsbetrag, bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny
gcBackendTxId	nein	Zahlungsabwickler Transaktions-ID
gcCardExpDate	ja	Gültigkeitsdatum der Kreditkarte im Format Monat/Jahr, wenn Kreditkartenzahlung
gcCardnumber	ja	Maskierte Kreditkartennummer
gcCurrency	nein	Die in der Transaktion verwendete Währung
gcHash	nein	HMAC MD5 Hash über alle Werte des Aufrufs
gcIban	ja	IBAN bei Lastschrift
gcMerchantTxId	nein	Verkäufer Transaktions-ID
gcPaymethod	nein	ID der Zahlungsart der Transaktion, mögliche Werte: 1: giropay 2: eps 6: Lastschrift 7: Lastschrift mit Sperrdatei 8: Garantierte Lastschrift 11: Kreditkarte 12: iDEAL 14: PayPal 23: paydirekt 27: Sofort
gcPkn	ja	Pseudokartennummer
gcProjectId	nein	GiroCheckout Projekt-ID, über die die Transaktion abgewickelt wurde.
gcReference	nein	GiroCheckout Transaktions-ID
gcResultPayment	nein	Ergebniscodes der Zahlung, mögliche Werte: 4000: Transaktion erfolgreich 4001: giropay Bank offline 4002: Online Banking Zugang ungültig 4051: Kontoverbindung ungültig 4101: Ausgabeland der Karte nicht gültig oder unbekannt 4102: 3D-Secure Autorisierung fehlgeschlagen 4103: Gültigkeitsdatum der Karte überschritten 4104: Kreditkartentyp ungültig oder unbekannt 4105: Karte eingeschränkt nutzbar 4106: Pseudo-Kartennummer ungültig 4107: Karte gestohlen, verdächtig oder zum Einziehen markiert 4108: Telefonische Genehmigung 4151: PayPal Token ungültig 4152: Nachbearbeitung bei PayPal notwendig 4153: Zahlungsmethode bei PayPal ändern 4154: PayPal-Zahlung nicht abgeschlossen 4500: Zahlungsausgang unbekannt 4501: Timeout / Keine Benutzereingabe 4502: Abbruch durch Benutzer 4503: Doppelte Transaktion 4504: Manipulationsverdacht oder Zahlungsmittel temporär gesperrt 4505: Zahlungsmittel gesperrt oder abgelehnt 4506: Blue Code Barcode ungültig 4900: Transaktion nicht erfolgreich
gcType	nein	Transaktionsart, mögliche Werte: SALE: Verkauf wird sofort gebucht

Globale Plugin-Einstellungen

Dieser Abschnitt ist nur für Xima® Formcycle-Administratoren relevant, welche das Plugin-Bundle initial im System einrichten.

Konfiguration der Plugin-Bundle Properties

Über die nachfolgend beschriebenen Einstellungen wird das Plugin an die durch GiroSolution zur Verfügung gestellte Schnittstelle angeschlossen.

Globale Einstellungen für Anbindung einer Paypage

payment.paypage.merchant.id (Pflicht)

Händler-ID aus einem GiroSolution Payment Page Projekt.

payment.paypage.project.id (Pflicht)

Projekt-ID aus einem GiroSolution Payment Page Projekt.

payment.paypage.project.pwd (Pflicht)

Projekt-Passwort aus einem GiroSolution Payment Page Projekt.

payment.paypage.testmode (Pflicht)

Legt fest, in welchem Modus die Zahlarten auf den Payment Page anzuzeigen sind, mögliche Werte:

true: Anzeige im Test-Betrieb

false: Anzeige im Live-Betrieb

payment.paypage.currency (Pflicht)

Währung mit der alle Payment Page Transaktionen ablaufen. Angabe muss im ISO 4217 Format erfolgen.

payment.paypage.locale (Pflicht)

Sprache auf der Payment Page, mögliche Werte:

de: Anzeige in deutscher Sprache

en: Anzeige in englischer Sprache

payment.paypage.organization

Name des Anbieters der Payment Page. Wenn nichts festgelegt ist, wird der im GiroSolution GiroCockpit festgelegte Wert verwendet.

payment.paypage.proxy.host

Hostname eines Proxy-Servers, wenn die Kommunikation zwischen GiroSolution und Xima® Formcycle über einen Proxy-Server erfolgen soll

payment.paypage.proxy.port

Angabe eines Proxy-Server Ports, wenn die Kommunikation zwischen GiroSolution und Xima® Formcycle über einen Proxy-Server erfolgen soll.