aforms

In diesem Artikel erfährst Du, wie Du Payrexx an die Software AFS von aforms anbindest, um direkt über die Formulare Zahlungen empfangen zu können.

Allgemein

aforms ist ein Unternehmen spezialisiert auf die Erstellung und Verwaltung von digitalen Formularen für E-Government und E-Business. Mit der Software AFS können Behörden und Unternehmen mehrsprachige, barrierefreie und standardkonforme Formulare ohne Programmierkenntnisse erstellen – online, mobil oder als PDF.

Links

• Webseite von aforms

• Formularerstellung mit aforms

Integration

Die folgende Anleitung zeigt Dir, wie Du Payrexx im AFS-Designer von aforms solutions & services einbindest.

Bitte beachte, dass die Integration in aforms nur in den Preisplänen Standard und Premium verfügbar ist. Weitere Informationen

Konfiguration von Payrexx

Bitte beachte, dass Du bei Payrexx eingeloggt sein musst, bevor Du beginnst. Falls Du noch kein Konto hast, registriere Dich bitte bei Payrexx.

• Navigiere im Hauptmenü Deiner Händler-Administration zu API und Integrationen.

• Scrolle hinunter zu "API-Integration hinzufügen" und klicke auf "API-Schlüssel hinzufügen":

Hinzufügen eines API-Schlüssels für die Integration von aforms

• Gib der Integration einen beliebigen Namen, zum Beispiel "aforms".

• Klicke auf "Hinzufügen":

Klick auf "Hinzufügen", um den API-Schlüssel zu generieren

• Du findest den neuen API-Schlüssel nun unter "Aktive Integrationen".

• Klicke auf "Kopieren", um den API-Schlüssel in die Zwischenablage zu kopieren. Du wirst ihn in einem späteren Schritt benötigen:

Kopieren des API-Schlüssels in die Zwischenablage für die spätere Verwendung in aforms

Konfiguration von aforms

Formserver Property

• Navigiere im AFS-Designer zu Administration > Ressourcen:

Start der Konfiguration im AFS-Designer

• Suche in der Ressourcenliste eine Formserver-Property oder erstelle mit dem Plus-Symbol eine neue:

Erstellen einer Formserver-Property

• Trage deine Properties ein und speichere mit dem Haken-Symbol:

Eintragen der Properties

Beispiele Formserver-Property:

# Payrexx-URLcom.anecon.afs.common.extender.payrexx.url=

Erster Teil (bis zum ersten Punkt) der URL der Payrexx-Administration:

https://aforms2web.payment...com.anecon.afs.common.extender.payrexx.instanceId=xxx

Default API-Key aus der Payrexx-Administration:

com.anecon.afs.common.extender.payrexx.secret=xxx

Ersetze "xxx" mit dem API-Schlüssel, den Du während der Konfiguration von Payrexx in die Zwischenablage kopiert hast.

Währung:

com.anecon.afs.common.extender.payrexx.currency=xxx

Formular, Seite und Block

• Navigiere im Menü zu Formulare und erstelle über das Plus-Symbol ein neues Formular:

Erstellen eines neuen Formulars

• Gib den Formularnamen, die General-ID und die Beschreibung des Formulars ein:

Konfiguration des Formulars

• Lege eine neue Formularseite an, fülle die entsprechenden Felder aus und speichere Deine Einstellungen:

Konfiguration der neuen Formularseite

• Erstelle innerhalb der angelegten Formularseite einen neuen Block:

Erstellen eines neuen Blocks

• Füge dem neu erstellen Block die erforderlichen Felder hinzu:

Konfiguration des Blocks

• Erstelle das Layout des Blocks automatisch per Klick auf das Tabellen-Symbol, benenne die Feldnamen und Leittexte für das Layout und speichere den Block:

Erstellen des Layouts für den Block

• So sieht der angelegte Block aus:

Anzeigen des Blocks

• Platziere den neu erstellten Block auf der ersten Seite des Formulars:

Platzieren des Blocks

• Speichere die Seiten- und Formulardetails per Klick auf das Haken-Symbol. Formular, Seite und Block sind nun bereit für die Anbindung an Payrexx.

Erstellen und Konfigurieren des Extenders

Mit dem Payrexx-Extender kannst Du den Nutzern des Formulars die Möglichkeit bieten, direkt beim Absenden eine Zahlung vorzunehmen. Die Kommunikation zwischen AFS und Payrexx erfolgt über REST-Webservices. Diese Funktion steht Dir auf Formularebene zur Verfügung.

• Erstelle mittels Klick auf das Plus-Symbol einen neuen Extender auf Formularebene:

Erstellen eines Extenders

• Wähle in der Auswahl der Extender die Option "Formular: Payrexx":

Erstellen eines Extenders vom Typ "Formular: Payrexx"

• Konfiguriere den Extender gemäss Deinen Anforderungen und speichere ihn per Klick auf das Haken-Symbol:

Konfiguration des Extenders

• Mittels der Bedingung =#V1=="1" (SpeL-Ausdruck) wird der Extender nur ausgeführt, wenn im Formular die Zahlungsmethode "Kreditkarte" gewählt wurde:

Ausführung des Extenders auf Bezahlart "Kreditkarte" beschränken

• So sieht die Auswahl der Zahlungsmethode im Formular aus:

Auswahl der Zahlungsart

Bitte beachte, dass die Zahlungsart "Kauf auf Rechnung" immer angezeigt wird.

• Über den Formularbaum können die Felder im Extender zugeteilt werden:

Zuteilung der Felder im Extender

Verwendung der Felder:

• Zahlungsvermerk: Der Zahlungsvermerk setzt sich aus der Reference-ID und dem Formulartitel zusammen und dient der Identifikation der Zahlung in der Inbox/APF.

• Reference-ID: Die Reference-ID ist eine Unique ID, über die die Zahlung identifiziert werden kann.

• Betrag: Transaktionsbetrag

• Vorname: Vorname des Antragstellers

• Nachname: Nachname des Antragstellers

• E-Mail-Adresse für Zahlungsbestätigung: An diese E-Mail-Adresse werden die Rechnung und die Zahlungsbestätigung versandt.

Verwendungszweck in der Rechnung (Produktbeschreibung):

Rechnung mit Verwendungszweck (Produktbeschreibung)

Formularsammlung übertragen

• Mit einem Klick auf das Pfeilsymbol wird die Formularsammlung an den Formserver übermittelt und dadurch online verfügbar gemacht:

Übermittlung der Formularsammlung an den Formserver