GoCardless API

Name: GoCardless API
Brand: GoCardless API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentPaymentsBilling Subscriptionsbearer63 EndpointsREST

For Agents

Collect direct debit payments, manage mandates and subscriptions, and reconcile payouts across major bank debit schemes. Designed for recurring billing automation.

Install Jentic One Beta

Connect the GoCardless API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the GoCardless API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with GoCardless API.

Create a customer and attach a customer bank account before setting up a mandate

Authorise a mandate via redirect flow or billing request and reuse it for ongoing collection

Charge a one-off payment against an existing mandate and check its settlement status

GET STARTED

Start building with GoCardless API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for GoCardless API, keeping it validated and agent-ready. The GoCardless API powers recurring payment collection via bank debit schemes including Bacs (UK), SEPA (Eurozone), ACH (US), BECS (Australia), Autogiro (Sweden), and PAD (Canada). It exposes customers, customer bank accounts, mandates, payments, subscriptions, payouts, refunds, events, redirect flows, billing requests, and webhooks. It is the standard interface for SaaS billing, membership organisations, and any business that wants to charge customers directly from their bank account on a recurring basis.

Use Cases

Patterns agents use GoCardless API for, with concrete tasks.

★ SaaS Subscription Billing

A SaaS company collects monthly subscription fees by direct debit. The integration creates a customer, walks the user through a redirect flow or billing request to authorise a mandate, then schedules a subscription against that mandate via /subscriptions. Failed payments surface through /events, and the system can pause, resume, or cancel the subscription without re-authorising the mandate.

Create a monthly subscription for customer 'CU12345' against mandate 'MD789' for £29 starting on the 1st of next month.

One-Off Invoice Collection

Membership and professional services firms use GoCardless to collect one-off invoices once a mandate is in place. POST /payments charges a specific amount against a mandate and the payment lifecycle (pending, submitted, confirmed, paid_out, failed) is observable via /events for accounting reconciliation.

Create a £450 payment against mandate 'MD789' with description 'Invoice 2026-04-118' and poll /events until it reaches paid_out.

Payout Reconciliation

Finance teams reconcile GoCardless payouts against their bank statements by pulling /payouts and the matching /payout_items. Each payout item links a settled payment, refund, or charge back to a specific payout, so accounting systems can trace every line on the bank statement.

List all payouts in May 2026 and pull the payout_items for each so finance can map them to the merchant bank deposits.

AI Agent Billing Operations

A finance AI agent uses Jentic to automate dunning and refund operations. It listens to GoCardless webhooks, retrieves failed payment events, and either retries the payment or cancels the subscription based on policy — all without holding the GoCardless access token in its prompt.

Search Jentic for 'retry failed gocardless payment', load the schema, and retry every payment that failed in the last 24 hours.

Key Endpoints

63 endpoints — jentic publishes the only available openapi specification for gocardless api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/customers

Create a new customer record

POST

/mandates

Create a mandate against a customer bank account

POST

/payments

Collect a one-off payment against a mandate

POST

/payments/{identity}/actions/retry

Retry a failed payment

POST

/subscriptions

Schedule a recurring subscription

POST

/subscriptions/{identity}/actions/cancel

Cancel a subscription

POST

/refunds

Issue a refund against a settled payment

GET

/payout_items

List the items inside a payout

POST

/customers

Create a new customer record

POST

/mandates

Create a mandate against a customer bank account

POST

/payments

Collect a one-off payment against a mandate

POST

/payments/{identity}/actions/retry

Retry a failed payment

POST

/subscriptions

Schedule a recurring subscription

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

GoCardless bearer tokens are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens — raw access tokens never enter the agent's context.

Intent-based discovery

Agents search by intent (e.g. 'collect a direct debit') and Jentic returns matching GoCardless operations with their input schemas, so the agent can pick the right endpoint across 63 paths without browsing docs.

Time to first call

Direct GoCardless integration: 3-7 days for redirect flow handling, webhook verification, and dunning logic. Through Jentic: a few hours — search, load schema, execute.

FAQs

Specific to using GoCardless API through Jentic.

Why is there no official OpenAPI spec for GoCardless API?

GoCardless publishes detailed reference documentation but does not ship a maintained OpenAPI specification. Jentic generates and maintains this spec so AI agents and developers can call GoCardless API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the GoCardless API use?

GoCardless uses HTTP bearer token authentication. Live and sandbox tokens are issued from the GoCardless dashboard. Through Jentic, the access token is stored encrypted in the vault and never enters the agent context.

Can I cancel a subscription with the GoCardless API?

Yes. POST /subscriptions/{identity}/actions/cancel cancels a subscription so no further payments are scheduled. The underlying mandate stays active so the customer can be re-subscribed without a new authorisation.

What are the rate limits for the GoCardless API?

The OpenAPI spec does not declare numeric rate limits. GoCardless publishes per-account limits in its developer documentation; in practice, paginate list endpoints and back off on HTTP 429 responses.

How do I retry a failed direct debit payment through Jentic?

Run a Jentic search for 'retry gocardless payment', load the schema for POST /payments/{identity}/actions/retry, and execute it with the payment ID. Install with pip install jentic and chain search, load, and execute.

Does the GoCardless API support refunds?

Yes. POST /refunds creates a refund against a settled payment, and GET /refunds/{identity} returns its status. Refunds settle through the payout cycle and appear as line items on the next /payout_items response.

GoCardless API

Connect the GoCardless API to your agent

Capabilities

Start building with GoCardless API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs