# GoCardless Postman Collection

> **Now available within Postman's API Network** The GoCardless API Collection is now hosted within [Gocardless's public workspace](https://www.postman.com/gocardlessapi/workspace/gocardless-api/overview) in Postman. This means you can now fork this collection from the public workspace into yours. Head over there to get started.

## Getting Setup

1. Create a GoCardless Sandbox account [here](https://manage-sandbox.gocardless.com/sign-up): The sandbox is our dedicated testing environment where you can build and test your integration without touching real money.
2. Go to [Developers > Create > Access Token](https://manage-sandbox.gocardless.com/developers/access-tokens/create) 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](https://www.postman.com/gocardlessapi/workspace/gocardless-api/overview) within Postman.

### Forking the collection

From within the  [Gocardless's public workspace](https://www.postman.com/gocardlessapi/workspace/gocardless-api/overview), fork the GoCardless API collection:

![Fork postman](https://images.ctfassets.net/b2dmfxhmyqno/2gdMhPKLO5GGEJkpf1IaRy/0324565994cc039e98c808128fe4d738/Screenshot_2023-01-12_at_10.48.52.png)

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.

![Screenshot 2023-01-12 at 10.53.27](https://images.ctfassets.net/b2dmfxhmyqno/6ZzFzNexAwneRwMn7Sy7Oj/241fd6b3671df61a8df64ae117cb74e4/Frame_1__1_.png)

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.

![Screenshot 2023-01-12 at 10.59.40](https://images.ctfassets.net/b2dmfxhmyqno/cQNUo5idiJcmO3alWc2O9/c021dfa2591a32b6f522d8cd30fbcedd/Frame_1__3_.png)

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.

![Screenshot 2023-01-12 at 11.03.48](https://images.ctfassets.net/b2dmfxhmyqno/1xvWBlhkNZ9HmB8iMGdtWT/764c60240e45744a04f6b9c9598d028d/Screenshot_2023-01-12_at_11.03.48.png)

## Things to Note

- There are additional URL parameters that can be passed, we recommended going through our API Developer Guide [here](https://developer.gocardless.com/api-reference/#core-endpoints) 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](https://developer.gocardless.com/api-reference/#appendix-local-bank-details).
- Our requests are chained together automatically via Environment variables, so there is no need to copy & paste IDs across requests.
- Enjoy!