Moneris is a Splynx add-on used to pay invoices and proforma invoices with the Moneris Payment Gateway.
The add-on can be installed in two methods, via the CLI or the Web UI of your Splynx server.
To install the add-on via CLI the following commands can be used:
apt-get update apt-get install splynx-moneris
To install it via the Web UI
Config / Integrations / Add-ons
Locate or search for the
splynx-moneris add-on and click on the install icon the Actions column, you will be presented with a window to confirm or cancel the installation, click on confirm to begin the installation process:
After the installation process has completed, the add-on should be configured.
Config / Integrations / Modules list,:
Locate or search for the
splynx-moneris add-on and click on the
- API domain - your Splynx URL (with last slash);
- API key / API secret - the auto generated values in Splynx. Do not change these values unless it is particularly necessary;
- Splynx URL - your Splynx URL (without last slash);
- Payment account - the account that will be used in customer's profile, by default it's Moneris;
- Payment method - when a customer pays by using this add-on, this will be the payment type;
Group of bank statements - how to group the bank statements (
Finance → Payment Statements → History) monthly or daily;
Service fee to: Payee value - customer won't pay Additional service fee. Additional service fee value - customer will pay Additional service fee specified in the next field;
Additional service fee - if Service fee to option is set to: Additional service fee, you have to specify the additional service fee percent value in the current field, it will be used instead Moneris real fees, for example 5.9 would mean 5.9%;
Fee message - the Additional service fee description. The default value is Moneris commission;
Fee VAT - the VAT of Additional service fee in percent. Will be included into the service fee;
- Transaction fee category - transaction category of the Additional service fee.
In case in Splynx system is used the multiple partners scheme, you can divide Moneris configuration between them. Create a new partner in Splynx, in Moneris config select the necessary partner and set the required settings.
Note: The fields marked with
* sign have the different values from original ones (original values are related to Default partner).
- Select Country - the country to choose;
- Select payment currency - the currency to choose;
- Store Id, API token, HT Profile ID - these values you can find in Moneris portal.
The configuration of add-on Entry points can be found in
Config → Integrations → Modules list, near the
splynx-moneris module item in Actions column, click on the
By using Entry points, you can enable add-on features which can allow customers to pay for (proforma) invoices, pay directly from Portal Dashboard or add money to the balance from Dashboard.
After the successful configuration of the add-on, customers can pay for their invoices using the Moneris gateway in
Finance → Invoices on the Portal.
The credit card can be added in
Finance → Credit card via Moneris gateway section of the Portal.
After the credit card was added successfully, the customer can pay the invoices in
Finance → Invoices or the proforma invoices in
Finance → Proforma Invoices
If everything goes well, you will see the status of invoice marked as
Paid (on the customer and admin portal).
On the customer Portal Dashboard, customers can also see the list of non-paid invoices in Moneris widget (entry point) and the same-name buttons to pay such invoices. Moreover, using the Add money by Moneris widget on the Dashboard the customer can refill the account balance.
Using the payments links is the simplest way to accept payments made with credit card. This feature is available in the Moneris addon to pay Invoices and Proforma Invoices. This provides convenience and simplicity for your customer, so the amount of on-time payments will increase. For example, you can add a payment link to the email with the (proforma) invoice, as a result, the customer can make payment quickly by clicking onto this link instead of logging in to their Portal page. In case the customer has saved the card details 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
by invoice number
To pay the Proforma Invoice:
by proforma invoice ID
by proforma invoice number