All you need to know to start using the Debitize WHMCS module

The Debitize WHMCS module allows you to automate debit order billing through Sage.

Prerequisites

Credentials

Sage Pay

  • Merchant Account Number as an 11 digit number
  • Service key in the format XXXXXXX-XXXXXXXXXXXXXX-XXXXXXXXXXXX
  • Username
  • Password
  • 6 digit PIN

Debit Orders

  • Service key in the format XXXXXXX-XXXXXXXXXXXXXX-XXXXXXXXXXXX

Risk Services

  • Service key in the format XXXXXXX-XXXXXXXXXXXXXX-XXXXXXXXXXXX

Sage Accounting Services

  • Account Reference
    This would be the Company Name
  • Identifier
    Consumer: SA ID number
    Commercial: Company registration number

IEDM WHMCS Module Service Key

Please contact IEDM for a service key.

Custom Direct Debit Module

Due to some issues2 retrieving banking details via the WHMCS internal API and to utilise advanced Sage bank validation3 it is required that you install the custom made Interexcel Direct Debit Module.

This is done in Setup > Payments > Payment Gateway.

Please make sure of the following:

  • that this gateway module is active
  • that “Convert To For Processing” is set to ZAR
  • that “Show on Order Form” is set to on

NOTE:
The module files should have been included in your .zip file.


Installation

You will receive the module as a simple .zip file.

  1. Unzip the archive and copy the files to the modules/addons/ folder of your WHMCS installation
  2. Go to Setup > Addon Modules
  3. Look for the Debitize module and click on Activate
  4. After successful activation, click on Configure
  5. Enter your SagePay Merchant Account Number and the Interexcel Service Key
  6. Also set the required Access Control

Configuration

Now that the module has been installed need to configure a few more settings.

On the Modules menu item you’ll see an Interexcel Module item. This is the main section where you will interact with the module.

The following sections are available:

  • Config: This is where you can configure various connection credentials and business rules.
  • Add Client Bank Details: You can manually add banking details (for debit orders) via this page.
    Unfortunately, due to limitations in the WHMCS API we cannot add this to the client profile at this stage.
  • Rules: Here you can configure some messages to be sent to a client when payments fails
  • Validation: Allows for the validation of customer ID numbers and bank account details.4
  • Batch Preview: Preview what will be submitted in the next batch
  • Sage Connected Services: View Sage accounting services. View and authorise batch files. Requires Sage Accounting Services settings to be set.
  • Debtor Services: Various Debtor Services

Config

General

WHMCS Cron Set
This is the cron job set up by the WHMCS core. If this is not set, please see: Setting Up Crons on WHMCS

Debit Orders

Check Mandate
If this is set to on, only clients who have the Has Mandate? option checked on their profile will be included in batches.

If set to off, all clients will be included in batches.

Include only active clients in the batch file?
If set to true, debit batches will only include invoices for clients whose ‘Status’ is ‘Active’.

Failed Fee Amount
The amount (either absolute ZAR value or percent) to deduct for each failed payment.
Leave blank if no fees should be charged.

Failed Fee Unit
Absolute: Will add a transaction for the value of the above "Failed Fee Amount"
Percentage: Will add a transaction equal to the value of the above "Failed Fee Amount in percent. I.e. an R100.00 failed transaction will be charged R10.00 if percentage = 10

Debit Order Type
Two Day: (Default) The batch will run in 2 business day from now. Cheapest.
Same Day: The batch will run today if submitted before 11:00 am.. More expensive than Two Day.

NOTE

For an explanation of the other configuration options, please see Credentials


 

FAQs

Question

Fatal error:
The encoded file /path/to/whmcs/modules/addons/interexcel_sage/init.php requires a license file.
The license file /path/to/whmcs/iesage-license is not valid for this server.

Answer

By default, we use domain names as restrictions and sometimes the script running the cron is not utilising the domain name. Please provide Interexcel with the IP address of the server that runs the cron.


Question

Why are some invoice’s status showing “Unrecognised“.

Answer

There is currently no way to natively set an invoice’s status to “Pending” within WHMCS.
What happens is when the Debitize Module submits an invoice via a batch upload, it sets the invoice status to “Pending” so that it can keep track of which invoices have been submitted and are awaiting reconciliation.

Once it reconciles the invoice the status will be set to either “Paid” or “Unpaid“.



  1. The current version of the debit order system does not allow for the processing of credit cards. This will be implemented in a future update.
  2. Please see issue #MODULE-6332 on bugs.whmcs.com
  3. This only verifies that the bank name, branch code and account number is in the correct format and that it is correct. It does not verify that the account belongs to a customer
  4. This only verifies that the bank name, branch code and account number is in the correct format and that it is correct. It does not verify that the account belongs to a customer
  5. NAEDO The current version of the debit order system does not allow for the processing of NAEDO orders. This will be implemented in a future update.

Was this answer helpful?

 Print this Article