GoCardless
Keep GoCardless in step with your orders, invoices and payments without re-keying, with the right person approving what changes.
26 ways to read, 2 ways to write, each write switched on by you.
Quality checks
Built and tested with example responses.
- Ready to connect: doneEvery listed action is built in.
- Built and tested with example responses: doneEach action is built from the provider’s published API and tested against example responses, errors, rate limits and paging.
Connected, approved, proven.
The things teams do most with GoCardless, an example flow with a person in the loop, and what Nexra keeps as proof.
Top actions
- Create customer
customers.createApproval by rule - List billing requests
billing_requests.listRead
Example flow
- GoCardless · List billing requests
billing_requests.listDone - GoCardless · Create customer
customers.createMaker-checker - Nexra · Record the decision and result in the evidence chainProven
Example workflow. Routine runs go through on their own. Only a change your rules flag, such as one over a limit you set, waits for the right person, who sees the exact change and the rule before it reaches GoCardless.
What gets logged
- Whether it ran on its own or who approved it, and under which rule
- A fingerprint of the exact request sent to GoCardless
- GoCardless's reply: what it created or changed
- One entry in the evidence chain, linked to the one before
Try this in the sandbox
Run the whole flow with test data in your sandbox, then connect a GoCardless test account before you go live.
For developers
Technical detail
GoCardless: customers, bank accounts, mandates, payments, payouts and items, subscriptions, instalment schedules, refunds, chargebacks, events, creditors, billing requests and blocks.
GoCardless API docs- Source actions
- 26
- Destination actions
- 2
- Data types
- 14
What you can map
Reads are always available. Writes are off until you switch them on for a connection, and governed writes follow your policies.
billing requests2
- Get billing requestSource
Read one GoCardless billing request by ID.
- List billing requestsSource
Read existing GoCardless billing requests; does not create or change them.
blocks2
- Get blockSource
Read one GoCardless block by ID.
- List blocksSourceIncremental
Read existing GoCardless blocks; does not create or change them.
creditors2
- Get creditorSource
Read one GoCardless creditor by ID.
- List creditorsSourceIncremental
Read existing GoCardless creditors; does not create or change them.
customer bank accounts2
- Get customer bank accountSource
Read one GoCardless customer bank account by ID.
- List customer bank accountsSourceIncremental
Read existing GoCardless customer bank accounts; does not create or change them.
customers4
- Create customerDestinationProvider duplicate protectionApproval before production
Create a customer record. It moves no money; mandates and payments are not created.
- Get customerSource
Read one GoCardless customer by ID.
- List customersSourceIncremental
Read existing GoCardless customers; does not create or change them.
- Update customerDestinationProvider duplicate protectionApproval before production
Update a customer's contact details, address or metadata.
disputes1
- List chargebacksSourceIncremental
Payment chargebacks from the GoCardless event feed (charged back, chargeback cancelled or settled against a payout), with the payment amount. Read only.
events2
- Get eventSource
Read one GoCardless event by ID.
- List eventsSourceIncremental
Read existing GoCardless events; does not create or change them.
instalment schedules2
- Get instalment scheduleSource
Read one GoCardless instalment schedule by ID.
- List instalment schedulesSourceIncremental
Read existing GoCardless instalment schedules; does not create or change them.
mandates2
- Get mandateSource
Read one GoCardless mandate by ID.
- List mandatesSourceIncremental
Read existing GoCardless mandates; does not create or change them.
payments2
- Get paymentSource
Read one GoCardless payment by ID.
- List paymentsSourceIncremental
Read existing GoCardless payments; does not create or change them.
payout items1
- List payout itemsSource
Read existing GoCardless payout items; does not create or change them.
payouts2
- Get payoutSource
Read one GoCardless payout by ID.
- List payoutsSourceIncremental
Read existing GoCardless payouts; does not create or change them.
refunds2
- Get refundSource
Read one GoCardless refund by ID.
- List refundsSourceIncremental
Read existing GoCardless refunds; does not create or change them.
subscriptions2
- Get subscriptionSource
Read one GoCardless subscription by ID.
- List subscriptionsSourceIncremental
Read existing GoCardless subscriptions; does not create or change them.
Access and limits
- Authentication
- GoCardless read access token
- Plans and access
- A GoCardless account with a read-write or read-only access token (or a partner OAuth token) for the creditor. Customer creation through the API is restricted to Pro and Enterprise accounts with approved payment pages; everything else here works with a standard access token.
- Test environment
- Use a sandbox access token with api-sandbox.gocardless.com.
- Rate limits
- 1,000 requests per minute per account; GoCardless returns HTTP 429 (rate_limit_exceeded) with a RateLimit-Reset HTTP date, which Nexra waits for (bounded) before retrying reads.
- Pagination
- Cursor pagination: after and limit (max 500); meta.cursors.after is null on the last page.
- Provider events
- GoCardless sends signed webhooks for payment, mandate, payout, refund and subscription events to the endpoint configured in the dashboard. Flows can start the moment something happens: when a payment succeeds; when a payment fails; when a payment is charged back; when a Direct Debit mandate is cancelled.
Before you build a flow
- Intentional exclusions: creating, cancelling, retrying or updating payments; creating or cancelling mandates and reinstating them; refunds; subscriptions and instalment schedules (create, pause, resume, cancel, update); billing request actions (fulfil, cancel, notify); outbound payments; blocks; customer bank account creation and disabling; mandate imports; customer removal.
- List filters are on creation time; read events.list since the last run to pick up status changes.
- Disputes: GoCardless has no dispute or chargeback resource. disputes.list reads payment chargeback events (charged_back, chargeback_cancelled, chargeback_settled) from the event feed, which keeps 18 months of history; charged-back amounts deducted from payouts also appear as payout items of type payment_charged_back.
- Customer bank accounts return only the last two digits of the account number; holder names, bank account tokens and blocked values are not mapped.
- Nested links, fx and event details follow GoCardless's documented resource shapes; only IDs and documented scalar fields are mapped.
Developer reference
- Create the GoCardless credentials described above with the narrowest permissions your flows need.
- In Nexra, open Connect, then Connections, then New connection, choose GoCardless, enter its settings and credentials, and tick only the write actions you need. Connection guide
- Test the connection, then use its actions as flow sources and destinations. Flow guide
Machine-readable detail: GET /api/public/connect/connectors/gocardless and the Connections API.