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 Events

Filter by event action: https://developer.gocardless.com/api-reference/#event-actions

action

Cursor pointing to the start of the desired set.

after

Cursor pointing to the end of the desired set.

before

ID of a billing request. If specified, this endpoint will return all events for the given billing request.

billing_request

Limit to records created after the specified date-time.

created_at[gt]

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

created_at[lte]

Limit to records created before the specified date-time.

created_at[lt]

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

created_at[gte]

ID of an creditor. If specified, this endpoint will return all events for the given creditor.

creditor

ID of an export. If specified, this endpoint will return all events for the given export.

export

Includes linked resources in the response. **Must be used with the resource_type parameter specified.** 

The include should be one of: 
- billing_request
- payment
- mandate
- payer_authorisation
- payout
- refund
- subscription
- instalment_schedule
- creditor
- scheme_identifier

include

ID of an instalment schedule. If specified, this endpoint will return all events for the given instalment schedule.

instalment_schedule

limit

ID of a mandate. If specified, this endpoint will return all events for the given mandate.

mandate

ID of an event. If specified, this endpoint will return all events whose parent_event is the given event ID.

parent_event

payer_authorisation

ID of a payment. If specified, this endpoint will return all events for the given payment.

payment

ID of a payout. If specified, this endpoint will return all events for the given payout.

payout

ID of a refund. If specified, this endpoint will return all events for the given refund.


refund

Type of resource that you’d like to get all events for. Cannot be used together with the billing_request, creditor, export,instalment_schedule, mandate, payer_authorisation, payment, payout, refund, scheme_identifier or subscription parameters. The type can be one of:

- billing_requests
- creditors
- exports
- instalment_schedules
- mandates
- payer_authorisations
- payments
- payouts
- refunds
- scheme_identifiers
- subscriptions

resource_type

ID of a scheme identifier. If specified, this endpoint will return all events for the given scheme identifier.

scheme_identifier

ID of a subscription. If specified, this endpoint will return all events for the given subscription.

subscription

A billing request flow has been created against this billing request.

The billing request flow has been visited.

Payment submitted to the banks. As a result, it can no longer be cancelled.

The payment has been paid out by GoCardless.

GoCardless has transferred the payout to the creditor's bank account. FX payouts will emit this event but will continue to have a `pending` status until we emit the `payout_fx_rate_confirmed` event.

The time window after submission for the banks to refuse a mandate has ended without any errors being received, so this mandate is now active.

Enough time has passed since the payment was submitted for the banks to return an error, so this payment is now confirmed.

The mandate has been submitted to the banks.

This billing request has been fulfilled, and the resources have been created.

Payer has confirmed all their details for this billing request.

Bank account details have been collected for this billing request.

Customer details have been collected for this billing request.

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

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

Core Endpoints-Events

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
action	null		Filter by event action: https://developer.gocardless.com/api-reference/#event-actions
after	null		Cursor pointing to the start of the desired set.
before	null		Cursor pointing to the end of the desired set.
billing_request	null		ID of a billing request. If specified, this endpoint will return all events for the given billing request.
created_at[gt]	null		Limit to records created after the specified date-time.
created_at[lte]	null		Limit to records created on or before the specified date-time.
created_at[lt]	null		Limit to records created before the specified date-time.
created_at[gte]	null		Curl curl -X GET 'https://api-sandbox.gocardless.com/events?action=&after=&before=&billing_request=&created_at[gt]=&created_at[lte]=&created_at[lt]=&created_at[gte]=&creditor=&export=&include=&instalment_schedule=&limit=&mandate=&parent_event=&payer_authorisation=&payment=&payout=&refund=&resource_type=&scheme_identifier=&subscription=' API Documentation Claim this page Report this page All Projects Powered byQodex.ai FAQs More Claim this page Report this page ENDPOINTS