Skip to main content
Logo
Identify a payment Support GoCardless
  1. Support Centre
  2. Partner integrations & the API
  3. Integrating with our API

Introduction to the GoCardless API

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.

 

Was this article helpful?
  • Promoted articles

    • Credit card payments
    • Bulk importing payments
    • Overview of payment statuses
    • Refund a payment
  • Recently Added Articles

  • Top Articles

API Documentation

Our detailed docs have everything you need to know about using our Payments and Bank account data APIs

View documentation

Need help identifying a payment?

Seen ‘GoCardless Ltd’ on your bank statement? Use our secure tool below to find out more.

Payment Lookup

Need support?

Contact

Our support team are available 24/7 to answer any questions you may have.

Quick links

Knowledge base
Visit GoCardless.com

About GoCardless

Legal
Privacy
Security
Blog

Support

Contact support
Complaints
Contact sales

Seen ‘GoCardless Ltd’ on your bank statement?

Identify a payment

GoCardless Ltd, Sutton Yard, 65 Goswell Road, London, EC1V 7EN, United Kingdom


GoCardless Ltd (company registration number 07495895) is authorised by the Financial Conduct Authority under the Payment Services Regulations 2017, registration number 597190, for the provision of payment services.





English (CA) Deutsch English (AU) English (GB) English (NZ) English (US) Español Français
Search help articles
https://gocardless.com/en-us/partner-with-us/
/hc/theming_assets/01JKARFYGKK1KBMBMT9CC1BV8G
Partner with us
Partner with us to shape the future of payments.
custom
https://gocardless.com/en-us/stories/
/hc/theming_assets/01JKARFYZ7DNZC3PC7YMW92YZ4
Customer Stories
GoCardless helps thousands of businesses with their payments everyday.
custom
https://gocardless.com/payment-lookup/
/hc/theming_assets/01JKARFZAEXTV1RTZ2VZNFPXEW
Identify a payment
If you’ve seen 'GoCardless Ltd' appear on your bank statement
Payment timings, Verification, Xero, 2fa