Postman Collection
What is an API Collection?
The API Collection is a set of all the Tranzpay API requests. Using these boilerplate requests, you can test and explore Tranzpay’s APIs.
Why use an API Collection?
Going through the entire API documentation every time you need to test an API can be tedious. Using the Tranzpay API Collection can make the process of exploring APIs swift and effortless. It also significantly reduces the risk of errors.
Note
The Postman Collection does not substitute Tranzpay API documentation. We strongly recommend you use the Tranzpay API Collection along with the API documentation.
Step 1: Install the Postman app
Download and install the Postman app. You can skip this step if you have already installed the Postman app in your system. Please ensure your version is up to date.
Step 2: Create or select a Workspace. Click Collections and select the import button. Browse for the downloaded collection and click Upload Files.
Step 3: After importing the collection, you have to configure the environment. Click the quick view icon in the top right corner, and click Add in Environment section.
Add the following environment variables with their corresponding values:
USERNAME: The username provided by Tranzpay. You get this value when you request a Sandbox Account.
API_PASSWORD: The password provided by Tranzpay. You get this value when you request a Sandbox Account.
PRODUCERID: The Producer ID provided by Tranzpay. You get this value when you request a Sandbox Account.
ENDPOINT: The Endpoint URL for your request. The default is set to our Demo environment.
After adding all the environment variables, click Save.
Step 4: Invoke the APIs
Your boilerplate request is ready; you can now test the Tranzpay API calls.