Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

GoCardless MCP connector

OAuth 2.1/DCR Accounting & FinanceAIDeveloper Tools

Connect to GoCardless MCP. Retrieve and list customers, mandates, payments, payouts, refunds, and subscriptions, and explore integration options from your...

GoCardless MCP connector

  1. Install the SDK

    Section titled “Install the SDK”
    Terminal window
    npm install @scalekit-sdk/node

    Full SDK reference: Node.js | Python

  2. Set your credentials

    Section titled “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

    Section titled “Authorize and make your first call”
    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)

What you can do

Section titled “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

Section titled “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.

Name Type Required Description
id string required Customer 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.

Name Type Required Description
id string required Mandate 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.

Name Type Required Description
id string required Payment 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.

Name Type Required Description
id string required Payout 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.

Name Type Required Description
id string required Refund 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.

Name Type Required Description
id string required Subscription 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.

Name Type Required Description
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)
sort_direction string optional Sort 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.

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_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.

Name Type Required Description
after string optional Cursor for next page
customer string optional Filter by customer ID
limit number optional Number of results per page (default 50, max 500)
scheme string optional Filter by scheme: bacs, sepa_core, ach, autogiro, becs, becs_nz, betalingsservice, faster_payments, pad, pay_to
status string optional Filter 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.

Name Type Required Description
after string optional Cursor for next page (from previous response's next_cursor)
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
currency string optional Filter by currency code (e.g. GBP, EUR, USD)
customer string optional Filter by customer ID (e.g. CU000123)
limit number optional Number of results per page (default 50, max 500)
mandate string optional Filter by mandate ID (e.g. MD000123)
sort_direction string optional Sort direction: asc or desc
status string optional Filter by status: pending_submission, submitted, confirmed, paid_out, cancelled, customer_approval_denied, failed, charged_back
subscription string optional Filter 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.

Name Type Required Description
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
currency string optional Filter by currency code (e.g. GBP, EUR, USD)
limit number optional Number of results per page (default 50, max 500)
status string optional Filter 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.

Name Type Required Description
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
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.

Name Type Required Description
after string optional Cursor for next page
customer string optional Filter by customer ID
limit number optional Number of results per page (default 50, max 500)
mandate string optional Filter by mandate ID
status string optional Filter 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.

Name Type Required Description
uri string required The 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.

Name Type Required Description
rating number required How helpful was this session? 1 = not helpful at all, 5 = extremely helpful
comment string optional Optional additional feedback