How to setup GoCardless integration

Modified on Fri, 4 Jul at 4:59 PM

This guide explains how to set up and use the GoCardless integration features within Gumtrue for automated direct debit collections.

1. Open a GoCardless Account

Before integrating with Gumtrue, you must apply for and open an account with GoCardless.

2. Linking your GoCardless to Gumtrue

2.1 From the Main Menu, go to Control Panel - Gocardless. Get the API access token from your GoCardless account, and from the GoCardless dashboard on Gumtrue, select more options - API Access Token then paste it.

3. Link your customer's GoCardless information to Gumtrue

3.1 From Customer Dashboard, on the Menu bar, select Integrations then Gocardless.

3.2

A. Fill in any of the first three fields as shown in the image below,

Email Address

Customer ID (from GoCardless)

Mandate ID (from GoCardless)

B. The system will retrieve and display customer details (name, company, etc.) from GoCardless, and will add the customers mandate into Gumtrue.

C. To remove a mandate, use the Delete option in the same window.

NOTE:

Only customers with valid mandates in Gumtrue can be included in bulk payment actions.

4. Exporting and Importing customer balances

Mandates List - Shows customers linked to GoCardless, based on the information you entered and saved in Step 2. The mandate reflects these linked details.

1. Export Customer Balances

Generates an Excel file that can be used in GoCardless for initiating payment collection from customers who are linked.

2. Add Balances as Payments

After importing the file into GoCardless, click this button to automatically add the exported balances as payments. These payments will then be available for acceptance through mobile collections.

Mandates created via the dashboard are immediately usable for exports or bulk payment updates.