Revision as of 19:31, 11 July 2012

GoCardless is a UK payment gateway which allows for direct debit payments to be automated electronically.

Setup

To activate the GoCardless module in WHMCS, navigate to Setup > Payments > Payment Gateways and choose GoCardless from the Available Gateways dropdown.

Once activated, you can then customise the name to something more friendly such as "Direct Debit" and enter the configuration details.

Instant Activation

There is a delay of 2-5 days between payments being requested and the funds being collected, during this time the invoice will remain "Unpaid" in WHMCS (for more information refer to How it Works below). If you do not wish to wait and mark the invoice paid immediately then this option can be enabled. Please note that payment could still later fail in some circumstances.

One Off Only

Tick this option to only take a one-time payments via GoCardless, clients will need to login and manually pay each invoice manually. When unticked recurring payments will be possible.

Configuration

Within your GoCardless account navigate to the Developers tab and configure the following settings:

Redirect URI

http://path/to/whmcs/modules/gateways/gocardless/redirect.php

Web hooks URI

http://path/to/whmcs/modules/gateways/gocardless/callback.php

Replacing /path/to/whmcs with the location of your WHMCS installation. The Cancel URI setting can be left blank.

How it Works

Payment Pending in WHMCS

• When customers first sign up, a pre-authorization is created with them to pay for your service. CoCardless triggers any initial payments they need to make immediately.
• It takes 5 days for to collect a customer's initial payment, and until then the initial invoice will be marked as unpaid. Once collected, WHMCS will automatically change the invoice's status. (You can use the Instant Activation setting described above if you don't want to wait)
• For subsequent payments the process is the same but only takes 2 days (and no interaction with the customer is required, as they've pre-approved the payment).

Error Messages

Client is invalid

This means that you only have a sandbox account, a live account is required for use with this module. The live account signup link can be found on the payment gateways page within WHMCS.