Skip to main content

Configuring GoCardless

GoCardless for FinDock is a quick and easy solution for collecting Bacs Direct Debit payments from customers worldwide.

Multi-merchantMulti-currency
yesyes
Payment MethodOne-timeRecurringRefunds
BACS Direct Debityesyes--

Pre-requisites

  • FinDock installed and configured
  • A source connector installed and configured
  • A working connection with the WebHub
  • An active GoCardless account (some functionalities require a Pro or higher account)

Install and activate GoCardless for FinDock#

Follow the standard procedure for installing and activating the GoCardless for Findock payment extension.

Configure the GoCardless extension#

note

For Salesforce test environments, we strongly recommend you first integrate with a GoCardless Sandbox environment: https://manage-sandbox.gocardless.com/

To connect your Salesforce environment to your GoCardless account:

  1. Launch the FinDock app and click Setup.
  2. Open the Remote Site Settings tab and, depending on your org, activate the test and/or production endpoint of GoCardless: https://api-sandbox.gocardless.com or https://api.gocardless.com. You should see a notification saying “Success: The remote site setting "GoCardless" has been activated successfully.
  3. Go back to the Setup tab.
  4. Go to the GoCardless-FinDock tile in the FinDock Setup in Salesforce.
  5. Select Is Test if you are connecting with a GoCardless Sandbox account (manage-sandbox.gocardless.com)
  6. Click Connect GoCardless. You will be redirected to a GoCardless page.
    Connect GoCardless
  7. Follow the setup steps from GoCardless.
  8. When completed, you are redirected to the FinDock GoCardless setup page with a message “Successfully connected <your-target-name> to GoCardless."
  9. Click Save.

If you later wish to disconnect your GoCardless account, simply click Disconnect GoCardless. Connect GoCardless

Configuring the Quick Direct Debit component#

Important: To be able to use the Quick Direct Debit component with GoCardless, you need to have a GoCardless Pro account AND be approved by GoCardless for “Manual entry.” For more information on what is required to be approved for manual entry (through FinDock) of Paper & Phone mandates, please visit the GoCardless website. You can check whether you are approved for manual entry by checking if you see the option for Manual as described here in your GoCardless production account. In GoCardless sandboxes, the option is always available.

The FinDock Quick Direct Debit for GoCardless feature is implemented as a Salesforce component. All you need to do to be able to use it is add the component to a page layout.

To configure Quick Direct Debit:

  1. Open the Salesforce Object Manager and select the Contact object.
  2. Go to Lightning Record Pages and select a Record Page.
  3. Search for the ‘GoCardless Quick Direct Debit’ component.
  4. Drag the component onto the page.
  5. Click the component to open the component settings.
  6. Adjust the component settings to your needs:
    • Set a Target (‘Target name’ in the FinDock-GoCardless Setup page) to use for Recurring / Installments created with the component.
    • Set a default Description for one-off Installments
    • Set available Recurring Frequencies separated by a ‘,’. Currently only ‘monthly,yearly’ are supported
    • Set the Country code to determine the Direct Debit Scheme. Currently only ‘GB’ is supported.
  7. Click Save.
note

It is currently not possible to set a description for Recurring from the component. The ‘Bank Statement Description’ field will default to __TO_BE_REPLACED__. You will need to override this value manually or with Salesforce automation tooling.

To configure ‘Cancel Mandates’ from Salesforce:

  1. Open the Salesforce Object Manager and select the Mandate object.
  2. Go to Lightning Record Pages and select a Record Page.
  3. Search for the ‘GoCardless Mandate Manager’ component.
  4. Drag the component onto the page.
  5. Click Save.

Migrating GoCardless subscriptions to FinDock#

If you already had an existing GoCardless account with subscriptions, you can migrate your data to FinDock. Please first carefully read the detailed data migration instructions from GoCardless to ensure you prevent any unexpected behavior or communication to your existing customers.

  1. Create a Contact record for each GoCardless customer, with the GoCardless customerId in the cpm__GoCardless_customerId__c field.
  2. Create a Payment Profile record with the GoCardless customer bank account details.
  3. Create a Mandate record with the GoCardless mandate reference linked to the Contact and Payment Profile record.
  4. Create a Recurring payment / donation with the data from the GoCardless subscription, linked to the Contact and Mandate records.
  5. Set up a (recurring) Payment Schedule to start collecting GoCardless Direct Debit payments.
  6. Ask GoCardless support to silently end the subscriptions in GoCardless.

Multi-currency support#

The FinDock GoCardless Direct Debit solution currently only supports creating Bacs Direct Debits in British Pounds.

Testing with the Payment API#

You can use the following example messages to test if your GoCardless configuration is working as expected. Use a test bank account from GoCardless.

One-time payment#

{
"SuccessURL": "https://www.example.com/success",
"FailureURL": "https://www.example.com/error",
"Payer": {
"Contact": {
"SalesforceFields": {
"FirstName": "Donald",
"LastName": "Johnson"
}
}
},
"OneTime": {
"Amount": "25"
},
"PaymentMethod": {
"Name": "Direct Debit",
"Processor": "FinDock-GoCardless",
"Parameters": {
"Description": "Thank you for your donation"
}
}
}

Recurring payment#

{
"SuccessURL": "https://www.example.com/success",
"FailureURL": "https://www.example.com/error",
"Payer": {
"Contact": {
"SalesforceFields": {
"FirstName": "Donald",
"LastName": "Johnson"
}
}
},
"Recurring": {
"Amount": "25",
"Frequency" : "Monthly",
"StartDate" : "2020-08-10"
},
"PaymentMethod": {
"Name": "Direct Debit",
"Processor": "FinDock-GoCardless",
"Parameters" : {
"Description" : "Thank you so much!"
}
}
}