Configuring SmartDebit

FinDock integrates with SmartDebit, a Bacs service bureau that is now part of Access PaySuite.

The SmartDebit payment extension is part of the Bacs for FinDock package and supports collecting one-time and recurring Bacs Direct Debit payments.

Prerequisites

• FinDock is installed and configured.
• The org is connected to ProcessingHub.
• You have a service contract with SmartDebit.

Before you start

SmartDebit offers a variety of services, and your specific contract terms impact how you should set up and use FinDock. We recommend you collect the following information about your SmartDebit contract:

• New payer lead time: this impacts your target settings and determines when you should run mandate schedules
• Collection lead time: this determines both run date and collection date for payment schedules
• Submission frequency: impacts setting up automated payment collection and mandate management
• Collection dates: if there are specific dates of the month you can collect, payment schedules need to be scheduled accordingly

Install and activate Bacs extension

Follow the standard procedure for installing payment processors to add the Bacs package to your org.

Check and assign the required permissions. If you are using custom permission set groups, ensure the Bacs permission sets are assigned.

Adjust FinDock Core mandate settings

In the Bacs Direct Debit scheme, it is strongly recommended to maintain a one-to-one relationship between a payer (contact or account) and DDI (mandate). This helps keep payments and associated reports clear, particularly for reconciliation and indemnity.

To keep a one-to-one relationship, disable the Reuse existing mandate option for FinDock under the Core mandate settings.

Make sure the Auto-create mandates option is enabled. This ensures a new Mandate record is automatically created when needed.

The Mandate Reference setting is not used for SmartDebit.

Add a SmartDebit target

A target in FinDock defines the bank account that is credited in the Bacs Direct Debt collection process. In the case of SmartDebit, the target defines your customer account with SmartDebit and is used to connect to the SmartDebit API for file transfers between FinDock and SmartDebit.

To create a new target:

SmartDebit target settings

Sort code and account check

For Bacs Direct Debit payments initiated through the FinDock Payment API, FinDock automatically performs a sort code & bank account check to avoid failed DDI registration due to incorrectly entered code or account values. The checking is done automatically, and the result is included in the synchronous response of the paymentIntent API call.

With FinDock Giving Pages, the checks are implemented by FinDock. If you are using your own payment form/page design, you need to ensure errors are handled gracefully if invalid information is entered.

In addition to the automated API check, you can add the Lightning component Check Sort Code and Bank Account to your Payment Profile layout to do the same validation when manually entering payment information.

To set up manual sort code and bank account checking:

1. Go to a Payment Profile record.
2. Click the settings cog in the upper right and select Edit Page.
   
3. Drag the Check Sort Code and Bank Account component to your page layout.
   
4. Click Add Filter under Set Component Visibility to the right.
   
5. Click Advanced and under Field, click Select.
   
6. In the pick lists, select Record, then Record Type, then Name, and click Done.
   
7. Add an equal operation with "Bank Account" as the value, then click Done.
   
8. Click Save in the upper right to save the layout change and component filter settings.
   

The component will now appear on payment profiles with UK bank accounts, but it is not visible for other payment profiles.

(DEPRECATED) SmartDebit scheduled Apex

For SmartDebit, there is a scheduled job which automatically kicks off the DDI registration process. This automatic flow skips validation and registers any DDI directly with SmartDebit.

To enable this job:

1. Open Salesforce Setup, in the quick find box enter "Apex Classes" and click on "Apex Classes" in the search results.
2. On that page click Schedule Apex.
   
3. Next, give the job a recognizable name like “DDI Registration.”
4. For the Apex Class, enter: "RegisterDDISchedule."
5. Set the job to run every day of the week at a time of your choosing. It is recommended to do this in the evening as this ensures all new DDIs for that day will be included as soon as possible.
   
6. Click Save to store the schedule.

Every day at the designated time, FinDock creates a mandate schedule, selects the relevant mandates, and registers them with SmartDebit. If any mandate fails, the individual mandate record is marked with status Failed. Make sure to review and fix these so they are not failing repeatedly.

Testing SmartDebit setup

When you test your SmartDebit extension, make sure the Endpoint and other relevant details in your target configuration are using the SmartDebit Sandbox. Your testing should cover at least the following:

• Test new payer creation: use own form on a webpage/app or use Giving Pages to create a new payer
• Test new payer file transmission: run a mandate schedule to create a new payer CSV file and confirm (using your Pulse account) that it is successfully transmitted to SmartDebit
• Test new collection file transmission: run a payment schedule to create a collection CSV file and confirm (using your Pulse account) that it is successfully transmitted to SmartDebit

Payment API sample messages

To test your SmartDebit configuration, you can use the following messages with the Payment API.

One-time Bacs Direct Debit payment

{
   "SuccessURL": "https://www.example.com/success",
   "FailureURL": "https://www.example.com/error",
   "Payer": {
       "Contact": {
           "SalesforceFields": {
               "FirstName": "Eric",
               "LastName": "Johnson",
               "Email": "eric@johnson.com"
           }
       }
   },
   "OneTime": {
       "Amount": "30"
   },
   "PaymentMethod": {
       "Name": "Direct Debit",
       "Processor": "PaymentHub-BACS",
       "Target" : "SmartDebit-target",
       "Parameters" : {
           "bankAccount" : "13537846",
           "sortCode": "205132",
           "holderName" : "E. Johnson",
           "description": "test"
       }
   },
   "Settings": {
       "SourceConnector": "PaymentHub"
   }
}

Recurring Bacs Direct Debit payment

{
   "SuccessURL": "https://www.example.com/success",
   "FailureURL": "https://www.example.com/error",
   "Payer": {
       "Contact": {
           "SalesforceFields": {
               "FirstName": "Eric",
               "LastName": "Johnson",
               "Email": "eric@johnson.com"
           }
       }
   },
    "Recurring": {
         "Amount": "25",
         "Frequency": "Monthly",
         "StartDate": "2020-11-01"
    },
   "PaymentMethod": {
       "Name": "Direct Debit",
       "Processor": "PaymentHub-BACS",
       "Target" : "SmartDebit-target",
       "Parameters" : {
           "bankAccount" : "13537846",
           "sortCode": "205132",
           "holderName" : "E. Johnson",
           "description": "test"
       }
   },
   "Settings": {
       "SourceConnector": "PaymentHub"
   }
}