Developer Resources
GoCardless CLI
Installation Testing Webhooks (CLI) About CLI gocardless gocardless analytics gocardless analytics disable gocardless analytics enable gocardless analytics status gocardless cancel gocardless completion gocardless config gocardless config current-session gocardless create gocardless delete gocardless get gocardless get creditor gocardless get customer gocardless get customer_bank_account gocardless get customer_notification gocardless get event gocardless get mandate gocardless get mandate_import gocardless get payer_authorisation gocardless get payment gocardless get payout gocardless get refund gocardless get subscription gocardless get webhook gocardless list gocardless list creditors gocardless list customer_bank_accounts gocardless list customer_notifications gocardless list customers gocardless list events gocardless list mandate_imports gocardless list mandates gocardless list payer_authorisations gocardless list payments gocardless list payouts gocardless list refunds gocardless list subscriptions gocardless list webhooks gocardless listen gocardless login gocardless mcp gocardless mcp add gocardless mcp add claude gocardless mcp add codex gocardless mcp remove gocardless mcp remove claude gocardless mcp remove codex gocardless mcp run gocardless open gocardless trigger gocardless trigger billing_request_fulfilled gocardless trigger billing_request_fulfilled_payment_failed gocardless trigger billing_request_fulfilled_payment_paid_out gocardless trigger billing_request_pending gocardless trigger mandate_activated gocardless trigger mandate_expired gocardless trigger mandate_failed gocardless trigger mandate_pending_submission gocardless trigger mandate_transferred gocardless trigger payment_chargeback_settled gocardless trigger payment_charged_back gocardless trigger payment_confirmed gocardless trigger payment_failed gocardless trigger payment_paid_out gocardless trigger payment_pending_submission gocardless trigger payment_submitted gocardless update gocardless versionGoCardless Postman Collection
Getting Setup
Create a GoCardless Sandbox account here: The sandbox is our dedicated testing environment where you can build and test your integration without touching real money.
Go to Developers > Create > Access Token to generate an API access token. Give it a memorable name, with read-write access. Copy out your access token, as you'll need this later
Getting Started
To get started you can fork the collection from Gocardless's public workspace within Postman.
Forking the collection
From within the Gocardless's public workspace, fork the GoCardless API collection:
Enter a name for your fork and select the workspace where it will be created, also check the "watch this collection" checkbox to stay up to date with our APIs
Setting up your environment
You'll need to create a new environment to store your GoCardless tokens and other config variables.
Environment variables in postman are denoted by a template string with curly braces (e.g. {{variable}}). To get started set the token variable to the token created earlier, when setting up a sandbox account.
Make sure the GC Sandbox environment that you’ve just created is selected in the Environment drop-down in the top right corner of Postman when making requests from the imported collection.
Making a test call
Head over to the collection and send any request you like.
Things to Note
There are additional URL parameters that can be passed, we recommended going through our API Developer Guide here and amending the requests as necessary.
The Bank Account field requirements will vary depending on the scheme and payment method - please update the relevant requests accordingly. See more info here.
Our requests are chained together automatically via Environment variables, so there is no need to copy & paste IDs across requests.
Enjoy!