GoCardless integration

​

Integration setup

​

Connect your GoCardless account

To connect to GoCardless through the user interface:

1. In the side menu, select “Settings”;
2. Open the “Integrations” tab;
3. Click “GoCardless” to create a connection;
4. Give a name to this connection;
5. Assign a code for easy identification;
6. Click on “Connect to GoCardless” to be redirected to the GoCardless application;
7. Create a GoCardless account or log in to your existing account; and
8. Connect your account to be redirected to the Lago application.

When the OAuth connection is active, you will see the screen below, with your secret key.

Active OAuth connection with GoCardless

​

Create webhook endpoints

If you want Lago to automatically retrieve the status of the payments processed via GoCardless, you must create a webhook endpoint in GoCardless. To do so:

1. Log in to your GoCardless account;
2. Go to the “Developers” section;
3. In the upper right corner, click “Create” and then select “Webhook endpoint”;
4. Choose a name for this webhook (e.g. Lago);
5. Enter the following URL: https://api.getlago.com/webhook/gocardless/{id} (you must replace {id} with your Lago organization ID);
6. Enter your secret key; and
7. Click “Create webhook endpoint”.

Webhook endpoint creation in GoCardless

In addition to this, you must create a webhook endpoint in Lago to retrieve the checkout URL associated with each customer account (learn more). To do so:

1. Go to the “Developers” section of the Lago application;
2. In the “Webhooks” tab, click “Add a webhook” on the right;
3. Enter your webhook URL; and
4. Click “Add webhook” to confirm.

For more information about our webhooks, please refer to the API documentation.

​

Redirect url after checkout

After establishing the connection with GoCardless, set a success URL where your end customer will be directed after completing the checkout. Please note that if it’s not defined, your end customer will be redirected to GoCardless’s website.

Please note that you can edit or delete the redirect URL, and this will only affect new checkout URLs created.

​

Customer information

To collect payments automatically, the customer must exist in both the Lago and GoCardless databases.

​

New customer

If the customer does not already exist in GoCardless, you can first create them in Lago, either via the user interface or the API. When adding customer information, you must:

1. Provide the customer’s email address;
2. Define GoCardless as the default payment provider;
3. Select the GoCardless connected account;
4. Leave the field associated with the GoCardless customer ID blank; and
5. Enable the option to automatically create the customer in GoCardless.

The customer will automatically be added to GoCardless. GoCardless will then return the customer ID, which will be stored in Lago.

Creation of a new customer with GoCardless

When the customer is successfully created, you will receive two webhook messages:

• customer.payment_provider_created that confirms the creation of the customer in GoCardless; and
• customer.checkout_url_generated that includes the checkout URL to set up the direct debit (learn more).

​

Existing customer

If the customer and direct debit mandate already exist in GoCardless, then you should create the customer record in Lago, either via the user interface or the API. When adding customer information, you must:

1. Provide the customer’s email address;
2. Define GoCardless as the default payment provider;
3. Select the GoCardless connected account;
4. Provide the GoCardless customer ID; and
5. Disable the option to automatically create the customer in GoCardless.

Migration of an existing GoCardless customer

​

Direct debit

To collect payments via direct debit, a mandate must be created. To do so:

1. Retrieve the checkout URL included in the customer.checkout_url_generated webhook; and
2. Redirect your customer to the checkout page, so that they can complete the online form and approve the mandate.

The mandate must be validated by GoCardless before the first payment can be processed. It can take up to six business days to validate a new mandate. For more information about payment timings, please consult the GoCardless FAQ.

Direct debit setup with GoCardless

Each time a new invoice with an amount greater than zero is generated by Lago, a payment will automatically be created. GoCardless will record the invoice ID and process the payment. Payments via direct debit are usually processed within five business days. If the payment is successful, the status of the payment will switch from pending to succeeded.

If the payment fails, the status of the payment will switch from pending to failed and Lago will generate an invoice.payment_failure webhook.

​

Regenerate checkout link on demand

In cases where your end customer has not had the opportunity to complete the checkout process to inform their payment method or wishes to modify the saved payment information, you can generate a new checkout link using the designated endpoint.

POST /api/v1/customers/:customer_external_id/checkout_url

Upon successful generation, the new checkout link will be available in the endpoint response, and it will not be delivered through a webhook message. It is important to note that the new link will inherit the same expiration setting as the original one.

It is crucial to be aware that if a customer is not associated with any payment provider, the response will contain an error message.