Integrapay

Integrapay is a Splynx add-on which allows customers to pay for invoices via the payment gateway - https://www.integrapay.com.au/.

The add-on can work with various credit cards and bank accounts, if cards or bank account are saved in customer profiles, the add-on allows you to charge all customers using Direct debit orders.

Add-on installation

The add-on can be installed in two methods, via the CLI or Web UI of you server.

To install the Splynx-Integrapay add-on via CLI, the following commands can be used:

apt-get update
apt-get install splynx-integrapay

To install it via the Web UI:

Navigate to Config → Integrations → Add-ons:

(image)

Locate or search for the splynx-integrapay add-on and click on the Install icon in the Actions column, you will be presented with a window to confirm or cancel the installation, click on the OK, confirm button to begin the installation process.

(image)

(image)

Add-on settings

The first step is to register an account on https://www.integrapay.com.au/. After registering, Integrapay will send you an email with your credentials, where Bussines ID is your Username and Api User Key is your Password :

(image)

Then, you need to set your Username, Business ID and Password in IntegraPay API settings section of add-on config page, navigate to Config → Integrations → Modules list and locate or search for the splynx_addon_integrapay add-on module and click on the edit (Edit) icon in the Actions column, enter your credentials in the related fields.

(image)

(image)

Main information and API settings:

(image)

  • API domain - api domain should be the same as Splynx URL. The forward slash / is required at the end;

  • API key, API secret - auto generated default values. Don't change it unless it is absolutely necessary.

IntegraPay billing settings:

(image)

  • Ignore Fee - ignore IntegraPay fee;
  • Fee VAT - service fee VAT percent;
  • Add fee to request - add fee (position) to request;
  • Fee message - if Add fee to request option is enabled, the current message will be added as description for fee item in invoice;
  • Payment method for Credit Card / Bank Account - when a customer pays using this add-on, the payment will be allocated as this payment type;
  • Transaction fee category - transaction category of the fee transactions;
  • Bank statements group - choose how to group bank statements (Finance → Payment Statements → History) monthly or daily;
  • Available Payment Methods - choose a payment method that the customer can add on Portal. Pay attention, IntegraPay service does not support using two payment methods at the same time. If 'Bank account or Card' option is selected, a customer can add either their bank account or a credit card and use only one method at a time;
  • Mask card's number and CVV - hide card number and CVV code when adding on the Portal;
  • Customers identifier - select what to use as identifier of customer on IntegraPay service side;
  • Sending email with terms - enable/disable the email sending with terms and conditions of the service to customers;
  • Subject of email with terms - subject of the email with terms and conditions of the service;
  • Message of email with terms - message of the email with terms and conditions of the service;
  • Top-up for admins - enable/disable the form to refill customer account balance on their billing configuration page (only for administrators in Splynx, see the example below).
Example

Navigate to customer billing configuration page (Billing/Billing overview) and in Payment accounts section click on Refill balance icon near Integrapay item.

(image)

If the payment credentials are not added by the customer, the administrator can add them from this form. Pay attention, only one payment method can be used.

(image)

If the payment credentials are added by customer, e.g. credit card but Top-up for admins option is disabled on add-on configuration page, the administrator will see the next message

(image)

If the option Top-up for admins is enabled on add-on configuration page, the administrator can top up the customer's balance, the saved payment method will be used.

(image)

(image)

Moreover, when the credit card or bank account is added by customer as a payment method, the administrator can remove them using the top-up form on the customer's billing configuration page.


IntegraPay API settings:

(image)


The configuration of add-on Entry points can be found in Config → Integrations → Modules list, near the splynx_addon_integrapay module item in Actions column, click on the (Edit entry points) icon.

(image)

More information about Modules list can be found here.

Invoice payment

Before making any payment it's required to add the bank account or the credit card, depends on what option customers would like to use to pay.

Also, it's necessary to enable the related entry points for IntegraPay add-on in Config → Integrations → Modules list.

After that a customer can login on Portal, navigate to Finance → IntegraPay payment credentials and type the required credentials

(image)

(image)

(image)

Once the configuration has been completed, customers can pay their invoices on Portal,

using the IntegraPay icon (the related entry point should be enabled) in Finance → Invoices:

(image)

(image)

IMPORTANT: the Service Fee value cannot be set on add-on config page, as a result, will be shown only Total to pay amount.

(image)

or pay directly on Portal Dashboard (the related entry points should be enabled):

(image)

(image)

If everything goes well, a customer will see the status of the invoice marked as Paid.

(image)

Customers can also refill their balances using Add money via Integrapay menu on Portal Dashboard (integrapay_add_money_on_dashboard entry point should be enabled, it will work only for customers in Splynx).

(image)

(image)

Additionally, an administrator can charge all customers using one button, navigate to Finance → Invoices, set the period and click on Charge button as depicted below:

(image)

(image)

The Charge history tab contains the charge history of all charges you have made, sometimes it is very helpful when there are finance issues.

Add-on log files

IntegraPay add-on logs can be found in Administration → Logs:

(image)

In Integrapay Logs the different records can be viewed and its response details etc.

(image)

Direct payments

Using the payments links is the simplest way to accept payments made with credit card or bank account. This feature is available in the IntegraPay add-on to pay Invoices and Proforma Invoices. This provides convenience and simplicity for your customers, so the amount of on-time payments will increase. For example, you can add a payment link to the e-mail with the (proforma) invoice, as a result, the customer can make payment quickly by clicking onto such link instead of logging in to their Portal page. In case the customer has saved the payment credentials on the Portal, they do not need to add further details when using the direct payment link in the future. If the credit card in not linked on the Portal, the payment details 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>/integrapay/direct-pay-invoice-by-id?item_id=<invoice_id>

by invoice number
https://<splynx_domain_address>/integrapay/direct-pay-invoice?item_id=<invoice_number>


To pay the Proforma Invoice:

by proforma invoice ID
https://<splynx_domain_address>/integrapay/direct-pay-proforma-by-id?item_id=<proforma_id>

by proforma invoice number
https://<splynx_domain_address>/integrapay/direct-pay-proforma?item_id=<proforma_number>