GoCardlessDeveloper Docs
Create a sandbox account

Go-live checklist#

View as Markdown

Use this checklist to take your integration live. Work through each step to ensure a smooth transition from sandbox to production.

Checklist#

1. Simulate scenarios

There are common paths you should make sure your integration handles successfully, for example, a customer cancelling their mandate or a payment failing due to lack of funds.

2. Set up your live account

Create your live GoCardless account to start processing real payments. If you are working with a GoCardless Account Executive, they will help you with this step.

3. Create an access token

Just as you did with your sandbox account, navigate to the Developers tab, then select Create followed by Create Access Token. Make sure the token has read/write permissions.

4. Amend API endpoints from sandbox to live

Update your existing integration to point to the live environment by changing the base URL from https://api-sandbox.gocardless.com to https://api.gocardless.com. If you're using a client library, change the environment setting from sandbox to live.

5. Set up a webhook listener

Add a webhook endpoint to your live account following the same steps you completed for sandbox. See the Stay up to date with webhooks guide if you need a refresher.

6. Test your connection

Check that you're still able to successfully make a call to the live API — choose a call that you've already tested in sandbox.

7. Subscribe to GoCardless API status updates

Subscribe to API status notifications for both sandbox and live environments. This helps you stay proactively aware of any scheduled maintenance or downtime.

1. Simulate scenarios

There are common paths you should make sure your integration handles successfully, for example, a customer cancelling their mandate or a payment failing due to lack of funds.

2. Set up your live account

Create your live GoCardless account. If you are working with a GoCardless Account Executive, they will help you with this step.

3. Create a live access token

Just as you did with your sandbox account, navigate to the Developers tab, then select Create followed by Create Access Token. Make sure the token has read/write permissions. Be sure to save it in a secure place or add it directly to your build.

4. Create your payment pages

Create your Payment Pages in accordance with our compliance guides. This will need to be approved by a member of our Compliance Team before you can process real payments.

5. Amend API endpoints from sandbox to live

Update your existing integration to point to the live environment by changing the base URL from https://api-sandbox.gocardless.com to https://api.gocardless.com. If you're using a client library, change the environment setting from sandbox to live.

6. Set up a webhook listener

Add a webhook endpoint to your live account following the same steps you completed for sandbox. See the Stay up to date with webhooks guide if you need a refresher.

7. Test your connection

Check that you're still able to successfully make a call to the live API — choose a call that you've already tested in sandbox.

8. Subscribe to GoCardless API status updates

Subscribe to API status notifications for both sandbox and live environments. This helps you stay proactively aware of any scheduled maintenance or downtime.

Next steps#