Skip to main content

Adding GoCardless as a Payment Provider

  • Updated

Prerequisites

  • Set up a Client in mabdeck including Bank Account Details, Customer Service Contact and ensure currency is GoCardless compatible.
  • Your GoCardless account configured to use webhooks.

 

Adding GoCardless as a Payment Provider

  1. Go to Finance > Add Payment Provider > Add Payment Provider.
  2. Select 'GoCardless Direct Debit' as the Payment Provider.
  3. Enter your GoCardless Access Token (Read/Write) obtained from the GoCardless portal.
  4. Enter your GoCardless Webhook Secret you created in the GoCardless portal when enabling webhooks.

The webhook secret should be a random alphanumeric string of around 40 characters. It's a great idea to use a password manager to generate this variable as a way of ensuring security. When setting this up in GoCardless, do not select 'Client Certificate'.

  1. Copy the full Webhook URL in mabdeck and use it to set up a Webhook Endpoint in GoCardless.
  2. Click 'Add'.

 

Setting Up a Second Client

To connect more than one client to the same GoCardless Account…

  1. Create a GoCardless Payment Provider for the second client.
  2. Use the same GoCardless Access Token (Read/Write) as the original
  3. Use the same GoCardless Webhook Secret as the original
  4. Copy the Webhook URL from the new payment provider and add it as a Webhook Endpoint in GoCardless.

 

Now your GoCardless Account will send any new Webhooks to both clients. Because all webhooks are validated against the receiving client before being processed, when a Webhook for a resource managed by Client A is received, it will only be processed for Client A, and vice versa.

Removing GoCardless as a Payment Provider

In order to remove GoCardless as a payment provider for a client, all mandates associated with accounts belonging to that client must be cancelled.

 

Network Setup

GoCardless features require a Direct Debit Config on each Network.

 To Direct Debit configuration to a Network, please refer to this article

 

Account Setup

An account must have a GoCardless Mandate set up in order take payments via GoCardless.

Prerequisites

  1. GoCardless has been added as a Payment Provider and a Direct Debit Config has been setup for the account's network.
  2. The account does not have an Active GoCardless Mandate.

 

Creating a GoCardless Mandate from Accounts Page

  1. From the accounts page, open the 'Financials' tab.
  2. Click 'Setup GoCardless Direct Debit'.
  3. Fill in the Payment Details form and click 'Set up Direct Debit'.
  4. Review the details and click 'Confirm'. Wait to be redirected back to the Account page.
  5. Open the financials tab to confirm that the mandate has been created and linked to the account.

Once a Mandate has been created it will be "Pending Submission". The mandate will be Activated by GoCardless after around 3 working days.

 

Creating a GoCardless Mandate from the Consumer Online Account

Your consumers can set up a mandate securely from their online account.

  1. From the Home page of the Consumer Dashboard scroll down to 'How do I pay my bills?".
  2. Select 'Direct Debit'.
  3. Fill in the Payment Details form and click 'Set up Direct Debit'.
  4. Review the details and click 'Confirm'. Wait to be redirected back to the Consumer Dashboard home page.
  5. Scroll down to 'How do I pay my bills?" to confirm that the mandate has been created and linked to the account.

Once a Mandate has been created it will be "Pending Submission". The mandate will be Activated by GoCardless after around 3 working days.

 

Cancelling GoCardless Mandate

A mandate can be cancelled at any time. When a mandate is cancelled, all active subscriptions and pending payments will also be cancelled. Payments that have already been submitted to the banking system will still be collected.

To cancel a mandate…

  1. From the accounts page of an account with an active mandate, open the 'Financials' tab.
  2. Click 'Cancel GoCardless Direct Debit'.
  3. Confirm the mandate cancellation.

 

Reinstating a GoCardless Mandate (Release 4.1)

A cancelled mandate can be reinstated. Once the reinstatement request is successful, the mandate will return be activated again. Mandates can only be reinstated via the GoCardless Portal.

To reinstate a mandate…

  1. Go to the GoCardless Portal mandate page for the mandate you want to reinstate.
  2. Click the 'Reinstate' button in the top right corner of the page.
  3. Confirm the reinstatement in the modal.

 

Payments (Variable Direct Debit)

Prerequisites

  1. GoCardless has been added as a Payment Provider and a Direct Debit Config has been setup for the account's network.
  2. A GoCardless mandate has been created and activated on the consumers account.
  3. The account does not have an Active GoCardless Subscription.

Creating Payments

Now that the account has an 'Active' GoCardless Mandate (and no active GoCardless Subscription), Direct Debit payments will automatically be created whenever a Statement is published for that account.

Each GoCardless Payment is linked to a Mabdeck Transaction and will appear in the "Pending Transactions" table in the "Finance" section of the relevant account page.

Cancelling Payments

Pending payments can be cancelled from the "Pending Transactions" table in the "Finance" section of the relevant account page. GoCardless payments that can be cancelled will display a bin icon. Clicking this icon will open a confirmation modal, allowing you to cancel the payment.

Payments that are created by publishing a statement will automatically be cancelled if the statement is reversed.

Refunding a Payment (Release 4.1)

Prerequisites

  1. The GoCardless account managing the corresponding payment has enabled the refunds endpoint. This endpoint must be enabled by GoCardless on request. Clients that do not have this endpoint enabled will still see the button, but the refund request will not succeed.

7 days after a payment has been completed, it can be refunded from the "Transactions" table in the "Finance" section of the relevant account page. GoCardless Payments that can be refunded will display a "Refund" button. Clicking this button will open a confirmation model, allowing you to refund the payment.

A refund transaction will be created in the "Pending Transactions" table, and will move to the "Transactions" table once it has been completed.

 

 

Subscriptions (Fixed Direct Debit)

Prerequisites

  1. GoCardless has been added as a Payment Provider and a Direct Debit Config has been setup for the account's network.
  2. A GoCardless mandate has been created on the consumers account.
  3. The account does not have an Active GoCardless Subscription.

Now that the account has a GoCardless Mandate, a Fixed Direct Debit (GoCardless Subscription) can be added to the account. While an account has an Active Subscription, a fixed payment will be taken from the account every month until the Subscription is cancelled or reaches its end date.

Creating Subscriptions

  1. From the accounts page, open the 'Financials' tab.
  2. Click 'Setup Fixed Direct Debit'.
  3. Fill out the subscription details.
  4. 'Amount' must be no less than 1.00
  5. 'Number of payments to take' can be left blank for an open-ended subscription
  6. 'Activation Date' should be no earlier than the mandates 'next possible charge date' and can be left blank to start the subscription as soon as possible.
  7. 'Payment Reference' should be left blank unless the linked GoCardless account is a Plus or Pro account.
  8. Click 'Add', the subscription will be created and you will be redirected back to the Account page.
  9. Open the financials tab to confirm that the mandate has been created and linked to the account.

Amending Subscriptions

  1. From the accounts page of an account with a subscription, open the 'Financials' tab.
  2. Click 'Amend Fixed Direct Debit'.
  3. Update the subscription details.
  4. 'Amount' must be no less than 1.00
  5. 'Payment Reference' should be left blank unless the linked GoCardless account is a Plus or Pro account.
  6. Click 'Update', the subscription will be created and you will be redirected back to the Account page.
  7. Open the financials tab to confirm that the mandate has been created and linked to the account.

Cancelling Subscriptions

  1. From the accounts page of an account with a subscription, open the 'Financials' tab.
  2. Click 'Switch To Variable'.
  3. Confirm the subscription cancellation from in the modal.

 

Customer Approvals

Some bank accounts require more than one person to authorise payments. In these cases the mandate is set up as "Pending Customer Approval" until the customer provides the additional information needed to set up the mandate fully.

While a mandate is pending approval, payments and subscriptions can be created, but are also "Pending Customer Approval" and cannot be submitted until the approval has been resolved.

To create a mandate that requires approval:

  1. From the accounts page, open the 'Financials' tab.
  2. Click 'Setup GoCardless Direct Debit'.
  3. Fill in the Payment Details form.
  4. Tick the box labelled 'More than one person is required to authorise Direct Debits'
  5. Click 'Set up Direct Debit'.

 

The pending approval mandate will be created and the customer will receive an email asking them to complete the mandate setup.

 

To approve the mandate (this is the action the consumer must take):

  1. Open the 'Action Required: Complete your mandate setup' email.
  2. Click 'Complete mandate setup' to be redirected to the GoCardless form.
  3. Click 'Print Agreement' and download the pdf document.
  4. Upload the pdf document to the 'Sign and Upload' section.
  5. Click 'Submit signed agreement'

Webhooks

Webhooks allow GoCardless to keep us up-to-date with any changes made to GoCardless configurations.

The following webhooks are currently processed:

Mandates

Created - A new mandate has been created for an account. If the GoCardless Customer has a 'Mabdeck Acc Num' metadata with a valid account number, the mandate is linked to the account.

Failed - A mandate has failed to be created and cannot be used to take payments.

Activated - A mandate has been activated and can now be used to take payments.

Resubmission Requested - A previously cancelled mandate has been resubmitted to the banking system.

Reinstated  - A previously cancelled mandate has been reactivated and can now be used to take payments.

Cancelled - A mandate has been cancelled and can no longer be used to take payments. All related outstanding payments and subscriptions will be cancelled is possible.

Expired - A mandate has expired and can no longer be used to take payments. All related outstanding payments and subscriptions will be cancelled is possible.

Payments

Created - A payment has been created and a Transaction is created for the account.

Submitted - A payment has been submitted to the banking system and can no longer be cancelled.

Cancelled - A payment has been cancelled and the related transaction is reversed.

Failed - A payment has failed and a 'Payment Failed' transaction is created for the account.

Chargeback - A customer has requested that a payment be charged back to their bank account.

Chargeback Cancelled - A payment chargeback has been cancelled.

Subscriptions

Created - A subscription has been created and will start creating monthly payments.

Cancelled - A subscription has been cancelled and will no longer create monthly payments. All related outstanding payments will also be cancelled if possible.

Amended - The payment amount for a subscription has been updated. All future payments created by this subscription will use the new amount.

Finished - A subscription has reached it's end date and no more monthly payments will be created.

Refunds

Created - A refund has been created and for payment and a refund transaction has been created for the account.

Cancelled - A refund has been cancelled and the related transaction is reversed.

Failed - A refund has failed and the refund's transaction is removed from the account.

 

 

 

 

 

Related articles