Postman Guide

1. Fork the Zip US Postman collection

1. Sign up or Sign in to your Postman account (https://postman.com).

2. Import the Zip US collection:

   • Select the Run in Postman button below:

   

3. Click the Gateway API Collection.

4. Select Fork near the top right of the screen.

2. Configure Authentication Variables

Every request in the collection uses Environment Variables. To set these:

1. In Postman, open your fork of Zip US API Collection.

2. Click the Environments tab.

3. Fork the Template Environment.

4. For each key, enter the Current Value:

   Variable	Description
   merchant_id	Your merchant ID (found under Settings in the Zip Merchant Portal).
   client_secret	Secret key for Signature Calculation (found under Settings in the Zip Merchant Portal).
   environment	.sand for sandbox; leave blank for production.
   Other variables	See full list in the API docs: https://docs.us.zip.co/reference/orders

5. Click Save.

📘

Note

The collection's pre-request scripts will automatically read the client_secret, calculate the signature, and inject the Q-XP-Signature header for you.

3. Make API Calls

Example: Authorize & Capture an Order

1. Authorize

   • Navigate to Gateway API → Orders → Authorize.
   • Add the order information into the request body.
   • Click Send.
   • Click on the console at the bottom of the screen.
   • Copy the URL in the console and paste it into a browser window. The URL should start with https://zip-checkout.sand.us.zip.co for sandbox or https://zip-checkout.us.zip.co for production.
   • Go through the Zip checkout flow.
   • Once completed, copy the orderID from the URL.

2. Capture

   • Go to Gateway API → Orders → Capture an Order.
   • Set the previously copied orderID into appropriate section in the capture URL.
   • Set the order information for the capture in the request body.
   • Click Send to capture payment against the authorized order.

Additional Resources

• Zip US API Reference
• Signing Requests
• Forking a Collection or Environment
• Support: Contact [email protected] or your dedicated account manager if you have any questions.