GoCardless

GoCardless integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from GoCardless.

GoCardless | GoCardless API Workspace | API documentation

Get a Billing Request Template

12 Month Gold Plan

Get a Billing Request Template Billing Requests GoCardless integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from GoCardless.

Get a Billing Request Template Billing Requests GoCardless | GoCardless API Workspace | API documentation

Billing Requests-Billing Request Templates

Billing Requests GoCardless integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from GoCardless.

Billing Requests GoCardless | GoCardless API Workspace | API documentation

Initiate your Billing Request

Create a Billing Request Flow

🚀 Getting Started-Step 1 - Taking a first instant payment with mandate set up

Retrieve a fulfilled Billing Request

Create a Direct Debit Payment

🚀 Getting Started-Step 2 - Collecting payments against a mandate

List Events

🚀 Getting Started-Step 3 - Monitor Webhooks

🇦🇺 PayTo Mandate

🚀 Getting Started-Next steps-Explore global payment journeys

Create a Billing Request (Mandate)

Collect Customer Details

Collect Bank Account Details

Confirm Customer & Bank Account Details

Fulfill a Billing Request

Create a Payment

🚀 Getting Started-Next steps-Custom Payment Pages-Direct Debit

Create an Instant Payment Billing Request

List Institutions for Billing Request

Select Institution for a Billing Request

Create a Bank Authorisation

Get a Billing Request

🚀 Getting Started-Next steps-Custom Payment Pages-Open Banking - Instant Bank Pay

PayTo Mandate and Payment

Billing Requests-Billing Requests-Billing Request Examples

Create a Billing Request

Cancel a Billing Request

Trigger Fallback

Change Currency for a Billing Request

Notify Customer of Billing Request

List Billing Requests

Billing Requests-Billing Requests

Initialise a Billing Request Flow

Billing Requests-Billing Request Flows

Get Bank Authorisation

Billing Requests-Bank Authorisations

Create a Billing Request Template

Update a Billing Request Template

List Billing Request Templates

Billing Requests-Institutions

Create a Block

Create Blocks by Reference

Disable a Block

Enable a Block

Get a Block

List Blocks

Core Endpoints-Block

Create a Creditor

Update a Creditor

List Creditors

Get a single Creditor

Core Endpoints-Creditors

Create a Customer Bank Account

Update a Customer Bank Account

List Customer Bank Accounts

Get a single Customer Bank Account

Disable a Customer Bank Account

Core Endpoints-Customer Bank Accounts

List Currency Exchange

Core Endpoints-Currency Exchange Rates

Create a Customer

Update a Customer

List Customers

Get a single Customer

Remove a Customer

Core Endpoints-Customers

Create a Creditor Bank Account

List Creditor Bank Accounts

Get a single Creditor Bank Account

Disable a Creditor Bank Account

Core Endpoints-Creditors Bank Accounts

Handle a notification

Core Endpoints-Customer Notifications

Get a single Event

Core Endpoints-Events

Create Instalment Schedules (with schedule)

List Instalment Schedules

Get a Single Instalment Schedules

Update an Instalment Schedule

Cancel an Instalment Schedule

Core Endpoints-Instalment Schedules

Create a Mandate

Update a Mandate

List Mandates

Get a single Mandate

Cancel a Mandate

Reinstate a Mandate

Core Endpoints-Mandates

Create New Mandate Import

Submit Mandate Import

Cancel Mandate Import

Get a Single Mandate import

Core Endpoints-Mandate Imports

Add Mandate import Entry

List All Mandate Import Entries

Core Endpoints-Mandate Import Entries

Create a Payer Authorisation

Update a Payer Authorisation

Submit a Payer Authorisation

Confirm a Payer Authorisation

Get a Payer Authorisation

Core Endpoints-Payer Authorisations (deprecated)

Update a Payment

List Payments

Get a single Payment

Retry Payment

Cancel a Payment

Core Endpoints-Payments

List Payouts

Get a single Payout

Update a Payout

Core Endpoints-Payouts

List All Payout Items

Core Endpoints-Payout Items

Create a Redirect Flow

Complete a single Redirect Flow

Get a single Redirect Flow

Core Endpoints-Redirect Flows

Create a Refund

Update a Refund

List Refunds

Get a single Refund

Core Endpoints-Refunds

Billing Request Fulfilled Scenario

Billing Request Fulfilled & Payment Paid Out Scenario

Billing Request Fulfilled & Payment Failed Scenario

Payment Submitted Scenario

Payment Confirmed Scenario

Payment Paid Out Scenario

Payment Failed Scenario

Payment Charged Back Scenario

Payment Charged Back Settled Scenario

Payment Late Failure Scenario

Payment Late Failure Settled Scenario

Mandate Activated Scenario

Mandate Failed Scenario

Mandate Expired Scenario

Mandate Customer Approval Granted Scenario

Mandate Customer Approval Skipped Scenario

Mandate Transferred Scenario

Mandate Transferred with Resubmission Scenario

Refund Paid Scenario

Refund Settled Scenario

Refund Bounced Scenario

Refund Returned Scenario

Payout Bounced Scenario

Creditor Verification Status Action Required Scenario

Creditor Verification Status in Review Scenario

Creditor Verification Status Successful Scenario

Core Endpoints-Scenario Simulators

Create a Scheme Identifier

List Scheme Identifiers

Get a Scheme Identifier

Core Endpoints-Scheme Identifiers

Create a Subscripton

Update a Subscription

List Subscriptions

Get a single Subscription

Pause a Subscription

Cancel a Subscription

Resume a Subscription

Core Endpoints-Subscriptions

List Tax Rates

Get a Single Tax Rate

Core Endpoints-Tax Rates

Get updated customer bank details

Core Endpoints-Transferred Mandates

List Webhooks

Get a Webhook

Retry a Webhook

Core Endpoints-Webhooks

Create a Mandate PDF

Bank Details Lookup

Healthcheck

Helper Endpoints

Embed Flow-1. Creditors

Embed Flow-2. (Optional) Creditors Bank Accounts

Embed Flow-3. (Optional) Scheme Identifiers

4.1 Create a Billing Request (Mandate)

4.2 Collect Customer Details

4.3 Collect Bank Account Details

4.4 Confirm Customer & Bank Account Details

4.5 Fulfill a Billing Request

4.6 Create a Payment

Embed Flow-4. Create Mandate & Payment

Create a logo

Embed Flow-Branding-Logos

Create a Payer theme

Embed Flow-Branding-PayerThemes

List Exports

Get Export

Embed Flow-Exports

GoCardless makes it easy to collect both recurring and one-off payments directly from customers&#39; bank accounts. Review our full API documentation <a href="https://developer.gocardless.com/api-reference">here.</a> For a general overview of GoCardless and links to share with your business stakeholders, please share this link <a href="https://developer.gocardless.com/getting-started/introduction">here.</a>

<h1>Setup</h1>

1. Create a GoCardless Sandbox account <a href="https://manage-sandbox.gocardless.com/sign-up">here</a>: the sandbox is our dedicated testing environment where you can build and test your integration without touching real money.

2. Go to <a href="https://manage-sandbox.gocardless.com/developers/access-tokens/create">Developers &gt; Create &gt; Access Token</a> to generate an API access token. Give it a memorable name, with read-write access.

<img src="https://content.pstmn.io/0dfaf33e-fbff-4ba9-836a-3ba2da42734f/MjAyMy4wNy4yMSBhdCAxNC40Ny4wOEAyeC5wbmc=" width="270" height="163">

3. [Run in Qodex] to [fork] the collection into Qodex to synchronize with future updates. Do this whilst logged into your Qodex account (sign up <a href="https://identity.getQodex.com/signup">here</a>).

<img src="https://content.pstmn.io/6fe085d7-eee3-4af4-9090-3aa7e15a9e09/MjAyMy4wMS4xNyBhdCAxNi4xOS40M0AyeC5wbmc=" width="422" height="458">

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. Copy the access token from step 2. and add it to your [Qodex Environment] as a secret variable named <code>ACCESS_TOKEN</code>

6. Make sure the GC Sandbox environment is selected in the Environment drop-down in the top right corner of Qodex when making requests from the imported collection.

<h1>Things to Note</h1>

<ol>
<li>There are additional URL parameters that can be passed, we recommended going through our API Developer Guide <a href="https://developer.gocardless.com/api-reference/#core-endpoints">here</a> and amending the requests as necessary.</li>
<li>The Bank Account field requirements will vary depending on the scheme and payment method - please update the relevant requests accordingly. See more info <a href="https://developer.gocardless.com/api-reference/#appendix-local-bank-details">here</a>.</li>
<li>Our requests are chained together automatically via Environment variables, so there is no need to copy &amp; paste IDs across requests.</li>
<li>Enjoy!</li>
</ol>

GoCardless API

GoCardless API projects on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from GoCardless.

GoCardless APIs | GoCardless API API Integration | QodexAI API Network