Sitekit Payengine Modul

The Payengine module is an interface between Sitekit and external payment providers. Currently, only EPay21 is supported. But more can follow. The module offers the possibility to integrate payments in the form editor or to process payments for other modules (e.g. Shop module).

Configuration

After the module has been installed on a customer, it must be entered into the customer configuration. To do this, open the file ${customer}-module/src/main/webapp/WEB-INF/config/client/${customer}.json and add the module name modules.payengine to the list.

Enabling and disabling this Module

the module is activated by default. Using the option in the sectionTypes.json, the feature can be disabled for individual clients.

{
	"formEditor": {
		"options": {
			"payengine": {
				"enabled": true
			}
		}
	}
}

Formular Editor Payment

In order to make a payment in the form editor, a landing page is needed. This page must be located in the service group. The configuration for the interface must be stored in the article. Thereby the article fulfills two tasks:

  • in the Infosite the access data for the interface are deposited
  • on the website the landing page component controls the payment process

With this module, there is now an “Online payment” section in the form editor in addition to the e-mail settings. If the checkbox “Enable payment process for this form” is activated, the payment process will be executed before the email is sent. However, the further configuration is still needed for this.

  • A link to the landing page to select the payment provider and configuration.
  • The amount to pay
  • a payment method that will be specified in the booking
  • a prefix for the booking key

With the payment process enabled, the user will be redirected to a payment page after submitting the form. On this page the payment method is selected. Which are available depends on the payment provider and its configuration. Once the payment has been made, the user is redirected back to the landing page. If the payment verification was successful, the email is sent and the user is redirected back to the form page.