Wiki-Quellcode von AKDB EPayment-Plugin

Zeige letzte Bearbeiter
1 {{content/}}
2
3 Das AKDB EPayment Plugin ermöglicht es über die von der AKDB bereitgestellte Payment-Schnittstelle Bezahlvorgänge in einen Formularprozesse einzubauen.
4
5 Der nachfolgende Artikel beschreibt beispielhaft die von einen Formular-Ersteller auszuführenden Schritte, um einen Bezahlvorgang in einem Formular einzubauen.
6 Auf die notwendigen Schritte, um den Service technisch in {{formcycle/}} einzubinden wird an dieser Stelle nicht eingegangen.
7
8 Prinzipiell sind immer folgende Schritte für eine Einbindung auszuführen:
9
10 1. Formular mit "bestellbaren" Artikeln und notwendigen Dateneingaben versehen
11 1. Statusverarbeitung konfigurieren mit Aktionen zum Starten einer Bezahl-Transaktion und zum Kontrollieren des Status der Transaktion
12 1. Anzeige des Ergebnisses der Bezahl-Transaktion
13
14 == 1. Formular für den Bezahlvorgang designen ==
15
16 Durch die Installation des Plugins im FORMCYCLE-System sind im Designer 2 zusätzliche Elemente, sowie 4 Vorlagen vorhanden, welche den Nutzer bei der notwendigen Konfiguration für das EPayment unterstützen sollen.
17
18 === Artikel definieren durch das Formular-Element: //EPayment Artikel//: ===
19
20 {{figure image="hilfe_epay_artikel_form.png"}}
21 Konfigurationsmöglichkeiten am Formular-Element //EPayment Artikel//
22 {{/figure}}
23
24 Über das Formular-Element //EPayment Artikel// werden die für eine Bestell-Transaktion notwendigen Artikel definiert.
25 Das Formular-Element dient dabei zum Einen für eine visuelle Darstellung des Artikels (mit Bild, Preisangabe, Eingabemöglichkeit für Bestellmenge) innerhalb eines Formulars, als auch als Vorlage
26 für die notwendige serverseitige Konfiguration des Artikels innerhalb des Aktions-Plugins ~*~*AKDB:EPayment initialisieren~*~*.
27
28 __Grundeigenschaften:__
29
30 * **Angehackt** und **Versteckt**: Durch das initiale Auswählen dieser zwei Optionen wird es möglich einen Bestellartikel vor dem Nutzer zu verbergen und direkt bei Absenden eines Formulars in den Warenkorb zu legen.
31 Dies kann immer dann der Fall sein, wenn dem Benutzer selbst keine Entscheidung für die Auswahl eines Bestellartikels ermöglicht werden soll, zum Beispiel bei der Erhebung einer Gebühr.
32
33 __EPayment Bestellartikel Einstellungen:__
34
35 * **Artikelbeschreibung**: Nähere Beschreibung eines Artikels
36 * **Artikel-Preis**: Der Preis für einen Artikel. Der an dieser Stelle konfigurierte Wert dient zum Einen für die Anzeige innerhalb des Formulars, als auch für eine Vorbelegung bei der serverseitigen Konfiguration des EPayments.
37 * **Artikelnummer**: Eine eindeutige Nummer für den einzelnen Artikel innerhalb des Formulars. Dient bei der Ausführung eines Bestell-Prozesses zur eindeutigen Identifizierung des jeweiligen Artikels.
38
39 {{info}}
40 Bei Durchführung eines Bestellvorgangs werden nur die Artikelnummer sowie die jeweilige Anzahl von einem Bestellartikel zum Server übertragen.
41 Damit ein Artikel innerhalb einer Bestellung übermittelt wird, muss er über die "Bestellen"-Option ausgewählt sein.
42 {{/info}}
43
44 === Vorlagen zur Ermittlung von Bestellinformationen: ===
45
46 {{figure image="hilfe_epay_vorlagen_form.png"}}
47 Vorlagen zur Datenerhebung für das EPayment
48 {{/figure}}
49
50 Durch das Plugin werden verschiedene Designer-Vorlagen bereitgestellt, mit denen es ermöglicht wird die nachfolgend aufgeführten Daten vom Benutzer zu ermitteln:
51
52 * Persönliche Daten: (Anrede, Name, Vorname, E-Mail etc.)
53 * Rechnungsadresse
54 * Lieferadresse
55 * Bankverbindung
56
57 {{info}}
58 Die Vorlagen "Persönliche Daten" und "Rechnungsadresse" können im Zusammenspiel mit dem //Bürgerkonto-Login// der AKDB verwendt werden. Sie werden nach einem erfolgreichen Login automatisch vorbelegt.
59 {{/info}}
60
61 === Bestellprozess starten mittels Formular-Element //EPayment Bestellen Button//: ===
62
63 {{figure image="hilfe_epay_button_form.png"}}
64 Konfigurationsmöglichkeiten am Formular-Element //EPayment Bestellen Button//
65 {{/figure}}
66
67 Über das Formular-Element //EPayment Bestellen Button// kann das Formular durch den Nutzer abgesendet und damit der Bezahlvorgang gestartet werden.
68 Bei Nutzung dieses Absende-Buttons werden zum Absende-Zeitpunkt alle ausgewählten Artikeln ermittelt und deren Artikelnummer sowie Bestellmenge zum Server übertragen.
69
70 __EPayment Einstellungen:__
71
72 * **Schaltflächentext**: Beschriftung des Absenden-Buttons
73 * **Eingaben pruefen vor Absenden**: Wenn ausgewählt, wird das Formular vor dem Absenden validiert, sonst erfolgt keine Prüfung.
74
75 == 2. Statusverarbeitung für EPayment konfigurieren ==
76
77 Um eine Bezahl-Transaktion in einen Formularprozess einzubauen werden die folgenden Aktions-Plugins zur Verfügung gestellt:
78
79 * **AKDB:EPayment initialisieren**: Dieses erzeugt eine neue Bezahl-Transaktion auf Seiten der AKDB und leitet den Benutzer auf dessen Portalseite weiter.
80 * **AKDB:EPayment verifizieren**: Prüft den aktuellen Status einer Bezahl-Transaktion
81
82 Ein Statusverarbeitung für einen einfachen Fall kann folgendermaßen konfiguriert sein:
83
84 (% style="background-color:transparent; border:none" %)
85 |(% style="border-style:none; width:180px" %)[[image:hilfe_statusverabeitung.png||alt="Statusverarbeitung mit Anbindung EPayment"]]|(% style="border-style:none; width:700px" %)(((
86 __Kurze Ablaufbeschreibung zur dargestellten Statusverarbeitung:__
87
88 ~1. Nach dem Absenden des Bestellformulars wird in den Status //Eingegangen// gewechselt und dort das Aktions-Plugin **AKDB:EPayment initialisieren **ausgeführt. Dieses ermittelt die für den Bestellvorgang notwendigen Daten aus dem Formular und Startet mit diesen eine Bezahl-Transaktion auf Seiten der AKDB. Wenn dies erfolgreich war, wird der Benutzer zum ePay-BL Portal der AKDB, unter vorheriger Angabe eines Rücksprung-Ziels, weitergeleitet.
89
90 2. Nach Abschluss des Bezahlvorgangs auf im ePay-BL Portal wird der Benutzer wieder zu FORMCYCLE-Formular zurückgeleitet. Dies erfolgt unter Benutzung des angegebenen Rücksprung-Ziels.
91 Aus einer im Vorfeld festgelegten Konfiguration im **AKDB:EPayment initialisieren **Aktions-Plugin wird der Ziel-Status nach Rückkehr aus dem ePay-BL Portal ermittelt. Im vorliegenden Beispiel wird deshalb in den Status //Zahlung pruefen// gewechselt.
92
93 3. Die Statusverarbeitung //Zahlung pruefen// wird ausgeführt und dort das Aktions-Plugin **AKDB:EPayment verifizieren** durchlaufen. Unter Zuhilfenahme dieses Plugins wird der aktuelle Status der Bezahlung am EPayment-System geprüft und in der weiteren Statusverarbeitung (per Platzhalter) zur Verfügung gestellt.
94
95 4. Im Falle einer positiven Verifizierung des Bezahlvorgangs wird unter Zuhilfenahme der Aktion **Statusänderung** in den Status //Bezahlt //gewechselt. Innerhalb von diesem Status ist durch eine **Weiterleitungs**-Aktion eine Weiterleitung ins aktuelle Formular konfiguriert, sodass dieses dem Benutzer wieder angezeigt wird. Innerhalb dieses Formulares kann dann ein Formular-Element konfiguriert werden, welches nur im Status //Bezahlt// angezeigt wird und dem Benutzer eine positive Rückmeldung zum Ausgang seinen Bezahlvorgangs anzeigt.
96
97 __Hinweis:__ Anstatt einer Rückleitung ins Formular kann im Status //Bezahlt// auch eine individuelle Abschluss-Seite konfiguriert sein. Dann würde diese dem Nutzer angezeigt werden.
98
99 5. Im Falle einer negativen Verifizierung des Bezahlvorgangs (z.B.: Nutzer hat Bezahlvorgang im ePay-BL Portal abgebrochen, Es kam zu Fehlern während des Bezahlvorgangs) wird unter Zuhilfenahme der Aktion Statusänderung in den Status Bezahlung offen gewechselt. Es erfolgt wieder eine Weiterleitung ins aktuelle Formular, wo eine Formular-Element konfiguriert ist, welches nur im Status //Bezahlung offen// angezeigt wird und dem Benutzer eine Rückmeldung zu  seiner noch ausstehenden Bezahlung anzeigt.
100
101
102 )))
103
104 === Konfigurationsmöglichkeiten des Aktions-Plugins //AKDB:EPayment initialisieren// ===
105
106 Dieses Plugin ist für das Erzeugen einer Bezahl-Transaktion im ePay-BL Portal zuständig. Hier werden im Vorfeld die Daten, welche im Zusammenhang mit der Transaktion stehen (bestellte Artikel, Preisbestimmung, persönliche Daten des Käufers, Rechnungsadresse etc.), festgelegt. Weiterhin erfolgt die Festlegung in welchen Status nach Rückkehr aus dem ePay-BL Portal gewechselt werden soll.
107
108 {{info}}
109 Wenn vor der Konfiguration des Plugins bereits mindestens ein **EPayment-Artikel**, der **EPayment Bestellen Button** sowie die **Vorlage** für die **persönlichen Daten** im Formular hinterlegt wurden, werden bei einer Neueinrichtung der //AKDB:EPayment initialisieren// Plugin-Aktion die notwendigen Pflicht-Konfigurationen bereits mit den ermittelten Daten aus dem Formular vorbelegt und es muss nur noch der Ziel-Status für eine erfolgreiche / nicht erfolgreiche Transaktion festgelegt werden.
110 Es empfiehlt sich deshalb die in diesem Artikel beschriebene Konfigurations-Reihenfolge einzuhalten.
111 {{/info}}
112
113 Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.
114
115 {{panel title="Konfiguration AKDB EPayment-Mandant" fullwidth="true" initial="hidden" triggerable="true"}}
116
117 {{figure image="plugin_init_config_akdb_mandant.png"}}
118 Konfiguration AKDB EPayment-Mandant
119 {{/figure}}
120
121 In diesem Bereich werden die für den Formular-Prozess zu verwendenden Einstellungen ePay-BL Mandanten hinterlegt. Diese sind notwendig, um später die Transaktion auf Seiten von ePay-BL
122 der richtigen Behörde (=Mandantnummer), Bewirtschafter und Haushaltsstelle zuzuordnen. Die Daten in diesem Bereich sind meistens bereits mit globalen Einstellungen vorbefüllt,
123 sofern diese durch einen Plugin-Administrator korrekt hinterlegt wurden.
124
125 Die einzelnen Parameter können per Platzhalter oder fest definiert hinterlegt werden. Weiterhin kann über den Button [[image:icon_update.png]] //EPayment Webservice Erreichbarkeit prüfen// die Erreichbarkeit des EPayment Webservice geprüft werden.
126
127 ; Mandant-Nummer (Pflichtfeld)
128 : AKDB-Mandantennummer des aufrufenden eShops (FORMCYCLE) (Wird durch ePay-BL-System vorgegeben)
129 ; Bewirtschafter-Nummer (Pflichtfeld)
130 : Bewirtschafternummer (Wird durch ePay-BL-System vorgegeben)
131 ; Haushaltsstelle (Pflichtfeld)
132 : Nummer der Haushaltsstelle, welcher die Buchung zugeordnet werden soll. (Wird durch ePay-BL-System vorgegeben)
133 ; Objektnummer (Pflichtfeld)
134 : Dient der internen Verbuchung im EPayment-System. (Wird durch ePay-BL-System vorgegeben)
135 ; Kennzeichen-Mahnverfahren (Pflichtfeld)
136 : Einstellung für das Kennzeichen in einem Mahnverfahren. (Mögliche Werte werden durch ePay-BL-System vorgegeben)
137 ; Fälligkeitszeitraum (Pflichtfeld)
138 : Einstellung für die Berechnung des Fälligkeitszeitraumes der Zahlung (Dauer in Tagen).
139 ; Währung
140 : Währung in welcher der Betrag ausgewiesen wird. Ist nichts definiert wird als Wert **EUR** angenommen.
141
142 {{/panel}}
143
144 {{panel title="Konfiguration für die PayPage" fullwidth="true" initial="hidden" triggerable="true"}}
145
146 {{figure image="plugin_init_config_paypage.png"}}
147 Konfiguration für die PayPage
148 {{/figure}}
149
150 ; URL zur PayPage (Pflichtfeld)
151 : URL zur PayPage des EPayment-Systems. Die hier hinterlegte URL wird durch das ePay-BL-System vorgegeben und beinhaltete den Verweis auf die PayPage im ePay-BL-System.
152 ; Automatische Weiterleitung zur PayPage verhindern
153 : Bei aktivierter Einstellung kann eine automatische Weiterleitung zur PayPage unterbunden werden.
154 ; Status, in welchen nach erfolgreicher Transaktion gewechselt wird (Pflichtfeld)
155 : Hier muss ein Status festgelegt werden, in welchen gewechselt wird, wenn der Bezahlvorgang auf Seiten des ePay-BL-Systems erfolgreich durchlaufen wurde.
156 ; Status, in welchen nach fehlerhafter oder abgebrochener Transaktion gewechselt wird (Pflichtfeld)
157 : Hier muss ein Status festgelegt werden, in welchen gewechselt wird, wenn der Bezahlvorgang auf Seiten des ePay-BL-Systems abgebrochen wurde.
158 ; PayPage Buchungstext
159 : Dieser Buchungstext wird dem Benutzer auf der PayPage angezeigt.
160 ; Fälligkeitsdatum
161 : Der konfigurierte Wert muss sich in ein gültiges Datum umwandeln lassen. Wenn an dieser Stelle ein Wert hinterlegt ist, wird dieser als Fälligkeitszeitpunkt für die Zahlung übermittelt und
162 die Einstellung für den **Fälligkeitszeitraum** wird nicht beachtet.
163
164 {{/panel}}
165
166 {{panel title="Kundenstammdaten" fullwidth="true" initial="hidden" triggerable="true"}}
167
168 {{figure image="plugin_init_config_kundenstammdaten.png"}}
169 Konfiguration für die Kundenstammdaten
170 {{/figure}}
171
172 In diesem Bereich werden die Daten des Benutzers, für den die Bezahl-Transaktion erzeugt werden soll, hinterlegt.
173 Die einzelnen Parameter können per Platzhalter oder fest definiert hinterlegt werden.
174
175 {{info}}
176 Über den Link [[image:icon_update.png]] //Formular-Elemente für Kundenstammdaten ermitteln// können die Felder bei Nutzung der EPayment-Vorlage //Persönliche Daten// vorbelegt werden.
177 {{/info}}
178
179 ; Anrede
180 ; Titel
181 ; Vorname
182 ; Nachname (Pflichtfeld)
183 ; Geburtsdatum
184 : Geburtsdatum muss in der Form **dd.MM.yyyy** übermittelt werden.
185 ; E-Mail
186 : Wird für die Zustellung von Emails an den Kunden in Abhängigkeit von der ePay-BL-Mandantkonfiguration benötigt.
187 ; Telefon (privat)
188 ; Telefon (dienstlich)
189 ; Mobiltelefon
190
191 {{/panel}}
192
193 {{panel title="Bestellinformationen" fullwidth="true" initial="hidden" triggerable="true"}}
194
195 {{figure image="plugin_init_config_artikel.png"}}
196 Konfiguration der Bestellinformationen
197 {{/figure}}
198
199 In diesem Bereich werden die bestellbaren Artikel definiert.
200 Weiterhin wird im Feld //Übermittelte Bestellung//, per Platzhalter, der Wert festgelegt, welcher zum Ausführungszeitpunkt die JSON-Struktur mit den im Formular bestellten Artikeln enthält.
201
202
203 {{info}}
204 Wenn das Formular über die Elemente **EPayment-Artikel** und **EPayment Bestellen Button** verfügt kann über den jeweiligen Button [[image:icon_update.png]] eine Vorbefüllung der vorhandenen Pflichtfelder durchgeführt werden.
205 {{/info}}
206
207 In der Tabelle //Bestellartikel-Definitionen// erfolgt die Definition der einzelnen Bestell-Artikel. Die hier konfigurierten Angaben sind maßgeblich für eine Übermittlung an den ePay-BL-Service.
208 Jeder Artikel muss über folgende Parameter verfügen:
209 ; Artikelnummer (Pflichtfeld)
210 : Eine Nummer die den einzelnen Artikel innerhalb einer Bestellung eindeutig identifizierbar macht.
211 ; Beschreibung (Pflichtfeld)
212 : Der Buchungstext darf nur folgende Zeichen enthalten: //A-Za-z0-9,.:/+& -*$%ÄÖÜäöüß// und ist in seiner Länge auf maximal 21 Zeichen begrenzt.
213 ; Betrag (Pflichtfeld)
214 : Komma separierte Zahl, die den Preis eines Artikels definiert.
215 ; Belegnummer
216 : Die Belegnummer ist optional und dient der weiterführenden Verarbeitung auf Seiten von ePay-BL.
217
218
219 {{info}}
220 __Hinweis:__ Um zur Laufzeit den Gesamtpreis einer Zahlungsanweisung zu errechnen, wird immer der Artikel-Preis aus der //Bestellartikel-Definitionen//-Tabelle entnommen.
221 Einzig Artikelnummer und Bestellmenge werden aus den vom Browser übermittelten Daten zur Erstellung der Bezahl-Transaktion herangezogen.
222 {{/info}}
223
224
225 {{/panel}}
226
227 {{panel title="Konfiguration Rechnungsadresse (optional)" fullwidth="true" initial="hidden" triggerable="true"}}
228
229 {{figure image="plugin_init_config_rechadr.png"}}
230 Konfiguration der Rechnungsadresse
231 {{/figure}}
232
233 Die in diesem Bereich konfigurierbaren Werte sind grundlegend optional. Das heißt, die Daten zur Rechnungsadresse müssen nicht an den EPayment-Service übergeben werden.
234 Bei Festlegung einer Konfiguration innerhalb dieses Bereichs werden aber einige Felder "bedingt verpflichtend".
235
236 {{info}}
237 Über den Link [[image:icon_update.png]] //Formular-Elemente für Rechnungsadresse ermitteln// können die Felder bei Nutzung der EPayment-Vorlage //Rechnungsadresse// vorbelegt werden.
238 {{/info}}
239
240
241 ; Strasse (bedingt verpflichtend)
242 : Wahlweise ist Strasse und Hausnummer **oder** Postfach bei Nutzung von Rechnungsadressdaten ein Pflichtfeld.
243 ; Hausnummer (bedingt verpflichtend)
244 : Wahlweise ist Strasse und Hausnummer **oder** Postfach bei Nutzung von Rechnungsadressdaten ein Pflichtfeld.
245 ; Postfach (bedingt verpflichtend)
246 : Wahlweise ist Postfach **oder** Strasse und Hausnummer bei Nutzung von Rechnungsadressdaten ein Pflichtfeld.
247 ; Ort (bedingt verpflichtend)
248 ; PLZ (bedingt verpflichtend)
249 : Postleitzahl
250 ; Land (bedingt verpflichtend)
251 : Wenn gesetzt, muss die Angabe gemäß ISO 3166-1 erfolgen (zwei Großbuchstaben, z.B.: DE)
252
253 {{/panel}}
254
255 {{panel title="Konfiguration Lieferadresse (optional)" fullwidth="true" initial="hidden" triggerable="true"}}
256
257 {{figure image="plugin_init_config_lieferadr.png"}}
258 Konfiguration der Lieferadressdaten
259 {{/figure}}
260
261 In diesem Bereich konfigurierten Werte sind grundlegend optional. Das heißt, die Daten zur Lieferadresse müssen nicht an den EPayment-Service übergeben werden.
262 Dies ist zum Beispiel dann der Fall, wenn es sich bei dem zu bezahlenden Objekt um ein immaterielles Gut handelt.
263 Bei Festlegung einer Konfiguration innerhalb dieses Bereichs werden aber einige Felder "bedingt verpflichtend".
264
265 {{info}}
266 Über den Link [[image:icon_update.png]] //Formular-Elemente für Lieferadresse ermitteln// können die Felder bei Nutzung der EPayment-Vorlage //Lieferadresse// vorbelegt werden.
267 {{/info}}
268
269
270 ; Anrede
271 ; Vorname
272 ; Nachname
273 ; Strasse (bedingt verpflichtend)
274 : Wahlweise ist Strasse und Hausnummer **oder** Postfach bei Nutzung von Lieferadressdaten ein Pflichtfeld.
275 ; Hausnummer (bedingt verpflichtend)
276 : Wahlweise ist Strasse und Hausnummer **oder** Postfach bei Nutzung von Lieferadressdaten ein Pflichtfeld.
277 ; Postfach (bedingt verpflichtend)
278 : Wahlweise ist Postfach **oder** Strasse und Hausnummer bei Nutzung von Lieferadressdaten ein Pflichtfeld.
279 ; Ort (bedingt verpflichtend)
280 ; PLZ (bedingt verpflichtend)
281 : Postleitzahl
282 ; Land (bedingt verpflichtend)
283 : Wenn gesetzt, muss die Angabe gemäß ISO 3166-1 erfolgen (zwei Großbuchstaben, z.B.: DE)
284
285 {{/panel}}
286
287 {{panel title="Konfiguration für die Bankverbindung (optional)" fullwidth="true" initial="hidden" triggerable="true"}}
288
289 {{figure image="plugin_init_config_bank.png"}}
290 Konfiguration für die Bankverbindung
291 {{/figure}}
292
293 In diesem Bereich konfigurierten Werte sind grundlegend optional. Das heißt, die Daten zur Bankverbindung müssen nicht an den EPayment-Service übergeben werden.
294 Bei Festlegung einer Konfiguration innerhalb dieses Bereichs werden aber einige Felder "bedingt verpflichtend".
295
296 {{info}}
297 Über den Link [[image:icon_update.png]] //Formular-Elemente für Bankverbindung ermitteln// können die Felder bei Nutzung der EPayment-Vorlage //Bankverbindung// vorbelegt werden.
298 {{/info}}
299
300
301 ; Kontoinhaber
302 : Falls der Inhaber des Kontos vom Namen des Kunden abweicht, muss dieser hier übertragen werden. Falls das Feld leer ist, wird bei den Zahlungsüberstellungen der Nachname des Kunden verwendet.
303 ; Kontonummer (bedingtes Pflichtfeld)
304 : Kontonummer vom Zahlungspflichtigen. Wenn Kontodaten konfiguriert werden, ist dies ein Pflichtfeld.
305 ; IBAN
306 : **I**nternational **B**ank **A**ccount **N**umber des Kontos
307 ; BIC
308 : **B**ank **I**dentification **C**ode des Kontos
309 ; BLZ (bedingtes Pflichtfeld)
310 : Bankleitzahl vom Konto des Zahlungspflichtigen. Wenn Kontodaten konfiguriert werden, ist dies ein Pflichtfeld.
311
312 {{/panel}}
313
314 {{panel title="Allgemeine Rückgabeparameter" fullwidth="true" initial="hidden" triggerable="true"}}
315
316 {{figure image="plugin_init_config_result.png"}}
317 Konfiguration der Plugin Rückgabedaten (Platzhalter)
318 {{/figure}}
319
320 In diesem Bereich werden die vom Plugin als Ergebnis der Bezahl-Transaktion zurückgelieferten Parameter aufgeführt.
321 Für die einzelnen Parameter kann ein Alias vergeben werden.
322 In weiteren Aktionen kann auf den entsprechenden Rückgabeparameter per Platzhalter-Syntax zugegriffen werden.
323 Der Platzhalter wird dabei nach dem folgenden Muster gebildet:
324
325
326 {{code language="java"}}
327 [%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%]
328 {{/code}}
329
330
331
332 ; Kassenzeichen
333 : Das für die Transaktion, auf Seiten von ePay-BL erzeugte, notwendige Kassenzeichen.
334 ; EShopKundenNr
335 : Die für die Transaktion automatisch erzeugte EShopKundenNr. (Dient der internen Verarbeitung.)
336 ; Gesamtbetrag
337 : Der errechnete Gesamtbetrag der Bezahl-Transaktion. (Ergibt sich aus der Summe aller bestellten Artikel X deren Bestellmenge.)
338
339
340 {{info}}
341 Über den [[image:icon_copy.png]] Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert
342 und an anderer Stelle, z.B.: im Text einer E-Mail-Aktion, eingefügt werden.
343 {{/info}}
344
345 {{/panel}}
346
347 === Konfigurationsmöglichkeiten des Aktions-Plugins //AKDB:EPayment verifizieren// ===
348
349 {{figure image="plugin_verify.png"}}
350 Konfiguration des Plugins //AKDB:EPayment verifizieren//
351 {{/figure}}
352
353 Dieses Plugin ist zum Auswerten des Status einer Bezahl-Transaktion zuständig. Im Standardfall muss innerhalb des Plugins keine weitere Konfiguration erfolgen, da alle notwendigen Parameter, für eine Prüfanfrage am ePay-BL-Service, intern hinterlegt sind.
354 Es besteht aber auch die Möglichkeit die //AKDB-Mandantennummer// und das //Kassenzeichen// durch eine Konfiguration zu übersteuern. Dies kann immer dann der Fall sein, wenn die Prüfung in einem anderem Formularvorgang erfolgen soll, in dem **nicht** die eigentliche Bezahl-Transaktion erzeugt wurde.
355
356
357
358 {{panel title="Allgemeine Rückgabeparameter" fullwidth="true" initial="hidden" triggerable="true"}}
359
360
361 In diesem Bereich werden die vom Plugin als Ergebnis der Status-Prüfung am ePay-BL-Service zurückgelieferten Parameter aufgeführt.
362 Für die einzelnen Parameter kann ein Alias vergeben werden.
363 In weiteren Aktionen kann auf den entsprechenden Rückgabeparameter per Platzhalter-Syntax zugegriffen werden.
364 Der Platzhalter wird dabei nach dem folgenden Muster gebildet:
365
366
367 {{code language="java"}}
368 [%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%]
369 {{/code}}
370
371
372
373 ; PayPageStatus
374 : Enthält den vom ePay-BL-Service zurückgelieferten Statuscode. Die nachfolgende Tabelle gibt einen Überblick über die möglichen Statuscode und deren Bedeutung:
375 |=Statuscode|=Bedeutung
376 |INAKTIV | Die Bezahlung über die PayPage ist erfolgreich durchgeführt worden
377 |AKTIV | Die Bezahlung über die PayPage ist noch nicht erfolgt.
378 |MANDANT_NICHT_GEFUNDEN | Der Mandant wurde im ePayment-System nicht gefunden.
379 |MANDANT_INAKTIV | Der Mandant ist im ePayment-System derzeit als inaktiv gekennzeichnet.
380 |VERBINDUNG_OHNE_HTTPS | Die Verbindung zum Webservice erfolgte nicht über HTTPS mit Client-Zertifikaten.
381 |VERBINDUNG_ZERTIFIKAT_FEHLER | Das für die Verbindung verwendete Client-Zertifikat darf nicht für den gewählten Mandanten verwendet werden.
382 |KASSENZEICHEN_NICHT_VORHANDEN | Das gewählte Kassenzeichen ist nicht vorhanden.
383 |KASSENZEICHEN_NICHT_GEFUNDEN | Das gewählte Kassenzeichen konnte nicht gefunden werden.
384 |INTERNER_EPAYMENT_FEHLER | Interner nicht dokumentierter Fehler im ePayment-System.
385 |UNDEFINIERT | Ein im System nicht bekannter Status
386 ; WebserviceErgebnisText
387 : Enthält den vom ePay-BL Service zurückgelieferten Erläuterungstext zum übermittelten Status.
388
389 {{info}}
390 Über den [[image:icon_copy.png]] Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert
391 und an anderer Stelle, z.B.: als Wert innerhalb einer Bedingung, eingefügt werden.
392 {{/info}}
393
394
395 {{/panel}}
396
397 == 3. Ergebnisanzeige ==
398
399 {{figure image="hilfe_statusverabeitung_bedingung.png"}}
400 Beispiel für die Konfiguration einer Bedingung, welche den aktuelle Status einer Bezahl-Transaktion beinhaltet. Die Bedingung im vorliegenden Beispiel wird positiv durchlaufen wenn der Nutzer zuvor bezahlt hat.
401 {{/figure}}
402
403 Für die Anzeige des Ergebnisses bzw. dem Status einer Bezahl-Transaktion bestehen mehrere Möglichkeiten.
404 Man kann dem Nutzer dieses in einer extra dafür hinterlegten Abschluss-Seite oder durch die Wiederanzeige das Formulars anzeigen.
405 Ein Beispiel für die Ergebnisanzeige innerhalb des Formular ist unter //Punkt 2// aufgeführt.
406
407 In den meisten Fällen ist es gewünscht, dass je nach Status der Bezahl-Transaktion unterscheidliche Rückmeldungstexte angezeigt oder
408 zusätzliche Aktionen ausgeführt, werden.
409
410 Erreichen kann man dies über eine entsprechende Bedingung am Status oder der jeweiligen Aktion.
411
412
413 == Weiterführende Informationen ==
414
415 === Aktions-Plugin //AKDB:EPayment PayPageURL bereitstellen// ===
416
417 Durch dieses Plugin kann die aktuell gültige URL zur Bezahl-Transaktion ins ePay-BL-Portal aus dem Formular-Vorgang ermittet werden. 
418 Dadurch besteht die Möglichkeit eine noch nicht abgeschlossene Bezahl-Transaktion nochmals zur Anzeige zu bringen und die Zahlung durchzuführen. Dieses Aktions-Plugin muss dabei im zeitlichen Ablauf nach dem Plugins **AKDB:EPayment initialisieren** konfiguriert sein.

Navigation

Copyright 2000-2025