To make it quick and easy for you to build your GoCardless integration, we maintain libraries in Java, Python, Ruby, PHP, and .NET to talk to our API in those languages without writing lots of boilerplate code.
Setting up your client library
Please find a guide to installing each of our client libraries below:
Creating an access token
To start using the API, you’ll need an access token.
First, sign up for an account in our sandbox: the sandbox is our dedicated testing environment where you can build and test your integration without touching real money.
Next, create an access token. Head to https://manage-sandbox.gocardless.com/developers/access-tokens/create, then give your access token a name and make sure you give it read-write access. Click “Create access token”, and copy the token to your clipboard.
All sandbox accounts are on our Pro package by default. However, if you need to test payment or mandate references, please send an email to api@gocardless.com with the following information so that we can add a dummy Service User Number (SUN) to your account:
Email address associated with GoCardless account
Name on SUN
Address for SUN
Customer support phone number
Customer support email address
Additionally, if you wish to test an additional scheme, custom notifications, refunds or bulk changes please send a request to api@gocardless.com
Your very first API request
With a client library installed and an access token created, you should now be able make requests to the API. We'd suggest testing this using the example code samples here.