What is Postman
Postman is an Application Development Environment aka ADE. Postman is ideal for exploring and testing the PayJunction API. You can download the PayJunction Catalog and Environment files and import them into Postman.
Get Started
First you will need Postman. You may already have it as a browser extension or application. If you would like to get Postman, you can download the application here. It's free! Once you have Postman installed, follow these steps to setup PayJunction's API within Postman.
Production Environment
- Download the following Collection: PayJunction API Basic.postman_collection.json
- Click Import.
- Select or Drag and Drop the Collection file into Postman.
- After you import, choose the Collections tab:
- You will now see the PayJunction API Basic collection.
Development Environment - PayJunction Labs
- Download the Collection for PayJunction Labs Environment:
PayJunctionLabStarter.postman_environment.json - Upload it to your environments:
- Click the Gear and then Manage Environments
- Click the Import button.
- Select the PayJunctionLabStarter.postman_environment.json file that was downloaded in step 1, above.
- You will now see the following:
- Click the Gear and then Manage Environments
Initial Configuration
- Click on the environment name to edit (i.e. PayJunctionLab Starter):
- The url and the auth are already set to the default values for PayJunction Labs.
- For the appkey field, enter your API Key for the Value.
- You should already have the appkey from your API key request: If you do not have API Keys, submit a request here.
- Click Update:
Sending API Requests
If you followed the steps above, you can now submit API requests. Here's an example:
- Choose the PayJunctionLab Starter Environment.
- Click on the PayJunction API Basic collection to expand it:
- Click on the Customers folder to expand it:
- Click the GET customers option:
- Click Send:
- Your screen should have the results of the Customers API request:
Congratulations! You can now submit API requests. Use this to explore and learn the PayJunction API. If you are a developer, you can test requests that you are attempting in your code so that you can see the results.
401 Unauthorized Error
If you do not have the correct API key or Authentication you will get Status 401 Unauthorized returned.
If you do not have an API Key or the Key is not set up correctly you will see:
Click Here to request an API Application Key
Please give PayJunction Support a call if you would like any assistance using Postman.
PayJunction Support
800-601-0230 x 3
Monday to Friday, 6am to 5pm PT