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