Quick Start Guide

Get your first digital wallet pass up and running in minutes

Prerequisites

Before you begin, make sure you have:

  1. A Walletap account - Sign up for free

  2. Your API key from the Walletap dashboard

  3. A pass template created in your dashboard

Step 1: Create Your First Template

Templates define the visual design and structure of your passes. Think of them as the blueprint for your digital passes.

  1. Log in to your Walletap dashboard

  2. Navigate to Templates and click Create New Template

  3. Choose a pass type: Membership, Loyalty, Event Ticket, Gift Card, or Coupon

  4. Customize the design, colors, and fields for your pass

  5. Save your template and copy the Template ID

Step 2: Get Your API Key

Your API key authenticates your requests to the Walletap API.

  1. In your dashboard, navigate to Settings → API Keys

  2. Copy your API key (keep this secure!)

Step 3: Create Your First Pass

Now let's create an actual pass instance using your template:

curl -X POST https://www.walletap.io/api/pass \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "passes": [{
      "templateId": "your-template-id",
      "templateFields": {
        "memberName": "John Doe",
        "memberNumber": "12345",
        "validUntil": "2024-12-31T23:59:59Z"
      }
    }],
    "phone": "+1234567890",
    "sendTo": ["SMS", "EMAIL"]
  }'

Replace YOUR_API_KEY with your actual API key and your-template-id with your template ID.

The API will return URLs for each wallet platform:

{
  "id": "StknevxzYdKt76mjoC0q",
  "pass": {
    "apple": "https://firebasestorage.googleapis.com/...",
    "google": "https://pay.google.com/gp/v/save/...",
    "huawei": "https://walletpass-dre.cloud.huawei.com/..."
  },
  "badge": {
    "apple": "https://firebasestorage.googleapis.com/...",
    "google": "https://firebasestorage.googleapis.com/...",
    "huawei": "https://firebasestorage.googleapis.com/..."
  }
}

Step 4: Distribute Your Pass

You can distribute passes in several ways:

  • Automatic delivery - Include phone/email in your API request for automatic SMS/email delivery

  • Direct links - Use the returned pass URLs in your website or app

  • "Add to Wallet" buttons - Use the provided badge images for professional-looking buttons

What's Next?

Working with Templates

Learn how to create and customize templates for your digital passes

Learn More
Analytics & Tracking

Track your pass performance and user engagement metrics

Track performance and engagement metrics

Need Help?

Our support team is here to help you get started with Walletap.