Set up our Postman collection

With your API keys in hand, let's get you up and running with Postman 📬.

We've created a Postman Collection so that you can quickly and easily start testing what data you can get using Belvo. In this article, you'll learn how to install and configure our collection.

📘

Make sure you've installed the Postman App for Windows, Mac, or Chrome.

Download the Belvo API Collection

To install our Belvo API collection:

  1. Download the collection by clicking the button below.
    Run in PostmanRun in Postman
  2. When prompted, select where you want to open the collection.

✳️ Done! Let's quickly configure Postman so that you can easily use our API.

Configure Postman

Our Postman collections make use of environment variables to customize the requests that are sent. You can read more about environments in Postman's setting up an environment with variables article.

To create your environment variables:

  1. In Postman, click the eye icon.
  2. In the Environment section, click Add.

Adding an Environment

  1. Name your Environment, for example: Belvo Sandbox.
  2. Add the following environment variables:
    • secretId: your sandbox Secret Key ID.
    • secretPassword: your sandbox Secret Key PASSWORD.
    • baseUrlhttps://sandbox.belvo.com .

Configuring the variables

🚧

Make sure that your secretId, secretPassword and baseUrl are properly stored as the initial value AND current value. This is important to prevent potential errors

  1. Click Save.

✳️ Awesome! But before we go on, let's make sure that everything is working just fine with a simple call.

Test that it works!

Just to make sure you've set everything up correctly, let's see that that you can list all the institutions in our Sandbox environment.

  1. Make sure that you select your Belvo Sandbox environment.
  2. In the Belvo API folder, select Institutions → GET List.
  3. Click Send.

If everything is correctly set up, you should see a whole host of institutions appear!

✳️ And you're done! Now, let's make our first calls to the Belvo API!

Updated 3 days ago


Set up our Postman collection


With your API keys in hand, let's get you up and running with Postman 📬.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.