GoCardless Module

Collect one-off payments straight from your client's bank account with GoCardless, on a mandate the client authorises once.

Reaching the Screen

Go to Settings → Financial → Payment Gateways, open All Modules and click the GoCardless card: {admin}/modules/payment?module=GoCardless

Ticking Status and saving lists the method on the payment step. Use Payment Gateways to order the methods clients see.

What Is on the Screen

The card holds your access token, the sandbox switch, the webhook secret and the shared gateway settings.

GoCardless collects by direct debit. The client is sent to a GoCardless page and authorises a mandate on their bank account once; later payments reuse that mandate without asking again.

A bank debit is not instant. The payment is created as pending and the invoice waits at Payment Pending. In the current version the confirmation from GoCardless does not settle the invoice; you mark it paid yourself, see Tasks. Refunds go through your GoCardless dashboard. Stored cards, automatic payments from a saved card and installments are not supported.

Before You Configure It

• A GoCardless account. Testing needs a separate sandbox account, opened at manage-sandbox.gocardless.com.
• An access token created under Developers → API settings in that same environment. Only an administrator can create one.
• A webhook endpoint created in the same account, so you have a secret to enter here.
• A currency and client country GoCardless supports for direct debit. If your install prices in another currency, set Converting Currency.

Fields

Commission, converting currency, accepted amount range and country lists behave the same on every gateway; see Payment Gateways. Callback URL, Success URL and Failed URL cannot be edited; the callback address is the one you register as a webhook.

Tasks

Connect your GoCardless account

1. In your sandbox dashboard open Developers → API settings, click Create in the top right and choose Access token. Name it, give it read-write access and copy it: the token is shown once.
2. Open the GoCardless card under All Modules and tick Status.
3. Paste your sandbox token into Access Token and tick Sandbox Mode.
4. Click Save Changes. The method now appears on the payment step.

Register the notification address

1. Copy the Callback URL from the module card.
2. On the GoCardless Developers page click Create → Webhook endpoint, paste that address as the URL and name the endpoint.
3. Open the new endpoint in the list and copy its secret into Webhook Secret, then click Save Changes. GoCardless sends every event; this module reads payments events with the action confirmed.
4. In the current version the notification cannot be matched to the invoice, so it does not close the invoice yet; see the next task.

Run a test payment

1. Place a small order as a client and choose GoCardless on the payment step.
2. Complete the mandate on the GoCardless page with its test bank details.
3. The client returns and the payment waits for clearance; the invoice moves to Payment Pending meanwhile.
4. Once the sandbox shows the payment as confirmed, open the invoice in Invoice Detail and mark it paid. That activates the order.

Refund a payment

1. Open the invoice from Invoice Detail.
2. Set its status to refunded, choose Add as expense or Add as account credit as the refund method and confirm. An invoice you marked paid yourself has no payment record behind it, so Refund via payment gateway has nothing to send.
3. Return the money from your GoCardless dashboard.

Things to Watch

Required Privileges

Payment Module Settings (MODULES_PAYMENT_SETTINGS) is required.

Related Articles

• Payment Gateways
• Invoice Detail