Getting Started with the GoCardless Payment Gateway
GoCardless is a payment gateway available in Europe and in the UK that allows for Direct Debit payments.
The WP Ultimo: GoCardless Gateway adds GoCardless support to WP Ultimo, allowing you to charge your customers in that region using Direct Debit.
This tutorial will cover how to setup GoCardless to start accepting payments through it on your WP Ultimo network.
Note: GoCardless only works with the following currencies: EUR, GBP, AUD, SEK, and DKK.
Installing the Add-on
First of all, you'll need to install the GoCardless add-on for WP Ultimo. You can do that by going to WP Ultimo > Settings > Add-ons (on the sidebar). And picking the GoCardless add-on on that list.
After the add-on is installed and activated, go to WP Ultimo > Settings > Payments, toggle the GoCardless option, and save.
Getting an Access Token
Create an account on GoCardless (or on the GoCardless sandbox, if you want to test it first, which is recommended). Then, after logging in, navigate to the Developers menu item.
On the Developers page, click on the Create button at the top-right corner of the screen, then click on the option Access Token.
This will open a new modal window, allowing you to create a new token. Give it a recognizable name and make sure you select the Read-write access option in the Scope menu.
The access token will appear on the screen. Copy that over and paste it onto your WP Ultimo > Settings > Payments > GoCardless menu.
Be sure to place it on the right field. If it's a live token, toggle the sandbox mode off before pasting the token.
That's it for the first step. Next, you need to setup a webhook listener.
Setting up the Webhook Listener
When dealing with subscriptions, WP Ultimo needs to hear about changes in the subscription status, new payments being made, and other such things.
The way payment gateways notify WP Ultimo of those changes is using webhook calls. For that reason, in order for the integration to work 100%, we need to tell GoCardless which URL to call with all that info.
Go back to your GoCardless > Developers panel and click the Create button again, but this time, select the Webhook endpoint option.
A new window will open with the webhook endpoint options. It asks for the webhook URL, so head back to your WP Ultimo settings > Payments > GoCardless and copy the webhook URL listed in there:
Additionally, you can enter a webhook secret that will be used to sign your webhook calls. Whatever you enter on that field, you'll need to enter on the WP Ultimo Webhook Secret field as well.
Finish up by saving the endpoint by clicking the Create webhook endpoint button and then save your WP Ultimo settings as well.
You should be ready to accept GoCardless now!