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 Payments

Cursor pointing to the start of the desired set.


after

Cursor pointing to the end of the desired set.


before

Limit to records where the payment was or will be collected from the customer’s bank account after the specified date.


charge_date[gt]

Limit to records where the payment was or will be collected from the customer’s bank account on or after the specified date.


charge_date[gte]

Limit to records where the payment was or will be collected from the customer’s bank account before the specified date.


charge_date[lt]

Limit to records where the payment was or will be collected from the customer’s bank account on or before the specified date.


charge_date[lte]

Limit to records created after the specified date-time.


created_at[gt]

Limit to records created on or after the specified date-time.


created_at[gte]

Limit to records created before the specified date-time.


created_at[lt]

Limit to records created on or before the specified date-time.


created_at[lte]

ID of a creditor to filter payments by. If you pass this parameter, you cannot also pass customer.

creditor

ISO 4217 currency code. Currently “AUD”, “CAD”, “DKK”, “EUR”, “GBP”, “NZD”, “SEK” and “USD” are supported.

currency

ID of a customer to filter payments by. If you pass this parameter, you cannot also pass creditor.

customer

limit

Unique identifier, beginning with “MD”. Note that this prefix may not apply to mandates created before 2016.

mandate

The direction to sort in. One of:
- asc
- desc

sort_direction

Field by which to sort records. One of:
- charge_date
- amount

sort_field

One of: 
- pending_customer_approval
- pending_submission
- submitted
- confirmed
- paid_out
- cancelled
- customer_approval_denied
- failed
- charged_back

status

Unique identifier, beginning with “SB”.

subscription

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

List Payments Core Endpoints GoCardless | GoCardless API Workspace | API documentation

Core Endpoints-Payments

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.
charge_date[gt]	null		Limit to records where the payment was or will be collected from the customer’s bank account after the specified date.
charge_date[gte]	null		Limit to records where the payment was or will be collected from the customer’s bank account on or after the specified date.
charge_date[lt]	null		Limit to records where the payment was or will be collected from the customer’s bank account before the specified date.
charge_date[lte]	null		Limit to records where the payment was or will be collected from the customer’s bank account on or before the specified date.
created_at[gt]	null		Limit to records created after the specified date-time.
created_at[gte]	null	Curl curl -X GET 'https://api-sandbox.gocardless.com/payments?after=&before=&charge_date[gt]=&charge_date[gte]=&charge_date[lt]=&charge_date[lte]=&created_at[gt]=&created_at[gte]=&created_at[lt]=&created_at[lte]=&creditor=&currency=&customer=&limit=&mandate=&sort_direction=&sort_field=&status=&subscription=' API Documentation Claim this page Report this page All Projects Powered byQodex.ai FAQs More Claim this page Report this page ENDPOINTS