GoCardless
Contents
Supported Features
| Type | One Time | Recurring | Refunds | Reversals |
|---|---|---|---|---|
| 3rd Party | Yes | Yes | No |
Yes |
GoCardless is a payment gateway which allows for direct debit payments to be automated electronically.
Getting Started
To activate the GoCardless module in WHMCS, navigate to Setup > Payments > Payment Gateways and choose GoCardless from the All Payment Gateways tab.
Upon clicking, you will be redirected to link you account to WHMCS GoCardless App. On the page displayed, it is possible to sign-up for a new account or sign-in to an existing account. Once signed up, you will be redirected back to your WHMCS installation where you can customise the display name of the module.
Automatic Configuration
There is no configuration required for the GoCardless Payment Module. All the fields will be filled automatically when redirected back to the WHMCS installation.
For each supported currency and scheme enabled a custom name can be defined that will be displayed to clients wherever the available payment gateways are listed. This allows for naming that provides a more friendly and recognisable name based on the customers location, for example "Direct Debit" for UK/GBP customers, "ACH" for US/USD customers, etc...
Supported Currencies
GoCardless only support the following currencies: 'AUD', 'CAD', 'DKK', 'EUR', 'GBP', 'NZD', 'SEK', and 'USD'. Any clients not using one of these currencies will be unable to make a payment using GoCardless and will receive an appropriate message.
SSL Requirement
GoCardless requires an HTTPS secured connection for the WHMCS installation that customers will be returned to following setup of a mandate. If the domain your WHMCS installation is installed on does not have a valid SSL Certificate, the payment return will not work.
If you need to purchase an SSL Certificate, you can do so at www.whmcs.com/ssl-certificates
Payment Workflow
When the first payment is made, a mandate is set up with the client's bank. This typically takes a few days, so the invoice will change from Unpaid to Payment Pending status. At this point you can view the mandate details and expected payment completion date by viewing the invoice. As soon as the mandate is set up and the first payment has cleared, the invoice's status will change to Paid and the service will be provisioned by WHMCS automatically.
When the renewal invoice is generated for a recurring service, a capture attempt will be made against the mandate in accordance with your Setup > Automation Settings > Process Days Before Due setting. As it can take a few days for the payment to complete, we recommend a setting of 3. This way, 3 days before the invoice Due Date, the payment process will be initiated by the cron and the invoice status updated from Unpaid to Payment Pending. Payment should then complete on the invoice Due Date and the invoice will be marked Paid once the payment has cleared.
Reversed Payments
The Direct Debit Guarantee scheme allows the payee to file a claim for any payment taken in error. WHMCS will monitor for charged_back events from GoCardless and will automatically process these as appropriate.
To learn more, visit Payment Reversals
Reinstate Mandate
Permission Required:
Reinstating Mandates requires specific permission from GoCardless
When a mandate has been accidentally cancelled, WHMCS can initiate steps to reinstate the mandate without having the client set it up again. Navigate to Setup > Payments > Payment Gateways and click the Manage Existing Gateways tab. Click on the Manage Cancelled Mandates button and follow the instructions in the modal that appears to reinstate a cancelled mandate.
Import Existing Mandates
For mandates that have been setup outside of WHMCS, they can be imported and associated with a client. Navigate to Setup > Payments > Payment Gateways and click the Manage Existing Gateways tab. Click on the Import Existing Mandates button and follow the instructions in the modal that appears to import a active mandate to a specific client.
Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin
Lxadmin - Virtualmin Pro - XPanel - HyperVM - 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 - CashU - CC Avenue - ChronoPay - Direct Debit
EMatters - E-Path - eProcessingNetwork - eWAY Tokens - F2B - Finansbank - GarantiBank - Gate2Shop
Inpay - InternetSecure - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment - Merchant Partners
Merchant Warrior - IDEALMollie - Moneris - Moneris Vault - Skrill 1-Tap - NaviGate - NETbilling
Netregistry Pay - NoChex - Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - PayPal - PayPal Card Payments - PayPal Express Checkout
PayPal Payments - PayPal Payments Pro - PayPoint.net (SecPay) - Payson - Planet Authorize - ProtX VSP Form
PSIGate - Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens v2 - SecurePay
SecurePay AU - Secure Trading - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible