Skip to content
REST API Reference & SDKs

Passinstance Developer Documentation

Build high-volume Apple Wallet (.pkpass) and Google Wallet integrations. Issue, update, scan, and broadcast real-time lockscreen notifications via production-grade REST APIs.

Get API Keys
Live docs workbench — snippets update as you type

Bundle Management

4 endpoints
POSThttps://api.passinstance.com/api/v1/bundles/upsertAPI Key
Bundle Management

Create or Update Bundle

Group up to 10 passes into a downloadable multi-pass bundle (.pkpasses / Google Wallet multi-save). Omit bundleId to create a new bundle, or pass an existing bundleId to update it.

Headers1 required
X-API-Keystring
Required

Workspace secret API key (pi_live_... or pi_test_...). You may alternatively send Authorization: ApiKey <key>.

Example: pi_live_98a7b6c5d4e3f2a1

Array of pass UUIDs (up to 10) and optional existing bundleId.

Request Body1 required • 1 optional
passesstring[] (UUID)
Required

Array of 1 to 10 pass UUIDs to bundle together.

Example: ["b1d972dc-eccf-4f87-ab21-25939d9213d8", "c2e083ed-fddf-4a98-bc32-36040e0324e9"]

Response Status Codes

GEThttps://api.passinstance.com/api/v1/bundles/{id}/passesAPI Key
Bundle Management

List Passes in Bundle

Retrieve the ordered list of passes belonging to a pass bundle with pagination or ID-only projection.

Headers1 required
X-API-Keystring
Required

Workspace secret API key (pi_live_... or pi_test_...). You may alternatively send Authorization: ApiKey <key>.

Example: pi_live_98a7b6c5d4e3f2a1
Path Parameters1 required
idstring (UUID)
Required

Pass bundle UUID.

Example: e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a8b
Query Parameters3 optional

Response Status Codes

POSThttps://api.passinstance.com/api/v1/bundles/{id}/voidAPI Key
Bundle Management

Void Bundle Passes

Mark all passes belonging to a pass bundle as voided across Apple Wallet and Google Wallet.

Headers1 required
X-API-Keystring
Required

Workspace secret API key (pi_live_... or pi_test_...). You may alternatively send Authorization: ApiKey <key>.

Example: pi_live_98a7b6c5d4e3f2a1
Path Parameters1 required
idstring (UUID)
Required

Pass bundle UUID.

Example: e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a8b

Confirmation flag and optional audit reason for voiding all passes in the bundle.

Request Body1 required • 1 optional
voidedboolean
Required

Must be set to true to void all passes in the bundle.

Example: true

Response Status Codes

DELETEhttps://api.passinstance.com/api/v1/bundles/{id}API Key
Bundle Management

Delete Bundle

Delete a pass bundle container without deleting the underlying individual pass records.

Headers1 required
X-API-Keystring
Required

Workspace secret API key (pi_live_... or pi_test_...). You may alternatively send Authorization: ApiKey <key>.

Example: pi_live_98a7b6c5d4e3f2a1
Path Parameters1 required
idstring (UUID)
Required

Pass bundle UUID to delete.

Example: e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a8b

Response Status Codes