Skip to main content

GoCardless

Configure the following parameters for the Connector (see Connector Config - GoCardless):

  1. Fill in the mandatory Username Merchant-Account Username
  2. Fill in the mandatory Password Merchant-Account Password
  3. Fill in the mandatory API Secret Generated and provided by PSP.
  4. Select the mandatory Extra Data: scheme SEPA, BetalingsService, BACS, ACH, BECS, BECS NZ, PAD, SEPA Instant Credit Transfer, SEPA Credit Transfer
  5. Fill in the mandatory Extra Data: webhook_secret see Webhooks
  6. Select in the mandatory Extra Data: flow — Redirect Flow, Server-to-Server

Webhooks

To receive real-time notifications from GoCardless, you’ll need to add a webhook endpoint from your Dashboard https://manage-sandbox.gocardless.com/developers/webhook-endpoints/create.

Simply enter the connectors Notification URL, give your endpoint a name, and then click "Create webhook endpoint". Next, click on your new endpoint in the list and copy the secret to your clipboard to be configured in your connector configuration.

Data Fetcher Configuration

You have the option to configure Data Fetchers (see section Enable and Set Up Reconciliation on the Provider Level) either on Provider or on Connector Level, depending on which setup works better for your provider.

Provider Settlement

Configure the following Parameters for the Settlements Provider Data Fetcher to fetch Settlement (json format) via an API (see Edit Provider Settlement Data Fetcher Provider Level):

  1. Fill in the expected Interval in which the Provider Settlement File should be fetched - days, hours
  2. Select the Adapter GoCardless
  3. Enable Testmode to test fetching of Provider Settlements from the GoCardless Sandbox (URL used https://api-sandbox.gocardless.com/), disabled the GoCardless Production (URL https://api.gocardless.com/) environment is used
  4. Fill in the mandatory Extra Data: accessToken (string): used for the Authorization Request Header and can be found in the GoCardless dashboard
  5. Fill in the optional Extra Data: goCardLessVersion (boolean): Used for the GoCardless-Version Request Header to specify the version of the released API. Version "2015-07-06" will be used by default if no version was provided.

Settlement fields

Batch number

The batch number is taken from the report notification itself and contains the batchId found under "id"

Payment reference

The payment reference is taken from the report notification itself and contains the paymentReference found under "reference"

GoCardlessIXOPAY platformDefault (if not set by GoCardless)
created_atTransaction settlement dateNone
currencyTransaction settlement currencyNone
amountTransaction settlement amountNone
payment | refundTransaction settlement reference idNone
payment_paid_outTransaction type: debitNone
payment_refundedTransaction type: refundNone
payment_charged_backTransaction type: chargebackNone

Mapped Fees

GoCardlessIXOPAY platformDefault (if not set by GoCardless)
gocardless_feeMarkupNone
surcharge_feeMarkupNone
amountNormalNone
currencyTransaction fee currencyNone