GoCardless MCP connector for AI agents

GoCardless MCP tools for AI agents

CALL ANY TOOL

12 tools covering get.

gocardlessmcp_list_events

List events

List audit log events for state changes across all resources, optionally filtered by resource type, action, or date range.

Parameters

Name

Type

Required

Description

action

string

Optional

Filter by action (e.g. created, confirmed, failed, paid_out, cancelled)

after

string

Optional

Cursor for next page

created_at_gte

string

Optional

Filter: created at or after this ISO 8601 datetime

created_at_lte

string

Optional

Filter: created at or before this ISO 8601 datetime

limit

number

Optional

Number of results per page (default 50, max 500)

mandate

string

Optional

Filter by mandate ID

payment

string

Optional

Filter by payment ID

payout

string

Optional

Filter by payout ID

refund

string

Optional

Filter by refund ID

resource_type

string

Optional

Filter by resource type: payments, mandates, payouts, refunds, subscriptions, instalment_schedules

subscription

string

Optional

Filter by subscription ID

gocardlessmcp_get_payout

Get payout

gocardlessmcp_list_payouts

List payouts

gocardlessmcp_get_refund

Get refund

gocardlessmcp_list_refunds

List refunds

gocardlessmcp_get_mandate

Get mandate

gocardlessmcp_list_mandates

List mandates

gocardlessmcp_get_payment

Get payment

gocardlessmcp_list_payments

List payments

gocardlessmcp_get_customer

Get customer

gocardlessmcp_list_customers

List customers

gocardlessmcp_get_environment

Get environment

gocardlessmcp_list_subscriptions

List subscriptions

gocardlessmcp_get_subscription

Get subscription

gocardlessmcp_create_refund

Create refund

gocardlessmcp_submit_feedback

Submit feedback

gocardlessmcp_create_payment

Create payment

Create a one-off payment against an existing mandate. The mandate must be active or pending submission, and the payment currency must match the mandate's currency.

Parameters

Name

Type

Required

Description

amount

number

Required

Amount in minor units (e.g. pence for GBP, cents for USD).

currency

string

Required

ISO 4217 currency code. Must match the mandate's currency.

mandate_id

string

Required

ID of the mandate to charge (e.g. MD000123). Must be in pending_submission, submitted, or active state.

charge_date

string

Optional

Optional charge date (YYYY-MM-DD). Omit to use the next possible charge date for the mandate.

confirmed

boolean

Optional

Set true only after the user has explicitly confirmed the preview in their most recent message. Default false (returns a preview).

count

number

Optional

Number of identical payments to create against the same mandate (max 25, default 1). When >1, returns a bulk preview before executing.

description

string

Optional

Optional name for the payment shown in the GoCardless dashboard and on payer confirmation emails. Helps merchants and payers identify the payment (e.g. "Admin fee", "Invoice 123").

faster_ach

boolean

Optional

ACH only. Set true to explicitly use Faster ACH, false for standard ACH. Omit to let the presence or absence of charge_date determine the processing speed.

preview_token

string

Optional

Required when confirmed=true: the preview_token field from this tool's own preceding preview response (the confirmed=false call for these exact same parameters). Rejected if missing, mismatched, already used, or if confirmed=true arrives too soon after the preview : a preview_token is only valid a few seconds after being issued, since it exists to prove a genuine user reply happened in between, not just that a preview call was made. If confirmed=true is rejected for being too soon, wait for the user's actual next message before trying again; do not immediately retry.

reference

string

Optional

Custom bank statement reference. Scheme-specific length limits apply (e.g. 10 chars for Bacs, 140 for SEPA). Not supported for Faster Payments. Bacs custom references require GoCardless Plus/Pro/Enterprise.

retry_if_possible

boolean

Optional

Automatically retry the payment on failure using intelligent retries. Requires Success+ to be enabled in the GoCardless dashboard. Default false.

gocardlessmcp_read_gocardless_resource

Read gocardless resource

gocardlessmcp_create_subscription

Create subscription

Create a recurring subscription against a mandate, scheduling regular payments on a weekly, monthly, or yearly interval.

Parameters

Name

Type

Required

Description

amount

number

Required

Amount per payment in minor units (e.g. pence for GBP, cents for EUR).

currency

string

Required

ISO 4217 currency code (e.g. GBP, EUR, USD). Must match the mandate's scheme.

interval_unit

string

Required

Time unit between charges: weekly, monthly, or yearly.

confirmed

boolean

Optional

Set true only after the user has explicitly confirmed the preview in their most recent message. Default false (returns a preview).

count

number

Optional

Total number of payments to take. Omit (or set 0) for an indefinite subscription.

day_of_month

number

Optional

Day of month to charge (1-28, or -1 for last day). Required for monthly and yearly subscriptions.

interval

number

Optional

Number of interval_units between charges. Must be ≥ 1. Defaults to 1.

mandate_id

string

Optional

ID of the mandate to create the subscription against (e.g. MD000123).

mandate_ids

array

Optional

For bulk creation: list of mandate IDs to create the subscription against (max 25). Use instead of mandate_id.

metadata

object

Optional

Key-value store of custom data. Up to 3 keys, key names up to 50 chars, values up to 500 chars.

month

string

Optional

Month to charge, lowercase (e.g. january). Required for yearly subscriptions.

name

string

Optional

Name for the subscription (max 255 chars). Used as the description on each payment created.

payment_reference

string

Optional

Reference shown on the customer's bank statement. For Bacs: requires own Service User Number.

preview_token

string

Optional

retry_if_possible

boolean

Optional

Retry failed payments using intelligent retries (Success+). Defaults to false. Requires Success+ enabled in the GoCardless dashboard.

start_date

string

Optional

Date of the first payment (YYYY-MM-DD). Must be on or after the mandate's next_possible_charge_date. Defaults to next_possible_charge_date if omitted.

gocardlessmcp_integrate_with_gocardless

Integrate with gocardless

gocardlessmcp_create_payment_link

Create payment link

Create a Billing Request : a single-use GoCardless-hosted authorisation link for a specific payer, supporting mandate setup, one-off IBP payments, or VRP consent.

Parameters

Name

Type

Required

Description

scheme

string

Required

Payment scheme for the mandate (or for IBP when payment_only=true). Examples: faster_payments, bacs, sepa_core, ach, pad, becs, pay_to.

amount

number

Optional

Amount in minor units (e.g. pence for GBP). Required when payment_only=true.

constraints_end_date

string

Optional

Latest date by which payments can be taken (YYYY-MM-DD). Leave unset for an open-ended agreement.

constraints_max_amount_per_payment

number

Optional

Maximum amount in minor units that can be charged per payment. Required for PayTo and VRP mandates.

constraints_start_date

string

Optional

Earliest date from which payments can be taken (YYYY-MM-DD). Defaults to the day the payer authorises.

currency

string

Optional

ISO 4217 currency code. Required when amount is set.

customer_bank_account_id

string

Optional

Existing GoCardless customer bank account ID to pre-fill, skipping the bank account collection step.

customer_id

string

Optional

Existing GoCardless customer ID to link, optional.

description

string

Optional

Description shown to the payer during authorisation.

fallback_enabled

boolean

Optional

If true, the billing request can fall back to Direct Debit if the payer's bank does not support the requested scheme (IBP or VRP). Applies to both IBP payment requests and VRP mandate requests. Do not set if GoCardless payment intelligence is enabled.

mandate_verify

string

Optional

Verification preference for the mandate: minimum, recommended (default), when_available, or always.

payment_context_code

string

Optional

Payment context for cVRP mandates. One of: billing_goods_and_services_in_advance, billing_goods_and_services_in_arrears, pisp_payee, ecommerce_merchant_initiated_payment, face_to_face_point_of_sale, transfer_to_self, transfer_to_third_party, bill_payment, ecommerce_goods, ecommerce_services, other, party_to_party. Required for cVRP.

payment_only

boolean

Optional

Set true for a payment-only (IBP) flow : no mandate will be created. Requires amount and currency.

payment_purpose_code

string

Optional

Underlying payment purpose for cVRP mandates (e.g. loan_repayment, bank_loan_delayed_draw_funding, salary_payment). See VRP Commercial Payment Purpose Codes for the full list. Required for cVRP.

payment_request_scheme

string

Optional

Override the IBP scheme used for the payment_request in a combined flow. Omit to let the API infer from currency. Only valid when amount is set and payment_only=false.

periodic_limit_alignment

string

Optional

How the period resets: calendar (end of current period, e.g. end of month) or creation_date (same date next period). Defaults to creation_date.

periodic_limit_max_total_amount

number

Optional

Maximum total amount in minor units that can be charged within the periodic_limit_period. Required for VRP mandates.

periodic_limit_period

string

Optional

Period for the VRP periodic limit. One of: intraday, day, week, fortnight, month, quarter, half_year, year, flexible. Required when setting a periodic limit.

purpose_code

string

Optional

High-level purpose category for the mandate and/or payment. Common values: loan, salary_payment, supplier_payment, tax_payment, commercial, consumer, dividend, pension_payment. See Billing Request Purpose Codes for the full list.

redirect_uri

string

Optional

URL to redirect the payer to after they complete the GoCardless-hosted flow. This is the post-flow landing page : not the bank authorisation redirect used in CPP flows. Omit to use the GoCardless default success screen.

sweeping

boolean

Optional

Set true for sVRP (Sweeping VRP) : money moved between accounts owned by the same payer. Only valid for faster_payments mandate-only flows; do not combine with payment_only=true.

gocardlessmcp_cancel_mandate

Cancel mandate

gocardlessmcp_create_payment_template_link

Create payment template link

gocardlessmcp_cancel_payment

Cancel payment

Build your Agent

Same auth pattern across every framework.

token = client.agent.get_token(user_id="user_id", connector="gocardlessmcp")

const token = await client.agent.getToken({ userId: "user_id", connector: "gocardlessmcp" });

const token = await client.agent.getToken({ userId: "user_id", connector: "gocardlessmcp" });

token = client.agent.get_token(user_id="user_id", connector="gocardlessmcp")

Try these prompts

Paste any prompt into your agent to get started.

Get started

SEE HOW AUTH WORKS

User authorises once. Every agent call after uses their token with scope enforcement.

Authorize

Your user connects

GoCardless MCP

once. We tie it to their identity and the meetings they approved — no shared bot account, no org-wide access

Who:

user ‘A’

when:

Once per user

access:

Limited to user

Store

Their

GoCardless MCP

token lives in a vault scoped to them. User A's meetings are never reachable by an agent acting for user B, even on the same connection

vault:

encrypted

scope:

per-user

tokens:

auto-refreshed

Resolve

When your agent calls a

GoCardless MCP

tool, we fetch the right token server-side. It never touches your agent, never appears in the LLM context, never shows up in your logs

speed:

~40ms

check:

before every call

seen by:

nobody

Audit

Every

GoCardless MCP

tool call is logged — who triggered it, which meeting was fetched, what came back. 90 days of history, tied to the user who authorized it

history:

90 days

export:

SIEM-ready

logged:

every call

Test other agents

See the same per-user auth pattern across other connectors.

GTM and RevOps Teams

Revenue forecast commentary

Pulls open pipeline from Salesforce and HubSpot, calculates coverage against quota, flags at-risk stages, posts commentary to Slack, and logs every snapshot to Google Sheets.

GTM and RevOps Teams

Deal room sync

Pulls opportunity context from Salesforce, captures key decisions from Slack, and syncs a running summary to the deal room doc in Google Drive, but only when the deal actually changed.

People Ops and HR teams

Offer letter routing agent

Drafts the offer in PandaDoc, blocks on the hiring manager's approval in Slack, then emails the candidate their e-signature link. Every call runs as the recruiter who triggered it, never a shared HR bot.

GTM and RevOps Teams

CRM AI agent

Reads the Granola transcript after every call, extracts next steps and updates the HubSpot record, drafts the follow-up in Gmail, and confirms in Slack, all on the rep's own delegated OAuth.

Why Scalekit

Secure your agent's access. Connectors ship in minutes

01.

Shared tokens break per-user analytics

“Our agents act across Salesforce, Gong, Google Drive, and more, on behalf of every customer. Scalekit behind the scenes meant we can keep adding tools without ever rebuilding how credentials or tool calling work.”

Venu Madhav Kattagoni

Head of Engineering / Von

FAQs

Frequently Asked Questions

Does the agent access GoCardless as the user or as a shared key?
As the user. Each workspace member authorizes once and Scalekit resolves their credential at request time. Audit logs attribute every action to that user, not a shared service account.

Where is the GoCardless OAuth token stored?
In Scalekit's managed AES-256 token vault, namespaced per tenant. Refresh is automatic. Revocation is a single dashboard action. Tokens never appear in prompts, logs, or LLM context.

Can I limit what the agent is allowed to do in GoCardless?
Yes. Pass a tool name filter to listScopedTools so the AI agent only sees the subset you authorize. Pre-API-call scope checks block out-of-policy actions before the request reaches GoCardless.

What happens when a user revokes GoCardless access?
The connection is invalidated on the next tool call. Subsequent requests for that user fail closed with a clear error. Other users in the tenant remain unaffected. The event is logged for audit.

Can the agent move money in GoCardless?
No. The toolset is read-only: customers, mandates, payments, payouts, refunds, and subscriptions. Scalekit scope checks block anything outside that list before it reaches GoCardless.

On this page

Tool and actions Framework Compatibility Starter Prompt Auth Lifecycle Try Other Agents Why Scalekit