---
title: "GoCardless Integration"
description: "Manage GoCardless institutions, requisitions, accounts, balances, and transactions"
---
The GoCardless integration provides access to manage GoCardless institutions, requisitions, accounts, balances, and transactions through the Integrate MCP server.

## Installation

The GoCardless integration is included with the SDK:

```typescript
import { gocardlessIntegration } from "integrate-sdk/server";
```

## Setup

### 1. Create a GoCardless OAuth App

1. Create an OAuth application for GoCardless
2. Configure your redirect URI
3. Note your Client ID and Client Secret

### 2. Configure the Integration on Your Server

Add the GoCardless integration to your server configuration. The integration automatically reads `GOCARDLESS_CLIENT_ID` and `GOCARDLESS_CLIENT_SECRET` from your environment variables:

```typescript
import { createMCPServer, gocardlessIntegration } from "integrate-sdk/server";

export const { client: serverClient } = createMCPServer({
  apiKey: process.env.INTEGRATE_API_KEY,
  integrations: [
    gocardlessIntegration({
      scopes: ["openid", "accounts", "transactions", "balances"], // Optional
    }),
  ],
});
```

You can override the environment variables by passing explicit values:

```typescript
gocardlessIntegration({
  clientId: process.env.CUSTOM_GOCARDLESS_ID,
  clientSecret: process.env.CUSTOM_GOCARDLESS_SECRET,
      scopes: ["openid", "accounts", "transactions", "balances"], // Optional
});
```

### 3. Client-Side Usage

The default client automatically includes all integrations. You can use it directly:

```typescript
import { client } from "integrate-sdk";

await client.authorize("gocardless");
const result = await client.gocardless.listInstitutions({});

console.log(result);
```

If you're using a custom client, add the integration to the integrations array:

```typescript
import { createMCPClient, gocardlessIntegration } from "integrate-sdk";

const customClient = createMCPClient({
  integrations: [gocardlessIntegration()],
});
```

## Configuration Options

<AutoTypeTable
  path="../src/integrations/gocardless.ts"
  name="GocardlessIntegrationConfig"
/>


## Default Scopes

These defaults are applied unless you override `scopes` in the integration config:

- `openid`
- `accounts`
- `transactions`
- `balances`

## Tools

### `gocardless_list_institutions`

List institutions

<AutoTypeTable
  path="generated/tool-params/gocardless.ts"
  name="GocardlessListInstitutionsParams"
/>

### `gocardless_create_requisition`

Create requisition

<AutoTypeTable
  path="generated/tool-params/gocardless.ts"
  name="GocardlessCreateRequisitionParams"
/>

### `gocardless_get_requisition`

Get requisition

<AutoTypeTable
  path="generated/tool-params/gocardless.ts"
  name="GocardlessGetRequisitionParams"
/>

### `gocardless_get_account`

Get account

<AutoTypeTable
  path="generated/tool-params/gocardless.ts"
  name="GocardlessGetAccountParams"
/>

### `gocardless_get_balances`

Get balances

<AutoTypeTable
  path="generated/tool-params/gocardless.ts"
  name="GocardlessGetBalancesParams"
/>

### `gocardless_get_transactions`

Get transactions

<AutoTypeTable
  path="generated/tool-params/gocardless.ts"
  name="GocardlessGetTransactionsParams"
/>

## Notes

- Category: Banking
- Authentication mode: OAuth