Zeige letzte Bearbeiter
1 [[**Plugin-Download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/plugin-bundle-girosolution&fileid=3463||target="_blank"]] (erfordert Anmeldung)
2
3 {{content/}}
4
5 Das kostenpflichtige GiroSolution ePayment Plugin ermöglicht es, über die von GiroSolution bereitgestellte PayPage, einen Bezahlvorgang innerhalb eines Formularprozesses einzubauen.
6
7 {{info}}
8 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.
9 {{/info}}
10
11 == Aktions-Plugin //GiroSolution: Paypage: Initialisierung// ==
12
13 Mit der Einbindung des Aktions-Plugin //GiroSolution: Paypage: Initialisierung// ist es möglich ein Bezahl-Transaktion innerhalb der {{formcycle/}} Statusverarbeitung auszuführen. Nachfolgend werden die dafür notwendigen Konfigurations-Parameter näher beschrieben.
14
15 === Transaktionsdaten ===
16
17 {{figure image="plugin_trans_data.png"}}
18 Konfiguration der Transaktionsdaten
19 {{/figure}}
20
21 ; Automatisch zur Paypage witerleiten
22 : 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.
23
24 {{info title="Hinweis:"}}
25 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.
26 {{/info}}
27
28 ; Betrag
29 : Hier ist der zu bezahlende Betrag in der kleinsten Währungseinheit (z.B.: Cent, Penny) anzugeben. Es werden Platzhalter unterstützt.
30
31 {{info title="Hinweis:"}}
32 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.
33 {{/info}}
34
35 ; Verwendungszweck
36 : 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:
37
38 * 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
39 * 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
40 * Zahlen von 0 – 9
41 * Sonderzeichen: ' : ? , - ( + . ) / |
42
43 ; Beschreibung für Bezahlung
44 : 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.).
45
46 === Zielstatus ===
47
48 {{figure image="plugin_states.png"}}
49 Konfiguration des Zielstatus nach Rückkehr von der Bezahlseite in {{formcycle/}}
50 {{/figure}}
51
52 In diesem Bereich können Status festgelegt werden, in welchen der Vorgang versetzt wird, wenn {{formcycle/}} eine Rückmeldung von //GiroSolution// erhält:
53
54 {{id name="payment_server_result"/}}
55
56 ; Zielstatus für Payment Server Rückmeldung
57 : 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>>doc:||anchor="notification_params"]]// aufgeführten Parameter zur Verfügung.
58 ; Zielstatus für erfolgreiche Zahlung
59 : 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.
60 ; Zielstatus für abgebrochenen Zahlvorgang
61 : 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.
62 ; Zielstatus für erfolglose Zahlung
63 : Hier kann ein Status festgelegt werden, in welchen gewechselt wird, wenn der Bezahlvorgang erfolglos beendet wurde.
64
65 Nach dem Durchlaufen der jeweiligen Statusverarbeitung erfolgt standardmäßig eine Weiterleitung ins Formular.
66 Wenn in der Statusverarbeitung eine Aktion vom Typ "[[Abschlussseite (Template)>>doc:Formcycle.Designer.Workflow.Actions.HtmlResponsePage||target="_blank"]]" definiert ist, erfolgt die Weiterleitung zu dieser Abschluss-Seite anstatt ins Formular.
67
68 === Übersteuerung globaler Einstellungen ===
69
70 {{figure image="plugin_global_data.png"}}
71 Globale Einstellungen übersteuern
72 {{/figure}}
73
74 In diesem Bereich können die unter //[[Globale Einstellungen für Anbindung einer Paypage>>doc:||anchor="global_config"]]// getroffenen Einstellungen übersteuert werden.
75
76 ; Händler-ID
77 : Händler-ID aus einem //GiroSolution Payment Page// Projekt.
78 ; Projekt-ID
79 : Projekt-ID aus einem //GiroSolution Payment Page// Projekt.
80 ; Projekt-Passwort
81 : Projekt-Passwort aus einem //GiroSolution Payment Page// Projekt.
82 ; Währung
83 : Währung mit der alle Payment Page Transaktionen ablaufen. Angabe muss im [[ISO 4217 Format>>https://de.wikipedia.org/wiki/ISO_4217||rel="noopener noreferrer" target="_blank" title="ISO 4217"]] erfolgen.
84 ; Sprache
85 : Sprache auf der Payment Page, mögliche Werte:
86
87 * **de**: Anzeige in deutscher Sprache
88 * **en**: Anzeige in englischer Sprache
89
90 ; Anbietername
91 : Name des Anbieters auf der Bezahlseite. Wenn nichts festgelegt ist, wird der im //GiroSolution GiroCockpit// festgelegte Wert verwendet.
92 ; Test-Modus?
93 : Legt fest, in welchem Modus die Zahlarten auf den Payment Page anzuzeigen sind. Wenn aktiviert ist der **Test-Betrieb** aktiv, sonst der **Live-Betrieb**.
94
95 === Allgemeine Rückgabeparameter ===
96
97 {{figure image="plugin_result.png"}}
98 Allgemeine Rückgabeparameter
99 {{/figure}}
100
101 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:
102
103 {{code language="none"}}
104
105 [%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%]
106 {{/code}}
107
108 {{info}}
109 Über den [[image:icon_copy.png]] Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert
110 und an anderer Stelle, zum Beispiel im Text einer E-Mail-Aktion, mittels {{code language="none"}}Ctrl+C{{/code}} eingefügt werden.
111 {{/info}}
112
113 ; ResultCode
114 : Enthält einen Zahlenwert, welcher den Abarbeitungs- bzw. Fehlerstatus des Plugins widergibt.
115 ; ResultMessage
116 : Enthält eine Klartextmeldung, welche den zurückgelieferten //ResultCode// näher erläutert.
117 ; ResultMerchantTxID
118 : 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.
119 ; ResultPaypageUrl
120 : 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.
121 ; ResultPaypageReferenceID
122 : 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.
123
124 == Notification-Parameter ==
125
126 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.
127 Die Parameter stehen in den konfigurierten //[[Zielstatus für Payment Page Rückmeldungen>>doc:||anchor="payment_server_result"]]// zur Verfügung und können über die Platzhalternotation {{code language="none"}}[%<Parametername>%]{{/code}} angesprochen werden.
128
129 {{id name="notification_params"/}}
130
131 |=Parametername|=Optional|=Bedeutung
132 |gcAccountHolder|ja|Kontoinhaber bei Lastschriftverfahren
133 |gcAmount|nein|Rechnungsbetrag, bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny
134 |gcBackendTxId|nein|Zahlungsabwickler Transaktions-ID
135 |gcCardExpDate|ja|Gültigkeitsdatum der Kreditkarte im Format Monat/Jahr, wenn Kreditkartenzahlung
136 |gcCardnumber|ja|Maskierte Kreditkartennummer
137 |gcCurrency|nein|Die in der Transaktion verwendete Währung
138 |gcHash|nein|HMAC MD5 Hash über alle Werte des Aufrufs
139 |gcIban|ja|IBAN bei Lastschrift
140 |gcMerchantTxId|nein|Verkäufer Transaktions-ID
141 |gcPaymethod|nein|(((
142 ID der Zahlungsart der Transaktion, mögliche Werte:
143
144 * **1:** giropay
145 * **2:** eps
146 * **6:** Lastschrift
147 * **7:** Lastschrift mit Sperrdatei
148 * **8:** Garantierte Lastschrift
149 * **11:** Kreditkarte
150 * **12:** iDEAL
151 * **14:** PayPal
152 * **23:** paydirekt
153 * **27:** Sofort
154 )))
155 |gcPkn|ja|Pseudokartennummer
156 |gcProjectId|nein|GiroCheckout Projekt-ID, über die die Transaktion abgewickelt wurde.
157 |gcReference|nein|GiroCheckout Transaktions-ID
158 |gcResultPayment|nein|Ergebniscodes der Zahlung, mögliche Werte:(((
159 * **4000:** Transaktion erfolgreich
160 * **4001:** giropay Bank offline
161 * **4002:** Online Banking Zugang ungültig
162 * **4051:** Kontoverbindung ungültig
163 * **4101:** Ausgabeland der Karte nicht gültig oder unbekannt
164 * **4102:** 3D-Secure Autorisierung fehlgeschlagen
165 * **4103:** Gültigkeitsdatum der Karte überschritten
166 * **4104:** Kreditkartentyp ungültig oder unbekannt
167 * **4105:** Karte eingeschränkt nutzbar
168 * **4106:** Pseudo-Kartennummer ungültig
169 * **4107:** Karte gestohlen, verdächtig oder zum Einziehen markiert
170 * **4108:** Telefonische Genehmigung
171 * **4151:** PayPal Token ungültig
172 * **4152:** Nachbearbeitung bei PayPal notwendig
173 * **4153:** Zahlungsmethode bei PayPal ändern
174 * **4154:** PayPal-Zahlung nicht abgeschlossen
175 * **4500:** Zahlungsausgang unbekannt
176 * **4501:** Timeout / Keine Benutzereingabe
177 * **4502:** Abbruch durch Benutzer
178 * **4503:** Doppelte Transaktion
179 * **4504:** Manipulationsverdacht oder Zahlungsmittel temporär gesperrt
180 * **4505:** Zahlungsmittel gesperrt oder abgelehnt
181 * **4506:** Blue Code Barcode ungültig
182 * **4900:** Transaktion nicht erfolgreich
183 )))
184 |gcType|nein|(((
185 Transaktionsart, mögliche Werte:
186
187 * **SALE:** Verkauf wird sofort gebucht
188 )))
189
190 == Globale Plugin-Einstellungen ==
191
192 {{info}}
193 Dieser Abschnitt ist nur für {{formcycle/}}-Administratoren relevant, welche das Plugin-Bundle initial im System einrichten.
194 {{/info}}
195
196 === Konfiguration der Plugin-Bundle Properties ===
197
198 Über die nachfolgend beschriebenen Einstellungen wird das Plugin an die durch GiroSolution zur Verfügung gestellte Schnittstelle angeschlossen.
199
200 {{id name="global_config"/}}
201
202 ==== Globale Einstellungen für Anbindung einer Paypage ====
203
204 ; payment.paypage.merchant.id (Pflicht)
205 : Händler-ID aus einem //GiroSolution Payment Page// Projekt.
206 ; payment.paypage.project.id (Pflicht)
207 : Projekt-ID aus einem //GiroSolution Payment Page// Projekt.
208 ; payment.paypage.project.pwd (Pflicht)
209 : Projekt-Passwort aus einem //GiroSolution Payment Page// Projekt.
210 ; payment.paypage.testmode (Pflicht)
211 : Legt fest, in welchem Modus die Zahlarten auf den Payment Page anzuzeigen sind, mögliche Werte:
212
213 * **true**: Anzeige im Test-Betrieb
214 * **false**: Anzeige im Live-Betrieb
215
216 ; payment.paypage.currency (Pflicht)
217 : Währung mit der alle Payment Page Transaktionen ablaufen. Angabe muss im ISO 4217 Format erfolgen.
218 ; payment.paypage.locale (Pflicht)
219 : Sprache auf der Payment Page, mögliche Werte:
220
221 * **de**: Anzeige in deutscher Sprache
222 * **en**: Anzeige in englischer Sprache
223
224 ; payment.paypage.organization
225 : Name des Anbieters der Payment Page. Wenn nichts festgelegt ist, wird der im //GiroSolution GiroCockpit// festgelegte Wert verwendet.
226 ; payment.paypage.proxy.host
227 : Hostname eines Proxy-Servers, wenn die Kommunikation zwischen //GiroSolution// und {{formcycle/}} über einen Proxy-Server erfolgen soll
228 ; payment.paypage.proxy.port
229 : Angabe eines Proxy-Server Ports, wenn die Kommunikation zwischen //GiroSolution// und {{formcycle/}} über einen Proxy-Server erfolgen soll.