Our Developer Guide, which includes information on how to get started with our API, building a partner integration and our API reference can be found here.
The GoCardless API is a wrapper around diverse national Bank Debit systems allowing you to collect payments everywhere with one integration.
There are three key parts to an integration with the API - you can do one, two or all three of them:
-
Setting up mandates with your customers’ bank accounts
-
Collecting payments against your mandates
-
Staying up-to-date with webhooks / events
Alongside the API, you’ll have access to the GoCardless Dashboard which you can also use to manage your account.
This means that, for example, you could choose to add your customers through your website using an API integration, but bill them manually through the Dashboard.
When you’re first getting started with the API you might find the following articles helpful:
Introduction to the GoCardless API
Making your first request
Adding your first customer
Taking your first payment
What's next?
Our client libraries
Cursor pagination
Core endpoints
Many other articles can be found in our Developer Guide, where we provide you with everything you need to get started with our API.
Within this section, you will find the following articles:
Getting started with our API
Adding customers via the API
Payments and subscriptions via the API
Developer Tools
API guide for partners