Postman Collection Setup Guide

This guide explains how to import the Platform Next Merchant Portal Sample Postman collection, configure required variables, and begin testing endpoints securely and dynamically.

Step 1: Import the Collection into Postman

1. Download the postman collection .json file (e.g., Platform-Next-Merchant-Portal-Sample-Collection.postman_collection.json) from this repository.

2. Open the Postman desktop app.

3. Click the “Import” button (top-left corner).

4. Select the .json file you downloaded (e.g., Platform-Next-Merchant-Portal-Sample-Collection.postman_collection.json).

5. The collection will now appear under the Collections tab in your workspace.

Step 2: Set Required Collection Variables

After importing:

1. Hover over the collection name (e.g., Platform Next Merchant Portal Sample Collection).

2. Click the ellipsis (⋮) → choose “Edit”.

3. Go to the Variables tab and enter the following:

4. Click Save.

Step 3: Authenticate – Get Your Token

Before running any other requests:

1. Open the “Get Auth Token” request in the collection.

2. Click “Send”.

3. If your credentials are correct, this request will return a valid token and automatically store it in the auth_token variable.

4. This token will be used in all other authenticated requests.

⚠️ Do this every time your session/token expires.

Step 4: Test Any Other Endpoint

Once authenticated, you’re ready to run other requests in the collection. Most requests are configured to use dynamic variables (like random names, amounts, dates, and IDs) to make testing fast, isolated, and repeatable.

• You can now run any other request in the collection.

• All requests are configured to use dynamic variables and generate valid test data automatically, if necessary. These are set using pre-request scripts, so you can send the request without modifying anything.

• Examples include:

  • Creating and canceling payments

  • Creating templates and triggering payments from them

  • Submitting refunds

  • Bulk payments

  • Getting user information

Want to Use Your Own Data Instead?

You can easily disable the dynamic behavior and plug in your own values:

Option 1: Edit the Request Body Directly

• Go to the Body tab of the request

• Replace variables like {{fullName}}, {{paymentAmount}}, {{accountNumber}}, etc. with your own values.

🔒 Just make sure required fields are still filled in with valid formats.

Option 2: Comment Out the Pre-request Script

• Click the Scripts tab (formerly "Pre-request Script").

• Comment out or delete the code that sets random variables, so they don’t override your values.

• Save the request.

You Can Always Switch Back

If you want to revert to using dynamic test data later, just restore the pre-request script or re-import the collection.

💡Pro Tips

• Open View → Show Postman Console to inspect logs, generated variables, and token flow.

• All dynamic variables are generated at runtime (e.g., names, amounts, dates, IDs).

• Collection variables can be reused, updated, or cleared at any time via the collection settings.