Difference between revisions of "GoCardless"

Revision as of 16:11, 19 December 2018

Supported Features

Type	One Time	Recurring	Refunds	Reversals
3rd Party	Yes	Yes	No	No

This page describes a feature available in version 7.7 and above

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

Setup

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.

No Configuration Required

There is no configuration required for the GoCardless Payment Module. All the fields will be filled automatically when redirected back to the WHMCS installation.

Supported Currencies

GoCardless only support the following currencies: 'AUD', 'CAD', 'DKK', 'EUR', 'GBP', 'NZD', and 'SEK'. Any clients not using one of these currencies will be unable to make a payment using GoCardless and will receive an appropriate message.

Convert to for Processing

We advise against using a convert to currency for GoCardless. The currency and address of the client determine which bank payment scheme the client will need to use. For example, a UK address would be required for a payment in GBP using the BACS payment scheme.

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

@@ Line 1: / Line 1: @@
 {{gateways
-| type = token
+| onetime = yes
 | recurring = yes
 }}
-<div class="docs-alert-danger">
+<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.7 and above</div>
-<span class="title">Module Discontinued</span><br />
-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.
-</div>
-[http://gocardless.com GoCardless] is a UK payment gateway which allows for direct debit payments to be automated electronically.
+[https://gocardless.com GoCardless] is a payment gateway which allows for direct debit/ach 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.
+To activate the GoCardless module in WHMCS, navigate to '''Setup''' > '''Payments''' > '''Payment Gateways''' and choose GoCardless from the All Payment Gateways tab.
-Once activated, you can then customise the name to something more friendly such as "Direct Debit" and enter the configuration details.
+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.
-===Instant Activation===
+===No Configuration Required===
-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|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.
+There is no configuration required for the GoCardless Payment Module. All the fields will be filled automatically when redirected back to the WHMCS installation.
-===One Off Only===
+==Supported Currencies==
-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.
+GoCardless only support the following currencies: 'AUD', 'CAD', 'DKK',  'EUR',  'GBP', 'NZD', and 'SEK'. Any clients not using one of these currencies will be unable to make a payment using GoCardless and will receive an appropriate message.
-==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==
-[[File:InvoiceScreen.PNG|thumb|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|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.
+===Convert to for Processing===
+We advise against using a convert to currency for GoCardless. The currency and address of the client determine which bank payment scheme the client will need to use. For example, a UK address would be required for a payment in GBP using the BACS payment scheme.
 {{modules}}

Documentation