PassKit TypeScript SDK

The PassKit TypeScript SDK makes it quick and easy to work with PassKit's APIs for branded digital membership cards, coupons, boarding passes, and event tickets for Apple Wallet and Google Wallet.

Table of Contents

• Quickstart
• Installation
• Usage
• Documentation
• GUI Tool
• Getting Help
• Development
• License

Quickstart

1. Create a PassKit account — sign up for free.
2. Get your SDK credentials from the Developer Tools section of your profile.
3. Choose the type of pass you want to create:
   • Membership cards
   • Coupons
   • Boarding passes
   • Event tickets

See the PassKit Typescript quickstart for a complete application and credential setup.

Installation

npm install @passkit/typescript-grpc-sdk

Node.js 20 or later is required.

Usage

Create protobuf messages using the generated schemas:

import { create } from "@bufbuild/protobuf";
import {
  IdSchema,
  type Id,
} from "@passkit/typescript-grpc-sdk/io/common/common_objects_pb";

const id: Id = create(IdSchema, { id: "123" });

The main public namespaces are also available from the package root:

import { ct, io } from "@passkit/typescript-grpc-sdk";

The generated GenService exports describe RPC methods and message schemas. Applications are responsible for configuring a compatible transport with the PassKit endpoint and SDK credentials for their region.

Documentation

• PassKit official documentation
• PassKit SDK guides

GUI Tool

The PassKit GUI is available from your PassKit account.

Getting Help

• Email support@passkit.com
• Use the PassKit online chat

Development

Most files under src/ are generated. Update the source protocol definitions and regenerate the SDK instead of editing generated modules by hand.

npm ci
npm test
npm pack --dry-run

The test command builds type declarations, ESM, and CommonJS output and checks root and nested imports in both module systems.

License

Distributed under the MIT License. See LICENSE.