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

List Scheme Identifiers

Cursor pointing to the start of the desired set.

after

Cursor pointing to the end of the desired set.

before

limit

Unique identifier, beginning with “CR”.

creditor

"{\n    \"scheme_identifiers\": [\n        {\n            \"id\": \"SU0000169FT5KX\",\n            \"created_at\": \"2024-06-21T14:39:45.471Z\",\n            \"name\": \"Your Company Name\",\n            \"scheme\": \"bacs\",\n            \"reference\": \"948284\",\n            \"status\": \"active\",\n            \"minimum_advance_notice\": 3,\n            \"can_specify_mandate_reference\": true,\n            \"currency\": \"GBP\",\n            \"address_line1\": \"1600 Pennsylvania Ave NW\",\n            \"address_line2\": null,\n            \"address_line3\": null,\n            \"city\": \"Washington\",\n            \"region\": \"DC\",\n            \"postal_code\": \"N1 2AG\",\n            \"country_code\": \"GB\",\n            \"email\": \"stodorov@gocardless.com\",\n            \"phone_number\": \"+44 7500 560560\"\n        },\n        {\n            \"id\": \"SU0000147R7J67\",\n            \"created_at\": \"2022-07-21T09:56:43.122Z\",\n            \"name\": \"GoCardless\",\n            \"scheme\": \"pay_to\",\n            \"reference\": \"00000000\",\n            \"status\": \"active\",\n            \"minimum_advance_notice\": 0,\n            \"can_specify_mandate_reference\": false,\n            \"currency\": \"AUD\",\n            \"address_line1\": \"338-346 Goswell Road\",\n            \"address_line2\": null,\n            \"address_line3\": null,\n            \"city\": \"London\",\n            \"region\": null,\n            \"postal_code\": \"EC1V 7LQ\",\n            \"country_code\": \"GB\",\n            \"email\": \"help@gocardless.com\",\n            \"phone_number\": \"+44 20 7183 8674\"\n        },\n        {\n            \"id\": \"SU00001332ZRCP\",\n            \"created_at\": \"2021-12-06T11:47:26.393Z\",\n            \"name\": \"GoCardless\",\n            \"scheme\": \"sepa_instant_credit_transfer\",\n            \"reference\": \"00000000\",\n            \"status\": \"active\",\n            \"minimum_advance_notice\": 0,\n            \"can_specify_mandate_reference\": false,\n            \"currency\": \"EUR\",\n            \"address_line1\": \"Sutton Yard\",\n            \"address_line2\": \"65 Goswell Road\",\n            \"address_line3\": null,\n            \"city\": \"London\",\n            \"region\": null,\n            \"postal_code\": \"EC1V 7EN\",\n            \"country_code\": \"GB\",\n            \"email\": \"help@gocardless.com\",\n            \"phone_number\": \"+33 1 70 37 71 23\"\n        },\n        {\n            \"id\": \"SU000013316FBT\",\n            \"created_at\": \"2021-12-06T11:45:47.477Z\",\n            \"name\": \"GoCardless\",\n            \"scheme\": \"sepa_credit_transfer\",\n            \"reference\": \"00000000\",\n            \"status\": \"active\",\n            \"minimum_advance_notice\": 0,\n            \"can_specify_mandate_reference\": false,\n            \"currency\": \"EUR\",\n            \"address_line1\": \"Sutton Yard\",\n            \"address_line2\": \"65 Goswell Road\",\n            \"address_line3\": null,\n            \"city\": \"London\",\n            \"region\": null,\n            \"postal_code\": \"EC1V 7EN\",\n            \"country_code\": \"GB\",\n            \"email\": \"help@gocardless.com\",\n            \"phone_number\": \"+33 1 70 37 71 23\"\n        },\n        {\n            \"id\": \"SU0000126T6TE4\",\n            \"created_at\": \"2021-03-24T20:12:53.408Z\",\n            \"name\": \"GoCardless\",\n            \"scheme\": \"faster_payments\",\n            \"reference\": \"000000\",\n            \"status\": \"active\",\n            \"minimum_advance_notice\": 0,\n            \"can_specify_mandate_reference\": false,\n            \"currency\": \"GBP\",\n            \"address_line1\": \"Sutton Yard\",\n            \"address_line2\": \"65 Goswell Road\",\n            \"address_line3\": null,\n            \"city\": \"London\",\n            \"region\": null,\n            \"postal_code\": \"EC1V 7EN\",\n            \"country_code\": \"GB\",\n            \"email\": \"help@gocardless.com\",\n            \"phone_number\": \"+44 20 7183 8674\"\n        },\n        {\n            \"id\": \"SU000011QF0FME\",\n            \"created_at\": \"2019-05-07T14:55:04.408Z\",\n            \"name\": \"GoCardless\",\n            \"scheme\": \"ach\",\n            \"reference\": \"00000000\",\n            \"status\": \"active\",\n            \"minimum_advance_notice\": 1,\n            \"can_specify_mandate_reference\": false,\n            \"currency\": \"USD\",\n            \"address_line1\": \"Sutton Yard\",\n            \"address_line2\": \"65 Goswell Road\",\n            \"address_line3\": null,\n            \"city\": \"London\",\n            \"region\": null,\n            \"postal_code\": \"EC1V 7EN\",\n            \"country_code\": \"GB\",\n            \"email\": \"help@gocardless.com\",\n            \"phone_number\": \"+44 20 7183 8674\"\n        },\n        {\n            \"id\": \"SU000011KS8MGJ\",\n            \"created_at\": \"2018-11-06T12:48:09.886Z\",\n            \"name\": \"GoCardless\",\n            \"scheme\": \"pad\",\n            \"reference\": \"2185310000\",\n            \"status\": \"active\",\n            \"minimum_advance_notice\": 3,\n            \"can_specify_mandate_reference\": false,\n            \"currency\": \"CAD\",\n            \"address_line1\": \"Sutton Yard\",\n            \"address_line2\": \"65 Goswell Road\",\n            \"address_line3\": null,\n            \"city\": \"London\",\n            \"region\": null,\n            \"postal_code\": \"EC1V 7EN\",\n            \"country_code\": \"GB\",\n            \"email\": \"help@gocardless.com\",\n            \"phone_number\": \"+44 20 7183 8674\"\n        },\n        {\n            \"id\": \"SU000011HK9K00\",\n            \"created_at\": \"2018-09-13T13:20:26.964Z\",\n            \"name\": \"GoCardless\",\n            \"scheme\": \"becs_nz\",\n            \"reference\": \"1220559\",\n            \"status\": \"active\",\n            \"minimum_advance_notice\": 2,\n            \"can_specify_mandate_reference\": false,\n            \"currency\": \"NZD\",\n            \"address_line1\": \"Sutton Yard\",\n            \"address_line2\": \"65 Goswell Road\",\n            \"address_line3\": null,\n            \"city\": \"London\",\n            \"region\": null,\n            \"postal_code\": \"EC1V 7EN\",\n            \"country_code\": \"GB\",\n            \"email\": \"help@gocardless.com\",\n            \"phone_number\": \"+44 20 7183 8674\"\n        },\n        {\n            \"id\": \"SU000011GZP1SS\",\n            \"created_at\": \"2018-06-15T10:36:29.985Z\",\n            \"name\": \"GoCardless\",\n            \"scheme\": \"betalingsservice\",\n            \"reference\": \"09025677\",\n            \"status\": \"active\",\n            \"minimum_advance_notice\": 6,\n            \"can_specify_mandate_reference\": false,\n            \"currency\": \"DKK\",\n            \"address_line1\": \"Sutton Yard\",\n            \"address_line2\": \"65 Goswell Road\",\n            \"address_line3\": null,\n            \"city\": \"London\",\n            \"region\": null,\n            \"postal_code\": \"EC1V 7EN\",\n            \"country_code\": \"GB\",\n            \"email\": \"help@gocardless.com\",\n            \"phone_number\": \"+44 20 7183 8674\"\n        },\n        {\n            \"id\": \"SU000011E9TRP2\",\n            \"created_at\": \"2018-03-28T16:25:48.549Z\",\n            \"name\": \"GoCardless\",\n            \"scheme\": \"becs\",\n            \"reference\": \"488299\",\n            \"status\": \"active\",\n            \"minimum_advance_notice\": 0,\n            \"can_specify_mandate_reference\": false,\n            \"currency\": \"AUD\",\n            \"address_line1\": \"Level 9\",\n            \"address_line2\": \"401 Collins Street\",\n            \"address_line3\": null,\n            \"city\": \"Melbourne\",\n            \"region\": null,\n            \"postal_code\": \"VIC 3000\",\n            \"country_code\": \"AU\",\n            \"email\": \"help@gocardless.com\",\n            \"phone_number\": \"+61 3 8375 9198\"\n        },\n        {\n            \"id\": \"SU0000113K6WGA\",\n            \"created_at\": \"2015-09-29T12:35:41.600Z\",\n            \"name\": \"GoCardless\",\n            \"scheme\": \"autogiro\",\n            \"reference\": \"3171634\",\n            \"status\": \"active\",\n            \"minimum_advance_notice\": 8,\n            \"can_specify_mandate_reference\": false,\n            \"currency\": \"SEK\",\n            \"address_line1\": \"Sutton Yard\",\n            \"address_line2\": \"65 Goswell Road\",\n            \"address_line3\": null,\n            \"city\": \"London\",\n            \"region\": null,\n            \"postal_code\": \"EC1V 7EN\",\n            \"country_code\": \"GB\",\n            \"email\": \"help@gocardless.com\",\n            \"phone_number\": \"+44 20 7183 8674\"\n        },\n        {\n            \"id\": \"SU0000112CA5TT\",\n            \"created_at\": \"2015-08-05T11:20:10.823Z\",\n            \"name\": \"GoCardless\",\n            \"scheme\": \"sepa\",\n            \"reference\": \"GB27ZZZSDDBARC0000007495895\",\n            \"status\": \"active\",\n            \"minimum_advance_notice\": 3,\n            \"can_specify_mandate_reference\": false,\n            \"currency\": \"EUR\",\n            \"address_line1\": \"Sutton Yard\",\n            \"address_line2\": \"65 Goswell Road\",\n            \"address_line3\": null,\n            \"city\": \"London\",\n            \"region\": null,\n            \"postal_code\": \"EC1V 7EN\",\n            \"country_code\": \"GB\",\n            \"email\": \"SU0000112CA5TT@example.com\",\n            \"phone_number\": \"+44 20 7183 8674\"\n        }\n    ],\n    \"meta\": {\n        \"cursors\": {\n            \"before\": null,\n            \"after\": null\n        },\n        \"limit\": 50\n    }\n}"

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

List Scheme Identifiers Core Endpoints GoCardless | GoCardless API Workspace | API documentation

Core Endpoints-Scheme Identifiers

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

Core Endpoints GoCardless | GoCardless API Workspace | API documentation

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

Github

Twitter

Developer Website

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

Key	Datatype	Required	Description
after	null		Cursor pointing to the start of the desired set.
before	null		Cursor pointing to the end of the desired set.
limit	null		Number of records to return.
creditor	null		Unique identifier, beginning with “CR”.