¶ Paymentus
Contents:
¶ Installation
You can install the Paymentus add-on in two methods: via the CLI or the Web UI of your Splynx server.
To install it via CLI, the following commands can be used:
apt-get update
apt-get install splynx-paymentus
To install the add-on via the Web UI, navigate to Config → Integrations → Add-ons:
Locate or search for the splynx-paymentus add-on and click the Install icon in the Actions column:
Click the OK, confirm button to begin the installation process:
¶ Configuration
After the installation process, configure the add-on in Config → Integrations → Modules list:
Locate or search for the splynx_addon_paymentus add-on and click the
Edit (Config) icon in the Actions column:
Make sure the entry points for the Customer portal are enabled:
¶ Billing settings
-
Credit card payment account - select the payment account for credit cards;
-
Direct debit payment account - select the payment account for direct debits;
-
Payment method - select the payment method;
-
Bank statements group - select how payment statements should be grouped: by month or by day.
¶ Paymentus settings
After registering on the Paymentus platform, you can obtain all the necessary credentials to complete the configuration section.
- Paymentus domain - used to process payments (must include a trailing slash);
- TLA - a code used to identify a specific customer deployment;
- Payment type - the default payment type for Splynx;
- Encryption key - used to create and edit payment methods;
- JWT key - used to make payments;
- Access token - a token required to authorize requests to the system;
- Use PIN code - enables/disables the requirement to enter a PIN code for all incoming requests from Paymentus.
¶ Adding payment details
Customer payment details can be added through both the Admin portal (in the Billing config on the customer’s profile) and the Customer portal (under Finance → Paymentus payment credentials).
Admin portal
Customer portal
¶ Credit card
On the Customer portal, click the Add and allow future charge button for your credit card:
In the form that appears, enter the required credentials:
The credit card has been saved:
¶ Bank account
On the Customer portal, click the Add and allow future charge button under the Bank account block:
In the form that appears, enter the required credentials:
¶ PIN code
To change the default PIN code, click the Edit PIN code button on the Customer portal:
¶ Balance top-up
Customers can top up their balance from the Dashboard using the Pay by button:
For example, if you have your credit card saved, click Pay by your credit card.
If the payment is successful, the following message will appear:
