{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}
At a glance
- Availability: Experimental (how to enable).
- Authentication: API key.
- Connection: The key from
GOCARDLESS_ACCESS_TOKENis sent as theBearerprefixedAuthorizationheader. - Provider documentation: Authentication reference.
Credentials
Set these per environment. See Connect an integration.
Setup
- Create a sandbox account for testing: Sign up for a free GoCardless sandbox at https://manage-sandbox.gocardless.com/signup. The sandbox lets you create test customers, mandates, and payments without moving real money. Sandbox API requests go to https://api-sandbox.gocardless.com instead of https://api.gocardless.com.
- Create an access token: In the dashboard (https://manage.gocardless.com for live, https://manage-sandbox.gocardless.com for sandbox), go to Developers, then Create and choose Access token. Give it read-write access if you want to create payments.
- Store the token: Add GOCARDLESS_ACCESS_TOKEN=<your token> to your .env file. The token is sent as a Bearer token in the Authorization header.
- Verify access: Run the List Customers tool. Every request also sends the GoCardless-Version header (2015-07-06 by default), which the API requires.
Provider notes
- Tools call the live API at https://api.gocardless.com; for sandbox testing, point requests at https://api-sandbox.gocardless.com with a sandbox token
- Amounts are integers in the smallest currency unit (pence/cents), and payments can only be created against mandates in an active or pending state
- Every API request must include the GoCardless-Version header; each tool sends 2015-07-06 by default
Tools
Verify the connection
Call a read tool such as gocardless__list_customers with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.