Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

GoCardless (BYOK) — connector documentation

  • MCP endpoint: https://byok-gocardless.connectorbay.com/mcp
  • REST API: POST https://byok-gocardless.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-gocardless.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own GoCardless GoCardless live access token (read-only scope is enough), sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-gocardless.connectorbay.com/health · Tool schemas: https://byok-gocardless.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-gocardless · agent@connectorbay.com

What GoCardless (BYOK) is for

GoCardless (BYOK) lets an AI assistant read your own GoCardless data through the GoCardless API with a key you supply (GoCardless live access token (read-only scope is enough)). Read-only: 10 tools (list_customers, get_customer, list_payments, get_payment, list_mandates, list_subscriptions, list_payouts, list_refunds, list_events, list_creditors). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.gocardless.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by GoCardless. GoCardless and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Who are my newest GoCardless customers?"
  • "Show customer CU123"
  • "Which payments failed this month?"
  • "Show payment PM123"
  • "Which mandates are active?"
  • "What active subscriptions do I have?"

What it does

  • list_customers: List customers with name, email, address city, country and language.
  • get_customer: Get one customer by id (starts with CU).
  • list_payments: List payments with amount (in minor units), currency, charge date, status and linked mandate, customer and payout; filter by status, customer, mandate, subscription or date.
  • get_payment: Get one payment by id (starts with PM) with amount, status, charge date and links.
  • list_mandates: List Direct Debit mandates with reference, status, scheme, next possible charge date and linked customer.
  • list_subscriptions: List recurring subscriptions with name, amount, interval, start and end date and status.
  • list_payouts: List payouts to your bank account with amount, fees deducted, currency, arrival date and status.
  • list_refunds: List refunds with amount, currency, status and reference.
  • list_events: List events (what happened to payments, mandates, payouts and more) with time, resource type, action and details.
  • list_creditors: List the creditors (your business entities) on the account with name, address country and verification status.

BYOK key

You bring your own GoCardless GoCardless live access token (read-only scope is enough) (https://manage.gocardless.com/developers). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.gocardless.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the GoCardless API (api.gocardless.com) with a BYOK key; documentation: https://docs.gocardless.com/docs/api-reference/making-requests. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by GoCardless. GoCardless and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your GoCardless account.

Built for: Worldwide. Languages: English.