Skip to content
Developers

Wallet pass API

A single wallet pass API to create, update, and revoke Apple Wallet and Google Wallet passes, with webhooks for install, update, and redemption events.

  • REST API and webhooks
  • Apple Wallet + Google Wallet
  • Templates, batch, and sandbox
Start creating wallet passesBook a demo
Works on:
 Apple Wallet (.pkpass)Google Wallet (JWT & REST)

Passinstance REST API Explorer

v1.1 Live

Interactive examples for Auth, Template creation, and Pass issuance

POST/api/v1/passes
Issue a personalized Apple Wallet & Google Wallet pass bundle with direct download links.
curl -X POST https://api.passinstance.com/api/v1/passes \
  -H "X-API-Key: pi_live_9f82c4018e6a4b12" \
  -H "Content-Type: application/json" \
  -d '{
    "templateId": "tpl_gold_vip_001",
    "serialNumber": "MEM-2026-8819",
    "customFields": {
      "customerName": { "label": "MEMBER", "value": "Jane Doe" },
      "pointsBalance": { "label": "POINTS", "value": "1,450 pts" },
      "tier": { "label": "TIER", "value": "Gold VIP" }
    },
    "barcodeMessage": "PASS-MEM-2026-8819"
  }'
Response Payload
201 Created52ms
{
  "ok": true,
  "data": {
    "id": "pass_9842011a",
    "templateId": "tpl_gold_vip_001",
    "serialNumber": "MEM-2026-8819",
    "status": "active",
    "downloadUrl": "https://api.passinstance.com/api/v1/passes/pass_9842011a/download",
    "googleWalletUrl": "https://pay.google.com/gp/v/save/eyJhbGciOiJSUzI1...",
    "applePassUrl": "https://passinstance.com/p/pass_9842011a.pkpass",
    "createdAt": "2026-08-16T15:25:00Z"
  }
}
Overview

Passinstance exposes a wallet pass API so engineering teams can automate the full pass lifecycle: create passes from templates, update fields and barcodes, push notifications, and revoke passes — for both Apple Wallet and Google Wallet through one integration.

Webhooks notify your systems on install, update, and redemption, so wallet passes can stay in sync with your backend, CRM, or POS without polling.

Capabilities

Everything to run wallet passes in production

Pass lifecycle endpoints

Create, read, update, and revoke passes and templates with predictable REST endpoints and idempotent requests.

Webhooks for pass events

Receive install, update, and redemption events to keep your CRM, POS, or backend in sync in real time.

Wallet pass API

Create, update, and revoke passes programmatically with a REST API and webhooks for install, update, and redemption events.

QR codes and download links

Distribute passes through hosted Add to Wallet pages, QR codes, email, SMS, or POS — customers install in one tap, no app required.

Update notifications

Push live field changes and lock-screen notifications when a balance, status, gate, or offer changes — passes stay current on every device.

Geolocation and relevant locations

Attach relevant locations so a pass surfaces on the lock screen when a customer is near your store, venue, or pickup point.

Dates, expiry, and lifecycle

Set relevant dates and expiration, extend validity on scan, and manage the full pass lifecycle from issue to revoke.

FAQ

Frequently asked questions

What can the wallet pass API do?

It lets you create, update, and revoke Apple Wallet and Google Wallet passes programmatically, manage templates, push notifications, and receive webhooks for install, update, and redemption events.

Is there one API for both Apple and Google Wallet?

Yes. You integrate once and issue to both Apple Wallet and Google Wallet, rather than maintaining two separate integrations.

Does the API support webhooks?

Yes. Webhooks deliver pass events such as install, update, and redemption so your systems can react without polling.

Is there a sandbox for testing?

Yes. You can develop against sandbox environments and use the no-code editor to verify templates before issuing passes in production.

Build on the wallet pass API

Start free, grab your API keys, and automate Apple Wallet and Google Wallet passes with webhooks and templates.

Start creating wallet passesBook a demo