TABLE OF CONTENTS

As GoCardless's preferred provider on the Force.com Platform, Asperato offers you many features specific to GoCardless.


Success+

Notification Suppression

Cancel Mandate

Update Mandate

PSP Passthrough Parameters


Success+


Overview

GoCardless Success+ is a feature to intelligently retry a failed payment. Once can read more about it here.


Using GoCardless Success+

Asperato has extended its support for GC Success+ feature. In Asperato package when the settings for GoCardless are turned on, GoCardless retries the failed payment using its Success+ pack. Listed below are the steps to enable and use the GoCardless Success+ feature while still using Asperato package.


Enable Success+ in GoCardless Account

You need to enable Success+ separately for each currency from GoCardless Dashborord. Contact GoCardless Support to get understanding on setup and testing of this feature.


Enable Success+ support in Asperato Package

Write to support@asperato.com to get this feature enabled in Asperato app. We will confirm you once this setting is enabled.


How it works?

After the required configurations are done, Asperato informs GoCardless that the payments need retrying in accoridance with the settings of the GoCardless account. The process is:


  • A payment is created in Asperato
  • Asperato informs Gocardless about
  • New payment being created
  • Availability of permission to Retry the Payment if it fails
  • Payment status changes to Submitted for Collection
  • Payment collection fails
  • Status of payment changes to "Retry in Progress"
  • Payment is resubmitted for collection as per the settings done in the GoCardless Account.
  • if payment collection is successful, status on payment changes to "Collected from Customer"
  • if the retry attempts are exhausted and still payment could not be collected then the payment status is updated to "Failed"

The Automatic retries are enabled at org level and then the setting filters down to individual payment records - enabling you to control which payments get retried.


Please Note, if you have enable success plus at both places, GoCardless and Asperato, then it is recommended not to take payment from an alternative route when payment status is "Retry in Progress".


Notification Suppression


Overview

This feature will allow GoCardless customers to manage the advance payment collection notices sent to customers, rather than using the GoCardless emails. This will not affect the mandatory emails which are part of the BACS Scheme rules (e.g. the emails sent following Direct Debit set up). To use this feature you need to complete the mandatory approval process and package configuration as described below.


Approval Process

To be able to handle customer notifications yourself, you will need to be granted permission by GoCardless. It is a two step approval process when you are using GoCardless connection with Asperato to ensure compliance with Direct Debit scheme rules


  • Write to GoCardless Support at help@gocardless.com. Mention that you wish to handle “payment_created” notification for all the schemes that you intend to use (eg., SEPA, BACS, BECS, PAD, ACH, etc.). Please note that to GoCardless, you will have to individually mention the schemes for which you intend to handle the notifications. Refer GoCardless documentation here. Check in the section “Getting custom notifications enabled” for more information.
  • Write to Asperato Support at support@asperato.com to enable the suppression of GoCardless Notifications for Payments being created.We are required by GoCardless to see evidence of your handling of notifications. For this purpose our Customer Success team would ask you to complete a self-signed form and provide the confirmation email from GoCardless. Once we have these two documents our team would enable this feature for your Salesforce org.

Configuration in Asperato Package

After getting the required approval you do following configurations in the AsperatoOne package:


  • Login to Salesforce org where the AsperatoOne package is installed.
  • Go to Setup
  • Write “Custom Settings” in the quick find box
  • Click on “Custom Settings”
  • Go to Asperato One settings Asperato One Settings
  • Click on Manage
  • Set the value of “Suppress Notification for Payments” as true 
  • Save the changes

Suppressing Notification for Payments

Single Payments

Creating Payments from Authorisation Record

  • Go to Authorisation record, against which to take payment
  • Click on Process Payment using Authorisation
  • Check the checkbox "Suppress Notification by PSP" as true. 
  • Click on Process Payment.

Creating Payments from Payment tab


  • Go to Payments tab -> Click on New
  • Enter the required details
  • In the “Payment Reference Information” section, set the value of “Suppress Notification by PSP” to True


Recurring Payments


Payments Created by Payment Schedule

  • After getting the necessary approvals, check section “Approvals” , if the value of the custom setting field "Suppress Notification for Payments" is set to true, as mentioned in section “Configuration in Asperato Package”, then all the payments created by the payment schedule will have the value of “Suppress Notifications by PSP” set as True.

Cancel Mandate


For users running on Asperato package 2.15 and below, this has to be done directly on the GoCardless by logging in to your GoCardless Dashboard.


For users running Asperato package 2.16+, to cancel mandate do the following:

  • Go to the Authorisation Record which needs cancelling
  • Select button 'Cancel Mandate' (if you do not see this button, ask your Salesforce Administrator to update your page layout for the Lightning Quick Action 'Cancel Mandate')
  • You will see a confirmation screen - the Mandate will only be cancelled once the button "I understand, cancel mandate' is clicked
  • Once this is clicked, the Salesforce record updates to 'Cancelled' and the Mandate is cancelled with GoCardless


Note - If a Cancelled Mandate is then processed again in Salesforce, then the Authorisation record in Salesforce is updated from Cancelled to Pending and a new Customer record is created within GoCardless



Update Mandate


It is possible, from Version 2.23 (2023.3 - Winter 24) to update customer email and billing address information from within Salesforce.


  • Go to the Authorisation Record which needs updating
  • Select button 'Update Authorisation' (if you do not see this button, ask your Salesforce Administrator to update your page layout for the Lightning Quick Action 'Update Authorisation')
  • In the pop up screen - enter the details which needs updating i.e the email or billing address fields
  • Click 'save'
  • The Salesforce record is updated and the customer record in GoCardless is updated with the new details

Passthrough Parameters


With GoCardless it is possible to send custom values on the Authorisation and Payment records using 'Passthrough Parameters' from V2.13 onwards of Asperato.


Be aware that:

  • The data set on the field is PSP specific. This means if you switch to another PSP, and populate the same data on the field, it may not be passed to the new PSP in the same way.
  • The field isn't visible on the default layout for either payments or authorisations, so must be added manually if you wish to view it.
  • The data must be entered as a syntactically valid JSON object containing key-value pairs. This makes it unsuitable for manual use. Instead, a process should be used that collects the required data on a separate screen, formats the data appropriately, then inserts it into the field. Some development work is likely to be involved here, so we would strongly suggest appointing a qualified Salesforce consultant to help you manage this process.
  • The data will be sent both for repeat and web based transactions.
  • Invalid data specified in this field may cause transactions to fail.

GoCardless supports the following fields:

Description

Reference and

Custom Metadata


Description

GoCardless supports sending a description for payment records using a single "description" key. Note that this isn't supported for mandates.


The 'description' can be can be set by populating the PSP Passthrough Parameters field as follows:

{"description": "test description"}


If GoCardless sends notification emails to your customers, this description will be included. It is also visible for the payment record on the GoCardless dashboard. (Note that descriptions are not supported for mandates.)


By default, Asperato includes the Asperato transaction reference in the description field in GoCardless. Setting a custom description as above will remove the transaction reference from this field.


Reference

GoCardless supports sending a reference for payment records using a single "reference" key. Note that this isn't supported for mandates.


The 'reference' can be can be set by populating the PSP Passthrough Parameters field as follows:

{"reference": "testref"}


This reference will appear on your customer’s bank statement.


You must make sure any use of custom references is tested thoroughly in a sandbox prior to live deployment. Support for custom references must be explicitly enabled by GoCardless, and there are strict restrictions in place around the reference format - different schemes have different maximum lengths, and some schemes require that the reference is unique. If you do not adhere to the correct format, or the custom reference functionality isn't enabled, your transactions will likely fail.


Custom Metadata

GoCardless supports sending custom pairs of key-value metadata for customer, payment and mandate records. At present up to three key-value pairs are supported for each record type (this limitation is on the GoCardless side, not the Asperato side.)


After processing, the metadata should be visible the relevant payment, customer or mandate object in the GoCardless dashboard.


Payment

The custom payment metadata can be set on the payment record in Salesforce, by populating the PSP Passthrough Parameters field as follows:

{"payment_metadata":{"Key1":"Value1","Key2":"Value2","Key3":"Value3"}}

eg

{"payment_metadata":{"InternalRef":"19583716","BedSize":"XL"}}


Authorisation

Custom metadata can be set for mandate and customer objects on the authorisation record in Salesforce, by populating the PSP Passthrough Parameters field as follows:

{"customer_metadata":{"CustomerKey1":"CustomerValue1","CustomerKey2":"CustomerValue2"},"mandate_metadata":{"MandateKey1":"MandateValue1","MandateKey2":"MandateValue2"}}


Please note - 

Up to three key-value pairs can be provided for customer_metadata and another three for mandate_metadata (six in total.)  Specifying both customer_metadata and mandate_metadata fields is not required.