GoCardless

Requirements:

Connecting the Platform

Go to Integrations > GoCardless > Connect Platform (if not already connected). This will open a dialog with a form to fill out. Following are the fields you need to fill out to connect your GoCardless account with Crosspay.

Production API Key

Make sure you’re in manage.gocardless.com, then go to Developers > API Settings > Create > Access Token
Give the token a name like “Crosspay Access”
Choose the Read + Write permissions and create the token.
After creating the token, copy the Access Token and store it securely, as it contains sensitive information and won’t be shown again.
Now enter the Access Token in the respective field in Crosspay form.

Production Webhook Secret

To allow Crosspay to receive real-time updates about purchases, subscription renewals, cancellations and other events, you need to set up a webhook in GoCardless.

In your GoCardless dashboard, go to Developers > API Settings > Create > Webhook Endpoint
In the “URL” field, enter the Webhook URL (Production) from the Crosspay GoCardless form.
In the secret field, enter a random string or use a secret generator to generate a secure secret. This will be used to verify the authenticity of the webhook events sent by GoCardless.
Click on “Create Webhook Endpoint” to create the webhook.
After creating the webhook, click on it to open its details, then copy the Webhook Secret and paste it in the respective field in Crosspay form.

Now GoCardless will start sending real-time updates about purchases, subscription renewals, cancellations and other events to Crosspay.

Sandbox API Key and Webhook Secret

To setup sandbox testing, you need to repeat the same steps as above but in a Sandbox in GoCardless dashboard, and use the respective Sandbox Webhook URL and API Key from Crosspay form. This will allow you to test the integration and make sure everything is working correctly before going live.