Paypal payments

You can receive payments via PayPal using Splynx. Splynx generates invoices for services that are sent to customer’s email and to the Splynx customer portal. From the customer portal, customer can pay for their invoices using Paypal.


When a customer clicks on the PayPal button and applies to pay now, he is redirected to the PayPal page to make the payment.

Customers can also add a credit card on the PayPal payment webpage, if they don’t have a PayPal account.

Add card

After payment has been made, the invoice is marked as paid, a transaction is created in Splynx and the customer’s balance is changed.

There are several steps needed to configure the Splynx PayPal add-on. The add-on can be installed in two methods, via the CLI or the Web UI of your Splynx server.


To install the "splynx-PayPal" add-on via CLI, the following commands can be used:

apt-get update
apt-get install splynx-paypal

To install it via the Web UI:

Navigate to Config → Integrations → Add-ons:


Locate or search for the "splynx-paypal" add-on and click on the install icon in the Actions column, you will be presented wwith a window to confirm or cancel the Installation, click on confirm to begin the Installation process:


Activate the developer’s tool in your PayPal account.

Obtain the access to your business PayPal account on the following website:

The ClientID and ClientSecret are the values Splynx needs to configure the add-on. Click on Add new Rest API application and call it Splynx.


Thereafter, you can find the ClientID and Secret on the application page. It is important to choose the “Live” version, because it shows the values for the test Sandbox account by default.


When you have obtained the ClientID and Secret, you can insert it into your Splynx server and connect Splynx with PayPal.

Configure Splynx to work with your PayPal account.

Once the add-on has been installed and all details from PayPal has obtained, we can proceed to configuring the add-on.

Navigate to Config/Modules/List and click on the edit button of the Splynx PayPal addon:


You can find Common settings and Partners settings in this section:

Common settings Common settings

Each partner can use different settings

On this page you can also enable widgets for the customer portal. Click on the "Entry points" button:

Common settings

First widget(Point) configuration: Enable widget

Point 1 on customer portal page: Common settings

Second widget(Point) configuration: Enable widget

Point 2 on customer portal page: Common settings

NOTE: Point 2 will only be visible for customers using the Prepaid (Daily) type of billing

Paying for invoices with PayPal:

On customer portal page navigate to Finance/Invoices select a unpaid invoice and click on the "pay with PayPal" button

Pay invoice Pay invoice

You can allow customers using the Prepaid (Monthly) billing type to use the last widget available. To achieve this, the code has to be modified. Replace if customer.billing_type == 'prepaid' to if customer.billing_type == 'prepaid_monthly' or customer.billing_type == 'prepaid':