> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect GoCardless with API Key – StackOne Hub

> Link a GoCardless account in the StackOne Hub using API Key. End-user guide to authorize the integration and start using GoCardless actions.

> [!WARNING]
>
> Access tokens are for using your own GoCardless account with the API. To build a partner integration that manages other users' accounts, use OAuth 2.0 instead. Tokens are environment-specific — a sandbox token only works with the Sandbox environment and a live token only with Production.

Select Actions to adjust the guideSome actions may require additional configuration in the provider to be accessible. Choose the actions you need and the guide will be updated.

Select all
Clear

ActionScope(s)

Loading actions...No actions match your search.

Dynamic Guide URL

Copy URL

Scopes Selected

<pre role="textbox" aria-readonly="true" tabIndex="0" />

Separator

Copy scopes

## Create a GoCardless access token

GoCardless authenticates API requests with a Bearer access token created from the dashboard.

**1. Sign in to GoCardless**

Sign in to the GoCardless dashboard for the environment you are connecting:

<ul>
  <li>**Production** — [GoCardless dashboard sign-in](https://manage.gocardless.com/sign-in); live tokens start with `live_`</li>
  <li>**Sandbox** — [GoCardless sandbox dashboard sign-in](https://manage-sandbox.gocardless.com/sign-in); sandbox tokens start with `sandbox_`</li>
  <li>Create the token in the same environment you will select in StackOne Hub — tokens only work in the environment they were created in.</li>
</ul>

![GoCardless sign in page with the Email address and Password fields](https://mintcdn.com/stackone-60/OmKBo4CDQOnMK2re/connectors/gocardless/images/api_key-config-sign-in.png?fit=max\&auto=format\&n=OmKBo4CDQOnMK2re\&q=85\&s=d3af23c878c88671f51e8fa6918e7386)

**2. Open API settings**

In the left sidebar, click **Developers**, then select **API settings**. The **Access tokens** section lists your existing tokens.

![The API Settings page with the Access tokens section and the Create dropdown in the top right corner](https://mintcdn.com/stackone-60/OmKBo4CDQOnMK2re/connectors/gocardless/images/api_key-config-api-settings.png?fit=max\&auto=format\&n=OmKBo4CDQOnMK2re\&q=85\&s=3d4dee96435f43ca53119590e99540c0)

**3. Create an access token**

On the **API Settings** page, click the **Create** dropdown in the top right corner, then select **Access token** from the menu.

![The Create dropdown on the API Settings page with the Access token option highlighted](https://mintcdn.com/stackone-60/OmKBo4CDQOnMK2re/connectors/gocardless/images/api_key-config-create-access-token.png?fit=max\&auto=format\&n=OmKBo4CDQOnMK2re\&q=85\&s=b2241636ae4bad35f09eea89c2b903b3)

**4. Configure the token**

Enables actions: Cancel A Mandate, Cancel A Payment, Cancel An Instalment Schedule, Cancel Billing Request, Cancel Subscription, Collect Bank Account For Billing Request, Collect Customer Details For Billing Request, Confirm Payer Details For Billing Request, Create A Creditor Bank Account, Create A Customer, Create A Customer Bank Account, Create A Mandate, Create A Payment, Create Billing Request, Create Billing Request Flow, Create Instalment Schedule With Dates, Create Instalment Schedule With Schedule, Create Refund, Create Subscription, Disable A Creditor Bank Account, Disable A Customer Bank Account, Fallback Billing Request To Direct Debit, Fulfil Billing Request, Get A Single Creditor, Get A Single Creditor Bank Account, Get A Single Customer, Get A Single Customer Bank Account, Get A Single Instalment Schedule, Get A Single Mandate, Get A Single Payment, Get A Single Payout, Get A Single Tax Rate, Get Billing Request, Get Event, Get Refund, Get Subscription, List Billing Requests, List Creditor Bank Accounts, List Creditors, List Customer Bank Accounts, List Customers, List Events, List Instalment Schedules, List Mandates, List Payments, List Payout Items, List Payouts, List Refunds, List Subscriptions, List Tax Rates, Notify Billing Request Customer, Pause Subscription, Reinstate A Mandate, Remove A Customer, Resume Subscription, Retry A Payment, Run Scenario Simulator, Update A Creditor, Update A Customer, Update A Customer Bank Account, Update A Mandate, Update A Payment, Update A Payout, Update An Instalment Schedule, Update Refund, Update Subscription

In the **Create access token** dialog, provide the token details, then click **Create**:

<ul>
  <li>**Name** — enter a descriptive name for the token (for example, `StackOne Integration`).</li>
  <li>**Scope** — select **Read-write access** for full API access (required to create, update, and cancel payments, mandates, subscriptions, and customers), or **Read only access** if you only need read operations.</li>
</ul>

![The Create access token dialog with the Name field and the Scope options Read only access and Read-write access](https://mintcdn.com/stackone-60/OmKBo4CDQOnMK2re/connectors/gocardless/images/api_key-config-token-dialog.png?fit=max\&auto=format\&n=OmKBo4CDQOnMK2re\&q=85\&s=fcdfed1af7f9604b3221b595b12bf27b)

<ul>
  <li>
    read\_only
  </li>

  <li>
    read\_write
  </li>
</ul>

**5. Copy the access token**

An **Access token successfully created** dialog appears with your new token in the **Token** field. The dialog warns: **Your access token can only be viewed once.**

<ul>
  <li>The token cannot be retrieved after this dialog is closed — copy it immediately and store it securely.</li>
  <li>Paste the copied value into the **Access Token** field in StackOne Hub.</li>
  <li>Click **I've copied this access token** to dismiss the dialog.</li>
</ul>

![The Access token successfully created dialog showing the Token field, the view-once warning, and the I've copied this access token button](https://mintcdn.com/stackone-60/OmKBo4CDQOnMK2re/connectors/gocardless/images/api_key-config-token-created.png?fit=max\&auto=format\&n=OmKBo4CDQOnMK2re\&q=85\&s=7c70581f5ef277f03ba8d1de8844a78c)

## Link the Account

**1. Connect**

<ul>
  <li>Click **Connect**.</li>
  <li>If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider's authorization flow.</li>
  <li>Once authorization is successful, you will see a confirmation popup.</li>
</ul>

**2. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Next Steps

> [card] [Webhooks setup](https://docs.stackone.com/connectors/gocardless/guides/webhook-setup.md)
>
> Configure receiving Events for GoCardless into StackOne.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.