¶ Paymentus
Contents:
- Installation
- Configuration
- Adding payment details
- Balance top-up
- Charging invoices
- Payment refunds
- Direct payments
¶ 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:
¶ Charging invoices
- On the Finance → Invoices page, set the period and click the
Chargebutton:
- Select paymentus as the External handler in the Invoices tab, and then click the
Nextbutton:
- Then toggle the
Confirm chargeswitch to enable it, and click theCharge buttonto complete the process:
¶ Payment refunds
Payments made with Paymentus can be refunded to the customer with the Refund button:
Then, a credit note will be generated for the refunded amount, and the refund will be processed immediately.
If the payment has already been refunded, you will receive a warning message.
¶ Direct payments
Using payment links is the simplest way to accept payments made with a credit card or bank account. This feature is available in the Paymentus add-on for paying Invoices and Proforma Invoices.
It provides convenience and simplicity for your customers, leading to an increase in on-time payments. For instance, you can include a payment link in the email containing the (proforma) invoice. As a result, customers can quickly make payments by clicking on the link instead of logging into their Portal page.
If customers have saved their payment credentials on the Portal, they won't need to provide further details when using the direct payment link in the future. However, if the credit card is not linked on the Portal, the payment details will need to be entered each time the payment link is used.
To create a direct payment link, please use the patterns below:
To pay the Invoice:
by invoice ID
https://<splynx_domain_address>/paymentus/direct-pay/invoice?id=<Invoice_id>
by invoice number
https://<splynx_domain_address>/paymentus/direct-pay/invoice?number=<Invoice_number>
To pay the Proforma Invoice:
by proforma invoice ID
https://<splynx_domain_address>/paymentus/direct-pay/proforma-invoice?id=<proforma_id>
by proforma invoice number
https://<splynx_domain_address>/paymentus/direct-pay/proforma-invoice?number=<proforma_number>