# Documentation Postman Collection

Treezor Documentation has its own Postman Collection (opens new window) to help you understand how to use the Treezor API.

This collection is:

  • Connect-oriented – It doesn’t take into account legacy API services.
  • Sandbox-oriented – It doesn’t provide production-only features.
  • Non-exhaustive – It’s only meant to get you started, with key endpoints and attributes.

Before using the collection, ensure you already have the credentials for your Sandbox from Treezor.

If you’re new to Postman, the sections below may help you get started:

books icon

Reading – Postman Documentation

The Postman Documentation (opens new window) may provide more information on how to take advantage of the collection!

# Fork the collection

By clicking on the Run with Postman button, you’ll be invited to fork the collection. It consists of duplicating the collection to play with it without impacting the source collection and other users.

Fork collection popup screenshot
Bulb icon

Tip – Watch collection

Make sure you tick the “Watch original collection” checkbox. You’ll be notified when the collection is updated so you can pull the changes into your collection.

Once the copy of the collection is available in your Postman workspace, you may set up your environment.

# Set up your environment

You need to create an environment to start using your collection.

In the Postman Environment section, you can either:

  • Create a new environment, in which you will add the relevant variables listed below, or
  • Import this environment (opens new window) that you can download. It contains empty variables for you to fill in.

Then enter your environment URL and your credentials sent to you by Treezor in the variables:

Variable Description
baseUrl Your Sandbox environment URL.
client_id Your API authentication credentials provided to you by Treezor.
client_secret Your API authentication credentials provided to you by Treezor.

In addition, the following variables are necessary for some features:

Variable Description
cardPrint If you plan on issuing cards, you will need this value provided upon setting up your Card Program.
tariffId The fees applied to the Wallet, as defined by your contract with Treezor. This field is usually required to create Wallets but may have a default value set by Treezor.

As you use the collection, the environment variables will automatically be defined by the scripts included in each request.

# Structure of the collection

The collection is organized for you to navigate through the various illustrated uses.

Folder Description
Authentication Contains the POST /oauth/token endpoint for you to generate the access token necessary to authenticate all the Treezor API requests. We made it easily accessible as your token expires after 1 hour.
Starter endpoints Contains some of the essential endpoints to get started with the Treezor API. For more advanced features, please contact Treezor or refer to the API Documentation.
Quickstart Contains the endpoints for the Quickstart article, guiding you through your first testing of the Treezor API.
Use cases Contains the endpoints to run the step-by-step guides available in the Use Cases section of the documentation.

# Pull collection changes

The collection is constantly updated as the Treezor API and the documentation evolve.

If you’re watching the collection, you may have received a notification in Potman or an email indicating that the collection has been modified.

Pull changes notifs screenshot

To retrieve the modification, you may use the pull changes command for your collection. A tab opens in your forked collection to import all the changes made to your collection. More information is available in the Postman Documentation (opens new window).

Updated on: 6/20/2024, 8:00:57 AM