What’s included: 29 pre-configured requests across 10 folders, with example responses and an end-to-end test flow that walks request-otp → verify-otp → redeem → list → validate.
Quick import (recommended — 1 click)
Click the button below to fork the collection into your Postman workspace. If you don’t have Postman installed, you’ll be prompted to use the web app.
After the collection imports, separately import the environment template (next section), select Zupy Production as your active environment, and set api_key to your real zupy_pk_* key.
Download Files
Postman Collection
All 29 partner API endpoints organized by category
Environment Template
Pre-configured variables for the production environment
Setup Instructions
1
Import the collection
Open Postman, click Import, and drag in
zupy-partner-api.postman_collection.json.You’ll see the Zupy Partner API v2 collection with 10 folders:- Authentication (OTP)
- Customers
- Loyalty Programs
- Rewards
- Coupons
- Z$ Tokens
- Wallet
- Webhooks (inbound — partner → Zupy)
- Webhook Management (outbound config — Zupy → partner)
- Company
2
Import the environment
Click Import again and drag in
zupy-production.postman_environment.json.Select Zupy Production as your active environment in the top-right dropdown.3
Set your API key
Click the eye icon next to the environment selector, then click Edit.Set the
api_key variable to your actual API key (format: zupy_pk_*).4
Start testing
Run requests in order — the collection includes test scripts that auto-populate environment variables as you go.
Suggested Test Flow
Run the requests in this order for a complete end-to-end test:Auto-Capture Scripts
Key requests include test scripts that automatically save response values to your environment:
This means you can run requests sequentially without manually copying IDs between requests.
Environment Variables
Collection Authentication
All requests inherit theX-API-Key header from the collection-level authentication. You don’t need to set the header on individual requests.
For OTP-protected endpoints, add the X-OTP-Session header manually or use the auto-captured otp_session variable after verifying an OTP.
Next Steps
Getting Started
Follow the quickstart guide with code examples in cURL, Python, and JavaScript
API Reference
Browse all endpoints with full request/response schemas