GoCardless
Number of APIs: 173
👋 Introduction
Documentation for how to use this collection, including a Quickstart guide, is available on the GoCardless Developer Docs.
Detailed documentation for GoCardless API endpoints is at the GoCardless API reference guide.
📝 Prerequisites
Before you begin, set up your free GoCardless Sandbox account. Here, you can create an access token to add to your forked Qodex collection.
🏃 Getting Started
1. Create a GoCardless Sandbox account here: the sandbox is our dedicated testing environment where you can build and test your integration without touching real money.
2. Go to Developers > Create > Access Token to generate an API access token. Give it a memorable name, with read-write access.
3. [Fork] the collection into Qodex to synchronize with future updates.
4. Set up a [Qodex Environment] for the GoCardless API collection by navigating to Environments and selecting the + icon to create a new environment.
5. Navigate to an API call you'd like to test to save your key into the collection:
- With an API call open, click into
Authorization
- Expand the section
- Paste in Copy the access token from step 2.
Save authorization to collection
with the link
Things to Note
- There are often additional URL parameters or various request bodies that can be passed, we recommended going through our API Developer Guide here and amending the requests as necessary.
- The Bank Account field requirements will vary depending on the scheme and payment method - please update the relevant requests accordingly. See more info here.
- Our requests are chained together automatically via Environment variables, so there is no need to copy & paste IDs across requests.
- Enjoy! 🥳
-
Core Endpoints-Tax Rates - List Tax Rates GET {{url}}/tax_rates
-
Core Endpoints-Tax Rates - Get a Single Tax Rate GET {{url}}/tax_rates/{{tax_rate}}
-
Core Endpoints-Scenario Simulators - Mandate Customer Approval Granted Scenario POST {{url}}/scenario_simulators/mandate_customer_approval_granted/actions/run
-
Billing Requests-Billing Request Templates - Update a Billing Request Template PUT {{url}}/billing_request_templates/{{billing_request_template}}
-
Core Endpoints-Block - Create a Block POST {{url}}/blocks
-
Core Endpoints-Block - Create Blocks by Reference POST {{url}}/blocks/block_by_ref
-
Core Endpoints-Block - Disable a Block POST {{url}}/blocks/{{block}}/actions/disable
-
Core Endpoints-Block - Get a Block GET {{url}}/blocks/{{block}}
-
Core Endpoints-Creditors - Update a Creditor PUT {{url}}/creditors/{{creditor}}
-
Core Endpoints-Creditors - Create a Creditor POST {{url}}/creditors