GoCardless 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!