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) path: offerObjects.0.heroImage.sourceUri.uri

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

NFC
nfc.message string path: offerObjects.0.smartTapRedemptionValue

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

Barcode
barcode.alt string path: offerObjects.0.barcode.alternateText

Text displayed below the barcode for manual entry.

barcode.data string path: offerObjects.0.barcode.value

The data encoded in the barcode.

barcode.type enum<string> path: offerObjects.0.barcode.type

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 path: offerObjects.0.locations.0.latitude

Latitude in degrees where pass should be highlighted.

longitude string path: offerObjects.0.locations.0.longitude

Longitude in degrees where pass should be highlighted.

Loyalty

For membership cards, rewards programs, and store cards.

Appearance
hero.image file image (png) path: loyaltyObjects.0.heroImage.sourceUri.uri

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

Loyalty
points.label string path: loyaltyObjects.0.loyaltyPoints.localizedLabel.defaultValue.value

Label for primary loyalty points.

points.value integer or string path: loyaltyObjects.0.loyaltyPoints.balance.int

Primary loyalty points balance. Whole numbers are displayed with Google's number formatting (12345 → 12,345); any other value (e.g. R 250.00) is displayed exactly as sent.

secondary.label string path: loyaltyObjects.0.secondaryLoyaltyPoints.localizedLabel.defaultValue.value

Label for secondary loyalty points.

secondary.value integer or string path: loyaltyObjects.0.secondaryLoyaltyPoints.balance.int

Secondary loyalty points balance. Same rules as points.value: whole numbers are number-formatted, anything else (e.g. LEV-12345678) is displayed exactly as sent.

NFC
nfc.message string path: loyaltyObjects.0.smartTapRedemptionValue

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

Barcode
barcode.alt string path: loyaltyObjects.0.barcode.alternateText

Text displayed below the barcode for manual entry.

barcode.data string path: loyaltyObjects.0.barcode.value

The data encoded in the barcode.

barcode.type enum<string> path: loyaltyObjects.0.barcode.type

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 path: loyaltyObjects.0.accountName

Member name value. Visible on pass back.

account.id string path: loyaltyObjects.0.accountId

Member ID value. Visible on pass back.

Locations
latitude string path: loyaltyObjects.0.merchantLocations.0.latitude

Latitude in degrees where pass should be highlighted.

longitude string path: loyaltyObjects.0.merchantLocations.0.longitude

Longitude in degrees where pass should be highlighted.

Misc
expiration.date datetime path: loyaltyObjects.0.validTimeInterval.end.date

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) path: eventTicketObjects.0.heroImage.sourceUri.uri

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

Seat Info
venue.gate string path: eventTicketObjects.0.seatInfo.gate.defaultValue.value

Gate number.

venue.section string path: eventTicketObjects.0.seatInfo.section.defaultValue.value

Section number.

venue.row string path: eventTicketObjects.0.seatInfo.row.defaultValue.value

Row number.

venue.seat string path: eventTicketObjects.0.seatInfo.seat.defaultValue.value

Seat number.

NFC
nfc.message string path: eventTicketObjects.0.smartTapRedemptionValue

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

Barcode
barcode.alt string path: eventTicketObjects.0.barcode.alternateText

Text displayed below the barcode for manual entry.

barcode.data string path: eventTicketObjects.0.barcode.value

The data encoded in the barcode.

barcode.type enum<string> path: eventTicketObjects.0.barcode.type

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 path: eventTicketObjects.0.merchantLocations.0.latitude

Latitude in degrees where pass should be highlighted.

longitude string path: eventTicketObjects.0.merchantLocations.0.longitude

Longitude in degrees where pass should be highlighted.

Access Control

For employee badges, visitor passes, and ID cards.

Appearance
brand.logo file image (png) path: genericObjects.0.logo.sourceUri.uri

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

hero.image file image (png) path: genericObjects.0.heroImage.sourceUri.uri

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

background.color string path: genericObjects.0.hexBackgroundColor

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

Header
card.title string required path: genericObjects.0.cardTitle.defaultValue.value

Displays on right side of logo. Required by Google.

subheader string path: genericObjects.0.subheader.defaultValue.value

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

header string required path: genericObjects.0.header.defaultValue.value

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

Secondary Fields
secondary.1.label string path: genericObjects.0.textModulesData.0.header

First label in the second row of fields.

secondary.1.value string path: genericObjects.0.textModulesData.0.body

First value in the second row of fields.

secondary.2.label string path: genericObjects.0.textModulesData.1.header

Second label in the second row of fields.

secondary.2.value string path: genericObjects.0.textModulesData.1.body

Second value in the second row of fields.

Auxiliary Fields
auxiliary.1.label string path: genericObjects.0.textModulesData.2.header

First label in the third row of fields.

auxiliary.1.value string path: genericObjects.0.textModulesData.2.body

First value in the third row of fields.

auxiliary.2.label string path: genericObjects.0.textModulesData.3.header

Second label in the third row of fields.

auxiliary.2.value string path: genericObjects.0.textModulesData.3.body

Second value in the third row of fields.

auxiliary.3.label string path: genericObjects.0.textModulesData.4.header

Third label in the third row of fields.

auxiliary.3.value string path: genericObjects.0.textModulesData.4.body

Third value in the third row of fields.

NFC
nfc.message string path: genericObjects.0.smartTapRedemptionValue

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

Barcode
barcode.alt string path: genericObjects.0.barcode.alternateText

Text displayed below the barcode for manual entry.

barcode.data string path: genericObjects.0.barcode.value

The data encoded in the barcode.

barcode.type enum<string> path: genericObjects.0.barcode.type

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 path: genericObjects.0.merchantLocations.0.latitude

Latitude in degrees where pass should be highlighted.

longitude string path: genericObjects.0.merchantLocations.0.longitude

Longitude in degrees where pass should be highlighted.

Misc
expiration.date datetime path: genericObjects.0.validTimeInterval.end.date

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