Pass Types

Google Parameters

Parameters grouped by pass type for Google Loyalty, Coupon, Access Control, and Ticket passes.

Note: These API parameters represent the default field names. You can customize field names and configure which fields are available for your pass template using the Pass Dashboard.
Coupon

For discounts, offers, and promotional passes.

Appearance
hero.image file image (png)

Hero image displayed at the top of the pass. Must be PNG format and 1032x336 pixels in size.

NFC
nfc.message string

NFC payload (max 64 bytes). If empty, the pass defaults to Barcode if set to anything other than none.

Barcode
barcode.alt string

Text displayed below the barcode for manual entry.

barcode.data string default: 123456789

The data encoded in the barcode.

barcode.type enum<string>

The barcode format to display on the pass.

Available options:

  • QR_CODE (2D square barcode, high data capacity)
  • AZTEC (2D barcode, commonly used for tickets and boarding passes)
  • PDF_417 (2D stacked barcode, used for IDs and transport)
  • CODE_128 (1D barcode for alphanumeric data)
  • CODE_39 (1D barcode for alphanumeric data, widely supported)
  • CODABAR (1D barcode for libraries and blood banks)
  • EAN_8 (8-digit product barcode)
  • EAN_13 (13-digit product barcode)
  • ITF_14 (14-digit barcode for packaging)
  • UPC_A (12-digit product barcode)
Locations
latitude string

Latitude in degrees where pass should be highlighted.

longitude string

Longitude in degrees where pass should be highlighted.

Loyalty

For membership cards, rewards programs, and store cards.

Appearance
hero.image file image (png)

Hero image displayed at the top of the pass. Must be PNG format and 1032x336 pixels in size.

Loyalty
points.label string default: Reward Points

Label for primary loyalty points.

points.value integer

Primary loyalty points balance.

secondary.label string default: Points until reward

Label for secondary loyalty points.

secondary.value integer

Secondary loyalty points balance.

NFC
nfc.message string

NFC payload (max 64 bytes). If empty, the pass defaults to Barcode if set to anything other than none.

Barcode
barcode.alt string

Text displayed below the barcode for manual entry.

barcode.data string default: 123456789

The data encoded in the barcode.

barcode.type enum<string>

The barcode format to display on the pass.

Available options:

  • QR_CODE (2D square barcode, high data capacity)
  • AZTEC (2D barcode, commonly used for tickets and boarding passes)
  • PDF_417 (2D stacked barcode, used for IDs and transport)
  • CODE_128 (1D barcode for alphanumeric data)
  • CODE_39 (1D barcode for alphanumeric data, widely supported)
  • CODABAR (1D barcode for libraries and blood banks)
  • EAN_8 (8-digit product barcode)
  • EAN_13 (13-digit product barcode)
  • ITF_14 (14-digit barcode for packaging)
  • UPC_A (12-digit product barcode)
Back Fields
account.name string

Member name value. Visible on pass back.

account.id string

Member ID value. Visible on pass back.

Locations
latitude string

Latitude in degrees where pass should be highlighted.

longitude string

Longitude in degrees where pass should be highlighted.

Misc
expiration.date datetime

End time when pass stops being relevant. ISO 8601 format.

Event Ticket

For concerts, sports events, movies, and flights.

Appearance
hero.image file image (png)

Hero image displayed at the top of the pass. Must be PNG format and 1032x336 pixels in size.

Seat Info
venue.gate string

Gate number.

venue.section string

Section number.

venue.row string

Row number.

venue.seat string

Seat number.

NFC
nfc.message string

NFC payload (max 64 bytes). If empty, the pass defaults to Barcode if set to anything other than none.

Barcode
barcode.alt string

Text displayed below the barcode for manual entry.

barcode.data string default: 123456789

The data encoded in the barcode.

barcode.type enum<string>

The barcode format to display on the pass.

Available options:

  • QR_CODE (2D square barcode, high data capacity)
  • AZTEC (2D barcode, commonly used for tickets and boarding passes)
  • PDF_417 (2D stacked barcode, used for IDs and transport)
  • CODE_128 (1D barcode for alphanumeric data)
  • CODE_39 (1D barcode for alphanumeric data, widely supported)
  • CODABAR (1D barcode for libraries and blood banks)
  • EAN_8 (8-digit product barcode)
  • EAN_13 (13-digit product barcode)
  • ITF_14 (14-digit barcode for packaging)
  • UPC_A (12-digit product barcode)
Locations
latitude string

Latitude in degrees where pass should be highlighted.

longitude string

Longitude in degrees where pass should be highlighted.

Access Control

For employee badges, visitor passes, and ID cards.

Appearance
brand.logo file image (png)

Logo image for the pass. Must be PNG format and 660x660 pixels in size.

hero.image file image (png)

Hero image displayed at the top of the pass. Must be PNG format and 1032x336 pixels in size.

background.color string default: #F9FAFB

Background color for the full Google pass. Accepts hex color codes or rgb() values.

Header
card.title string required default: Brand Text

Displays on right side of logo. Required by Google.

subheader string default: Header Label

Label displayed above the header (e.g., "Employee ID").

header string required default: Header Value

Main header text (e.g., person's name). Required by Google.

Secondary Fields
secondary.1.label string

First label in the second row of fields.

secondary.1.value string

First value in the second row of fields.

secondary.2.label string

Second label in the second row of fields.

secondary.2.value string

Second value in the second row of fields.

Auxiliary Fields
auxiliary.1.label string

First label in the third row of fields.

auxiliary.1.value string

First value in the third row of fields.

auxiliary.2.label string

Second label in the third row of fields.

auxiliary.2.value string

Second value in the third row of fields.

auxiliary.3.label string

Third label in the third row of fields.

auxiliary.3.value string

Third value in the third row of fields.

NFC
nfc.message string

NFC payload (max 64 bytes). If empty, the pass defaults to Barcode if set to anything other than none.

Barcode
barcode.alt string

Text displayed below the barcode for manual entry.

barcode.data string default: 123456789

The data encoded in the barcode.

barcode.type enum<string>

The barcode format to display on the pass.

Available options:

  • QR_CODE (2D square barcode, high data capacity)
  • AZTEC (2D barcode, commonly used for tickets and boarding passes)
  • PDF_417 (2D stacked barcode, used for IDs and transport)
  • CODE_128 (1D barcode for alphanumeric data)
  • CODE_39 (1D barcode for alphanumeric data, widely supported)
  • CODABAR (1D barcode for libraries and blood banks)
  • EAN_8 (8-digit product barcode)
  • EAN_13 (13-digit product barcode)
  • ITF_14 (14-digit barcode for packaging)
  • UPC_A (12-digit product barcode)
Locations
latitude string

Latitude in degrees where pass should be highlighted.

longitude string

Longitude in degrees where pass should be highlighted.

Misc
relevant.date datetime

End time when pass stops being relevant. ISO 8601 format.