GoCardless MCP connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

   .env

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>

3. Authorize and make your first call

   Node.js

   quickstart.ts

   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   
   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENV_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions
   
   const connector = 'gocardlessmcp'
   const identifier = 'user_123'
   
   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize GoCardless MCP:', link)
   process.stdout.write('Press Enter after authorizing...')
   await new Promise(r => process.stdin.once('data', r))
   
   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'gocardlessmcp_get_environment',
     toolInput: {},
   })
   console.log(result)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "gocardlessmcp"
   identifier = "user_123"
   
   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize GoCardless MCP:", link_response.link)
   input("Press Enter after authorizing...")
   
   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="gocardlessmcp_get_environment",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)

What you can do

Connect this agent connector to let your agent:

• Feedback submit — Submit a helpfulness rating (1–5) for the current MCP session, with an optional comment
• Read gocardless resource — Read the contents of a GoCardless resource by URI to fetch API endpoint details or documentation
• List subscriptions, refunds, payouts — List subscriptions (recurring payment schedules), optionally filtered by status, customer, or mandate
• Gocardless integrate with — Return an overview of GoCardless integration options for collecting one-off and recurring payments
• Get subscription, refund, payout — Retrieve a single subscription (recurring payment schedule) by its subscription ID

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

gocardlessmcp_get_customer#Retrieve a single customer by ID, with PII fields partially masked.1 param▾

Retrieve a single customer by ID, with PII fields partially masked.

NameTypeRequiredDescription

idstringrequiredCustomer ID (e.g. CU000123)

gocardlessmcp_get_environment#Return the current GoCardless environment (sandbox or live) and setup instructions.0 params▾

Return the current GoCardless environment (sandbox or live) and setup instructions.

gocardlessmcp_get_mandate#Retrieve a single mandate (Direct Debit authorisation) by its mandate ID.1 param▾

Retrieve a single mandate (Direct Debit authorisation) by its mandate ID.

NameTypeRequiredDescription

idstringrequiredMandate ID (e.g. MD000123)

gocardlessmcp_get_payment#Retrieve a single payment by its payment ID.1 param▾

Retrieve a single payment by its payment ID.

NameTypeRequiredDescription

idstringrequiredPayment ID (e.g. PM000123)

gocardlessmcp_get_payout#Retrieve a single payout (bank settlement) by its payout ID.1 param▾

Retrieve a single payout (bank settlement) by its payout ID.

NameTypeRequiredDescription

idstringrequiredPayout ID (e.g. PO000123)

gocardlessmcp_get_refund#Retrieve a single refund by its refund ID.1 param▾

Retrieve a single refund by its refund ID.

NameTypeRequiredDescription

idstringrequiredRefund ID (e.g. RF000123)

gocardlessmcp_get_subscription#Retrieve a single subscription (recurring payment schedule) by its subscription ID.1 param▾

Retrieve a single subscription (recurring payment schedule) by its subscription ID.

NameTypeRequiredDescription

idstringrequiredSubscription ID (e.g. SB000123)

gocardlessmcp_integrate_with_gocardless#Return an overview of GoCardless integration options for collecting one-off and recurring payments.0 params▾

Return an overview of GoCardless integration options for collecting one-off and recurring payments.

gocardlessmcp_list_customers#List customers, optionally filtered by creation date range.5 params▾

List customers, optionally filtered by creation date range.

NameTypeRequiredDescription

afterstringoptionalCursor for next page

created_at_gtestringoptionalFilter: created at or after this ISO 8601 datetime

created_at_ltestringoptionalFilter: created at or before this ISO 8601 datetime

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

sort_directionstringoptionalSort direction: asc or desc

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

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

NameTypeRequiredDescription

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

afterstringoptionalCursor for next page

created_at_gtestringoptionalFilter: created at or after this ISO 8601 datetime

created_at_ltestringoptionalFilter: created at or before this ISO 8601 datetime

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

mandatestringoptionalFilter by mandate ID

paymentstringoptionalFilter by payment ID

payoutstringoptionalFilter by payout ID

refundstringoptionalFilter by refund ID

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

subscriptionstringoptionalFilter by subscription ID

gocardlessmcp_list_mandates#List mandates (Direct Debit authorisations), optionally filtered by status, customer, or scheme.5 params▾

List mandates (Direct Debit authorisations), optionally filtered by status, customer, or scheme.

NameTypeRequiredDescription

afterstringoptionalCursor for next page

customerstringoptionalFilter by customer ID

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

schemestringoptionalFilter by scheme: bacs, sepa_core, ach, autogiro, becs, becs_nz, betalingsservice, faster_payments, pad, pay_to

statusstringoptionalFilter by status: pending_customer_approval, pending_submission, submitted, active, suspended_by_payer, failed, cancelled, expired, consumed, blocked

gocardlessmcp_list_payments#List payments, optionally filtered by status, customer, mandate, subscription, currency, or date range.10 params▾

List payments, optionally filtered by status, customer, mandate, subscription, currency, or date range.

NameTypeRequiredDescription

afterstringoptionalCursor for next page (from previous response's next_cursor)

created_at_gtestringoptionalFilter: created at or after this ISO 8601 datetime

created_at_ltestringoptionalFilter: created at or before this ISO 8601 datetime

currencystringoptionalFilter by currency code (e.g. GBP, EUR, USD)

customerstringoptionalFilter by customer ID (e.g. CU000123)

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

mandatestringoptionalFilter by mandate ID (e.g. MD000123)

sort_directionstringoptionalSort direction: asc or desc

statusstringoptionalFilter by status: pending_submission, submitted, confirmed, paid_out, cancelled, customer_approval_denied, failed, charged_back

subscriptionstringoptionalFilter by subscription ID (e.g. SB000123)

gocardlessmcp_list_payouts#List payouts (bank settlements), optionally filtered by status, currency, or date range.6 params▾

List payouts (bank settlements), optionally filtered by status, currency, or date range.

NameTypeRequiredDescription

afterstringoptionalCursor for next page

created_at_gtestringoptionalFilter: created at or after this ISO 8601 datetime

created_at_ltestringoptionalFilter: created at or before this ISO 8601 datetime

currencystringoptionalFilter by currency code (e.g. GBP, EUR, USD)

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

statusstringoptionalFilter by status: pending, paid, bounced

gocardlessmcp_list_refunds#List refunds, optionally filtered by payment, mandate, or date range.6 params▾

List refunds, optionally filtered by payment, mandate, or date range.

NameTypeRequiredDescription

afterstringoptionalCursor for next page

created_at_gtestringoptionalFilter: created at or after this ISO 8601 datetime

created_at_ltestringoptionalFilter: created at or before this ISO 8601 datetime

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

mandatestringoptionalFilter by mandate ID

paymentstringoptionalFilter by payment ID

gocardlessmcp_list_subscriptions#List subscriptions (recurring payment schedules), optionally filtered by status, customer, or mandate.5 params▾

List subscriptions (recurring payment schedules), optionally filtered by status, customer, or mandate.

NameTypeRequiredDescription

afterstringoptionalCursor for next page

customerstringoptionalFilter by customer ID

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

mandatestringoptionalFilter by mandate ID

statusstringoptionalFilter by status: pending_customer_approval, active, cancelled, finished, paused

gocardlessmcp_read_gocardless_resource#Read the contents of a GoCardless resource by URI to fetch API endpoint details or documentation.1 param▾

Read the contents of a GoCardless resource by URI to fetch API endpoint details or documentation.

NameTypeRequiredDescription

uristringrequiredThe gocardless:// resource URI to read

gocardlessmcp_submit_feedback#Submit a helpfulness rating (1–5) for the current MCP session, with an optional comment.2 params▾

Submit a helpfulness rating (1–5) for the current MCP session, with an optional comment.

NameTypeRequiredDescription

ratingnumberrequiredHow helpful was this session? 1 = not helpful at all, 5 = extremely helpful

commentstringoptionalOptional additional feedback