GoCardless

From WHMCS Documentation

Revision as of 05:49, 18 June 2014 by John (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Supported Features

Type One Time Recurring Refunds 3D Secure
Token No Yes No No
Remote Update Card Remote Delete Card
No No

Module Discontinued
As of v5.3 this module has been discontinued and is no longer supported by WHMCS. This page remains in place for archive purposes and will not receive any further updates.

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

Error creating thumbnail: File missing
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).
  • The recurring authorisations are semi-flexible in that you can charge any amount below the total recurring cost. If clients upgrade to a more expensive product it would be necessary to cancel the existing agreement and have clients create a new one for the higher amount.

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.


Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin - VePortal
Lxadmin - Virtualmin Pro - XPanel - HyperVM - FluidVM - SolusVM - Cloudmin - WHMSonic - VPS.Net
CentovaCast - SCPanel - MediaCP - GameCP - TCAdmin - Reseller Central - Auto Release - Heart Internet

Registrar Modules
Enom - ResellerClub - Nominet - OpenSRS - ResellOne - OnlineNIC - PlanetDomain - Affordable Domains
TPP Wholesale - TPPInternet - Stargate - Namecheap - NetEarthOne - Bizcn - InternetBS - GMO Internet
12Register - Registercom - DotDNS - WebNIC - Dot.TK - HexoNet - Realtime Register - Registereu
RRPProxy - ResellerCamp - TransIP - Heart Internet - IPMirror - NetRegistry - OVH - VentraIP Wholesale
Email - 101Domain

Fraud Modules
MaxMind - VariLogiX FraudCall - Telesign

Gateway Modules
2CheckOut - AsiaPay - Auth.net Echeck - Authorize.net - Authorize.net CIM - Bank Transfer - BidPay
BluePay - BluePay Echeck - BluePay Remote - Boleto - CamTech - CashU - CC Avenue - ChronoPay
Cyberbit - Direct Debit - EEECurrency - E-Gold - EMatters - E-Path - eProcessingNetwork
eWAY Tokens - F2B - FastHosts - Finansbank - GarantiBank - Gate2Shop - LinkPoint
IMSP - Inpay - InternetSecure - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment
Merchant Partners - Merchant Warrior - IDEALMollie - Moneris - Moneris Vault
Skrill - SlimPay - My iDEAL - NaviGate - NETbilling - Netregistry Pay - NoChex - NTPNow
Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - Paymex - PayPal - PayPal Express Checkout - PayPal Payments Pro
PayPoint.net (SecPay) - Payson - Payza - Planet Authorize - SagePay - ProtX VSP Form - PSIGate
Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens - SecPay - SecurePay - SecurePay AU
Secure Trading - StormPay - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible