Astral GoCardless - Help:

The Setup Page
Astral GoCardless Setup Image

After initial installation, we suggest that you run the following pages:

  • Assisted Connection Setup Wizard
  • This connects your Business Central system to GoCardless, and authorises the Astral GoCardless service to receive webhooks for you system. After connecting, Business Central will hold details of your Creditor and Schemes records.
  • Assisted Application Setup Wizard
  • Once the Creditor and Schemes details have been downloaded, the Assisted Application Setup Wizard will guide you through the rest of the configuration. However, if you prefer to see the information that will be required, the Setup Checklist can be used instead.
  • Setup Checklist
  • The Setup Checklist can be used as well as or instead of the Assisted Application Setup Wizard. It highlights the areas that need to be setup, and slecting the item will open the Assisted Application Setup Wizard at the correct location.


GoCardless Payment Method Code

The GoCardless Payment Method Code is a payment method that you can add to a customer record (and hence flowing through to Sales Invoices). It provides an additional method for filtering Sales Invoices that you want to be added to a Payment Batch.

Paylink Expiry After

The GoCardless api does not allow for the creation of mandates. Instead, a unique Paylink is emailed to the End Customer, and the End Customer creates the mandate themselves. What is great here is that at no point do you need to know or store your Customer's bank details! The Paylink is not actually a link to the GoCardless website. It is a Paylink held on the Astral GoCardless service that once clicked, triggers the GoCardless "redirect_flow" process, redirecting the End Customer to the GoCardless website. This link is only available for a set number of days, and we suggest that you keep this as being set to expire after 30 days.

Payout G/L Control Account

Each GoCardless Payout will typically cover many Payments paid out that day. It will generally be one Payout per Scheme per day. When posting the Payout, to avoid issues that may arise from posting different Currencies within the same document, Astral GoCardless posts each Journal Line to a balancing account. The total amount posted to this "Payout G/L Control Account" will total to zero after each posting.

Auto Process Notifications

As part of the Assisted Application Setup process, a Job Queue Entry will be created to automatically collect Notifications. Notifications for your system are sent to the Astral GoCardless service as webhooks, and they are stored until your system collects them. These webhooks contain very little data; just an instruction that a resource (a mandate, a subscription, a payment or a payout) has been updated. The "Auto Process Notifications" checkbox instructs the system to Process the Notifications as and when they are downloaded. We suggest that you leave this field checked, unless you are testing and want to see how and when the Notifications come in. If this field is unchecked, you will need to click the "Notifications" tile in the Role Centre and click the "Process" or "Process All" action.

Pause Notifications Until

Since most users test the functionality out in their Sandbox environment, the Astral GoCardless service typically has many "Get Notification" api calls from systems that are no longer being used. Therefore, the Astral GoCardless service may send a "Pause" instruction to effectively switch off calling our service where we know that no notificatiuons will have been received. Don't worry though, if you were to use the Astral GoCardless functiponality again in the system, the "Pause Notification Until" date value will be automatically removed, and the Notifications will flow through as normal.


The Sandbox field is generally unavailable for use. It is set as part of the initial setup process, and you will only have the option to choose whether Sandbox should be ticked if you are in your Production Environment. Although not advisable, some Business Central users may chose to have a Test Company within their Production Environment. When in Sandbox mode, all api calls to GoCardless are sent to their Sandbox environment, and as such, no money will be received.

No. Series

A No. Series is required for the following areas:

  • GoCardless Mandate Nos.
  • GoCardless Payment Nos.
  • GoCardless Refund Nos.
  • GoCardless Subscription Nos.
  • GoCardless Payout Nos.

These No. Series provide the system with "Nos." for the Business Central reference. These "Nos." correspond to GoCardless "IDs". Typically within Business Central, a "No." is restricted to 20 characters in length, whereas a GoCardless "ID" can be up to 255 characters.


Registered Company

The Registered Company is sent to thew Astral GoCardless service when it is initially registered, and exists as a failsafe to ensure that a copy of the Production company to a Sandbox Environment cannot be used to generate real transactions.

Registration ID

This is a unique identifier for your system on the Astral GoCardless service.


GoCardless Organisation IS

This is GoCardless' reference for your Organisation. It is provided to Business Central as part of the Assisted Connection Setup process.

GoCardless Setup Status

In order to receive Payouts, your account at GoCardless must be verified. If not verified, each time you run the "Assisted Connection Setup" wizard, the GoCardless "Onboarding" web page will be loaded.

GoCardless Email

This is the email address used when logging in to the GoCardless website when connecting to the GoCardless Merchant Account.