Postman Collection

Download the complete WalletPass.ai API collection for Postman to test all endpoints easily.

Download

Download WalletPass.ai API Collection

Setup

1. Import the Collection

   • Open Postman
   • Click "Import" button
   • Select the downloaded WalletPass.ai_API_Collection.postman_collection.json file
   • The collection will be imported with all endpoints organized in folders

2. Configure URL Variables The collection uses only URL variables (no other variables). Configure these in Postman:

   • pass_base_url: https://generate.walletpass.ai (or http://localhost:8082 for local)
   • tenant_manager_url: https://tenant.walletpass.ai (or http://localhost:8080 for local)
   • member_base_url: https://member.walletpass.ai (or http://localhost:8083 for local)
   • notification_service_url: https://notification.walletpass.ai (or http://localhost:8085 for local)

   To configure:

   • Right-click the collection → "Edit"
   • Go to "Variables" tab
   • Update the values as needed

3. Set API Keys

   • For endpoints requiring authentication, replace wp_your_api_key_here in the headers with your actual API key
   • For admin endpoints, replace admin@walletpass.ai with your admin email

Collection Structure

The collection is organized into the following folders:

Health Checks

• Pass Generation Service
• Tenant Manager Service
• Member Data Service
• Notification Service

Pass Generation

• Demo Pass (Apple)
• Demo Pass (Google)
• Create Pass from Member
• Download Pass

Pass Styles

• Create Pass Style
• List Pass Styles
• Get Pass Style
• Update Pass Style (Partial) - New: Supports partial updates
• Upload Style Asset - New: Automatically uses uploaded images for both normal and @2x versions
• Set Default Style
• Delete Pass Style

Style Groups

• Create Style Group
• List Style Groups
• Get Style Group

Members

• Register Member
• Get Member
• List Members
• Update Member Points
• Create Membership Program

Tenants

• Create Bearer Token
• List Bearer Tokens
• Onboard Tenant
• List Tenants
• Get Tenant Details

Distribution

• Send Pass via SMS (by pass_id)
• Send Pass via SMS (by member_id)

Features

• No Variables: Only URL variables are used (no other variables like api_key, pass_id, etc.)
• Organized: All endpoints are organized in folders by functionality
• Complete: Includes all available API endpoints
• Up-to-date: Collection is maintained to match the current API

Notes

• Partial Updates: The "Update Pass Style" endpoint now supports partial updates. Only provided fields are updated, others remain unchanged.
• Default Images: Default images (strip.png, strip@2x.png, icon.png, icon@2x.png) are only used when no custom images are uploaded.
• Default Colors: If no colors are provided, default WalletPass.ai brand colors are used:
  • Background: rgb(58, 77, 144)
  • Foreground: rgb(255, 255, 255) (white)
  • Label: rgb(255, 255, 255) (white)
• Image Uploads: When you upload an image for Apple or Google, it's automatically used for both the normal and @2x versions (unless you explicitly upload a @2x version).

Keeping the Collection Updated

The Postman collection is maintained alongside the API documentation. When new endpoints are added or existing ones change, the collection is updated accordingly.

To ensure you have the latest version:

1. Check the documentation for any API changes
2. Re-download the collection from this page
3. Re-import it into Postman (you may need to delete the old collection first)