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

Qodex
GoCardless Account

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

1. 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.
2. The Bank Account field requirements will vary depending on the scheme and payment method - please update the relevant requests accordingly. See more info here.
3. Our requests are chained together automatically via Environment variables, so there is no need to copy & paste IDs across requests.
4. Enjoy! 🥳

1. Helper Endpoints - Healthcheck

GET {{url}}/health_check

---

2. Core Endpoints-Scenario Simulators - Billing Request Fulfilled Scenario

POST {{url}}/scenario_simulators/billing_request_fulfilled/actions/run

---

3. Billing Requests-Billing Requests - Change Currency for a Billing Request

POST {{url}}/billing_requests/{{billing_request}}/actions/choose_currency

---

4. Core Endpoints-Scenario Simulators - Creditor Verification Status in Review Scenario

POST {{url}}/scenario_simulators/creditor_verification_status_in_review/actions/run

---

5. Embed Flow-2. (Optional) Creditors Bank Accounts - Create a Creditor Bank Account

POST {{url}}/creditor_bank_accounts

---

6. Core Endpoints-Customer Bank Accounts - List Customer Bank Accounts

GET {{url}}/customer_bank_accounts

---

7. Core Endpoints-Scenario Simulators - Payment Late Failure Scenario

POST {{url}}/scenario_simulators/payment_late_failure/actions/run

---

8.