Integrating GoCardless
Auth: API key · Partner program: not required · Setup time: about 10 minutes · Last verified: 2026-05-15
Direct-debit + bank-payment gateway. Primary in UK / EU SEPA / Australia BECS; mandates are first-class.
Auth model
Section titled “Auth model”api_key (long-lived access token). Submit it via the Connect Link form; the adapter sets Authorization: Bearer <token>.
GoCardless also offers OAuth for partner apps (“OAuth allows you to act on behalf of other GoCardless accounts”, https://docs.gocardless.com/docs/api-reference/oauth-reference). OpenSteward does not implement that partner-app flow: the access token above is the only way to connect.
Configure in admin
Section titled “Configure in admin”- Sign in at https://manage.gocardless.com (live) or https://manage-sandbox.gocardless.com (sandbox).
- Developers → Access tokens, generate a token, copy it.
- Open
/platforms→ Payments → GoCardless → Configure and submit:accessTokenenvironment—liveorsandbox
Webhooks
Section titled “Webhooks”Configure at Developers → Webhook endpoints. Subscribe to:
payments,refunds,subscriptions,mandates,payouts,customers
The adapter verifies the Webhook-Signature header (HMAC-SHA-256 of the raw body with the endpoint’s secret).
Quirks
Section titled “Quirks”Mandateis the canonical PaymentMethod for direct-debit semantics. The adapter surfaces mandates asPaymentMethodrows withtype: 'mandate'and stores the bank-account detail undermetadata.- Payment lifecycle is multi-step.
pending_submission → pending_customer_approval → submitted → confirmed → paid_out. The adapter maps each to the canonicalChargeStatus. - No Dispute resource — chargebacks emerge as
payment.failedwithcause = chargeback. GoCardless-Versionheader is pinned to2015-07-06(the stable API version).
References
Section titled “References”- API introduction: https://developer.gocardless.com/getting-started/api/introduction/
- Developer portal home: https://developer.gocardless.com/
opensteward.dev ·Plans and free license ·Terms ·Privacy ·support@opensteward.dev
© 2026 Falco Consulting AB. Built from open-steward/opensteward@a3961d8. This site sets no cookies, runs no analytics and loads nothing from other sites, except platform logos from Brandfetch on the Platforms page.