GoCardless api key & connect

To enable your GoCardless integration to make requests to the Utilmate API, you'll need to create an access token (API Key).  This token is required when you connect to GoCardless in Utilmate  (Maintenance menu, System Configuration and select Add On's).

Tip: An access token is a unique identifier that is passed between computer programs allowing them to communicate with each other.  When a request is made, GoCardless matches the token you entered in Utilmate to the one GoCardless has stored, in order to authenticate and identify the requestor and ensure that they have the appropriate permissions.

How to create an access token (API Key)

Go to the GoCardless portal and log in (you will require your GoCardless account credentials) and navigate to the Developers tab.

Click the Create button in the top-right of the screen and select Access token from the dropdown list.

Within the Create access token window, give your token a name, ensure "read-write access" is selected, and then click Create access token. 

Your token has been created and is now active.   This new token needs to be entered into your GoCardless Connect screen in Utilmate.

Important: You'll need to copy this access token from this screen as GoCardless may not be able to show this again to you.

Enter access token (API Key) into Utilmate

To connect and enter your access token (API key), log into Utilmate and go to the Add On's screen in the Maintenance menu, System Configuration.  Click on the GoCardless button.

Click on the connect button.

Paste your access token (API key) into the API key field and click connect.  Success!  You've now connected to GoCardless and can start taking payments.