How can I see the Bank Account Data API in action?

Accessing Bank Account Data through UI

We provide an open banking user interface (UI), which might help to understand how the user flow works and what the output data looks like. 

To get started, sign up on the Bank Account Data Portal. 

Once done, try connecting your own bank account in a simple interface that's available in the platform. 

To do this, please follow these steps.

1. Go to My Account Data section of the portal
2. Click Connect New Bank
3. Select the country
4. Select your bank from the list of banks provided
5. Provide your consent
6. Authenticate securely in your bank
7. Once redirected back to the Open Banking portal, view/download data from your linked account(s)

N.B.: Accounts connected via the Portal are not visible on the API and not visible to other users of the Portal. This way if test with a personal account, you are not sharing personal data.

If you wish to delete the connected account, please follow this guide: Deleting accounts connected through My Account Data

Accessing Bank Account Data through API

This detailed guide allows you to test the API via Postman online, without installing new software.

The steps below describe how to connect via Postman on our local machine:

Setting up Postman

To be able to check our Bank Account Data API, you would need to download and set up your Postman account. Here's how to do that. 

1. Download Postman

2. Create your Postman account

3. In Postman, select Collections > Import > Link

4. Enter the following URL: https://bankaccountdata.gocardless.com/api/swagger.json and click Continue

5. Open advanced settings and select Schema for both Request parameter generation and Response parameter generation, and click Import

After importing, you should have a new collection named "GoCardless Bank Account Data API" and a new API defined.

To make API requests using the imported collection: 

1. Find the relevant request in the collection

2. Adjust the request by entering the missing parameters

3. Send the request & receive a response

Please refer to Postman Learning Center for guidance on using Postman and making requests. 

Making API requests

Follow the steps described in our Quickstart Guide to make your first connection. 

For testing purposes, you can establish a connection with your own account or use our Sandbox institution.