Pass Template Builder Settings for a Boarding Pass

Appearance

Customize the appearance for the boarding pass by adding strip images, logos, and background color.

Boarding Pass Pass Template Builder Appearance Tab

FieldDescription
Carrier Airline LogoUpload the carrier airline logo that will appear on the customer’s boarding pass. The logo will appear rounded in the top center of the Pass on Google Pay and will appear square/rectangular in the top left corner of the Pass on Apple Wallet. The minimum size for the logo is 660px by 660px. It is recommended to leave the logo with a full bleed background color and a 15% margin.
Carrier Airline NameThe name of the airline issuing the boarding pass. The carrier airline name is displayed below the logo on Google Pay passes and to the right of the logo on Apple Wallet Passes. An ellipsis will be displayed if the carrier airline name exceeds 20 characters. This field is required to generate boarding passes.
Carrier Alliance LogoAdd the carrier alliance logo. The logo will be displayed as a small icon below the barcode. On Apple Wallet boarding passes, the carrier alliance logo is displayed above the barcode, whereas for Google Pay boarding passes, the carrier alliance logo is displayed below the barcode.
BackgroundSet a background color for the Pass. The format is #rrggbb, where rrggbb is a hex RGB triplet, such as #ffcc00. The background color is the same for every Pass.

Universal Fields

Main Fields

These are the fields that will appear on the front of the Pass for both Apple Wallet and Google Pay. All of the main fields listed below are required to generate boarding passes.

Main Fields 1 Boarding Pass Template

Main Fields 2 Boarding Pass Template

FieldDescription
Field 1: Origin Airport Name/IATA CodeAdd the origin airport name and IATA code, such as ‘Boston: BOS’. This field is required to generate boarding passes.
Field 2: Destination Airport Name/IATA CodeAdd the destination airport name and IATA code, such as ‘Charleston: CHS’. This field is required to generate boarding passes.
Field 3: Passenger NameThe passenger name associated with the boarding pass. The label is a fixed value. This field is required to generate boarding passes.
Field 4:  Boarding PositionThe value of the boarding position, such as ‘1’. The label is a fixed value. This field is required to generate boarding passes.
Field 5: Boarding Policy/GroupChoose either ‘Group’ or ‘Zone’ from the drop-down menu. The value is the boarding group/zone that this passenger will board with, such as ‘B’. This is specific for boarding pass type. This field indicates the policy the airline uses for boarding. If unset, Google Pay will default to ‘Zone’. This field is required to generate boarding passes.
Field 6: Seat NumberThe passenger’s seat number. The label is a fixed value. This field is required to generate boarding passes.
Field 7: Origin Terminal LabelThe origin terminal for the specific flight. The label is a fixed value. This field is required to generate boarding passes.
Field 8: Origin Gate LabelThe origin gate for the specific flight. The label is a fixed value. This field is required to generate boarding passes.
Field 9: Carrier IATA Code/Flight NumberThe two-character IATA airline code of the airline carrier and the flight number. This field is required to generate boarding passes.
Field 10: Local Boarding TimeThe local boarding date & time for the specific flight. The label is a fixed value. This field is required to generate boarding passes.

Additional Fields

These fields will appear on the back of the Pass on Apple Wallet and below the Pass on Google Pay.

Additional Fields 1 Boarding Pass Template

Additional Fields 2 Boarding Pass Template

Additional Fields 3 Boarding Pass Template

Additional Fields 4 Boarding Pass Template

FieldDescription
Pass ExpirationCheck the box if the Pass should have an expiration date. Choose a date and time for the Pass to expire.
Field 1: Boarding Seat ClassChoose ‘Cabin’ or ‘Class’ from the drop-down menu. If unset, Google Pay will default to ‘Cabin’. The value indicates the boarding cabin or class, such as ‘Economy’ or ‘First’.
Field 2: Sequence NumberAdd the sequence number on the boarding pass, such as ‘49’.The label is a fixed value.
Field 3: Boarding DoorChoose either ‘Front’ or ‘Back’ for the boarding door. The label is a fixed value.
Field 4: Flight NumberThis field will be pre populated with the carrier IATA code and flight number set in the main fields.
Field 5: Reservation CodeThe confirmation code needed to check into this flight. The label is a fixed value. This field is required to generate boarding passes.
Field 6: Reservation Ticket NumberThe e-ticket number. The label is a fixed value.
Field 7: Frequent Flyer numberAdd frequency flyer information, if applicable. The label is a fixed value.
Field 8: Boarding TimeThis field will be prepopulated with the boarding date & time set in the main fields. The label is a fixed value.
Field 9: Local Gate Closing TimeThe time that the flight gate closes in the local time. The label is a fixed value.
Field 10: Scheduled Departure TimeThe scheduled or estimated flight departure time. The label is a fixed value.
Field 11: Scheduled Arrival TimeThe scheduled or estimated flight arrival time. The label is a fixed value.
Field 12: Destination TerminalThe destination arrival terminal number. The label is a fixed value.
Field 13: Destination GateThe destination arrival gate number. The label is a fixed value.
Field 14 & 15: Message 1 & Message 2These are optional fields to add messages on the back of the Pass for Apple Wallet or below the Pass for Google Pay. These fields allow line breaks.
Field 16: Text ModuleThe recommended maximum length for the label is 35 characters to ensure the full string is displayed on smaller screens. The value of the Text Module is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure the full string is displayed on smaller screens. This field also allows line breaks.
Field 17: Info ModuleThe recommended maximum length for the label is 30 characters to ensure the full string is displayed on smaller screens. The recommended maximum length for the value is 30 characters to ensure the full string is displayed on smaller screens.
Field 18: Home Page URIAdd a link to the airline’s website.
Field 19 & 20: Link 1 & 2Add any link including a link to a telephone number, URL, email address, or specific location. Google Pay uses special icons to distinguish different types of URI’s for the fields that use links. To use an icon, select from the drop-down menu and enter the correct data.

Barcode Fields

Barcode Fields for a Boarding Pass Template

FieldDescription
Barcode TypeSelect the type of barcode you want to use on the Pass. Supported types include: QR Code, Code 128, Aztec, and PDF 417
Default Barcode ValueSelect the default barcode value that will appear if no value is passed in the API or if you have not selected ‘autogenerate barcode’
Autogenerate BarcodeCheck this box if you want to generate a random barcode value for your Passes.
Autogenerate ValueSelect the data type and data length (10-100 characters) of barcode you would like to autogenerate:

  1. Numeric Only
  2. Alphabet Only
  3. Alphanumeric
Preview BarcodeEnter text to see how the barcode will be displayed on the actual pass.

Apple Wallet Fields

Boarding Pass Apple Wallet Fields

FieldDescription
Text ColorAdd any color to the text fields on Apple Passes only.
IconAdd an icon that will appear on your customer’s lock screen for Pass updates and notifications.
DescriptionAdd a description for blind and low vision users on Apple Passes.
Link to AppLink an app to the Pass. The app will only appear on the back of Apple Wallet Passes.
Relevant Date & TimeSet a relevant date and time for the Pass to appear on the device’s lock screen.
iBeacons – UUID, Major, and Minor Values, and Relevant TextAdd up to 10 iBeacons for each Pass. Defining the UUID, Major, and Minor values are necessary for the iBeacon to work. Add relevant text that will appear on the customer’s screen when the iBeacon is detected in a range.

Google Pay Fields

Boarding Pass Google Pay Fields

FieldDescription
Strip ImageThe strip image is displayed as a banner across the center of the front of the Pass for Google Pay only. The required image type is a PNG file. The recommended image size is 1032px by 336px. Use an image with a colored background for the best results. This image does not appear on Google Pay boarding passes.
Additional ImageIf you choose to upload an additional image for Google Pay Passes, the image will appear below the Pass. The image will not appear anywhere on Apple Wallet Passes. You can preview how the additional image will appear by clicking ‘G Pay Preview’.
Additional Image DescriptionAdd a description for the additional image. The description will not appear on the Pass.

Relevance

Boarding Pass Relevance Settings

FieldDescription
Relevant AddressAdd up to 10 GPS locations to display a message/notification on your customer’s lock screen when they are nearby.
Relevant Text for IOSThis is the custom text that will appear when the device is within the boundaries of the relevant address.
Relevant Text for AndroidThis is the fixed text that will appear when the device is within the boundaries of the relevant address. The text is defined by Google Pay and cannot be customized.

Advanced

Boarding Pass Advanced Tab

FieldDescription
Pass GenerationSelect whether you want to ‘Generate only personalized Passes’ or ‘Generate unique Passes upon any request’. Generating only personalized Passes requires you to import personalized data or call our API. Generating unique Passes upon any request will generate passes for every valid request.
Disable SharingSelecting this option will disable your customers from sharing the Pass on Apple Wallet or share the Pass install link on both Apple Wallet and Google Pay to another device.
Data Archive SettingsThese settings allow you to set a TTL (time to live) for each Pass. TTL settings can be set per Pass Template so that the value set for the TTL will get updated for each Pass depending on the events that occur.

in Mobile Wallet