Cloud operating system for your business

Design and usage reference for Omnibasis Mobile Wallet passes.

Supported Mobile Wall

<sup>1. Loyalty, gift card, and member card passes for Apple Wallet are based on Apple’s Store Card pass style.
2. Coupon passes for Google Pay are based on Google’s Offer pass style.
3. Also supports ferry, bus, and train tickets.</sup>

Location Triggers

<sup>1. Location can be used alone, but Date cannot be used without Location.
2. Date can be used alone, but Location cannot be used without Date.
3. You can specify a Date, a Location, or both.</sup>

Available Triggers

The triggers that will cause pass-related text to appear on the lock screen.

Location Radius

The minimum required proximity to a defined location trigger for Relevant Location text to appear on the lock screen.

Location Radius is for Apple Wallet only. The proximity requirement for Google Pay is 150 meters for all pass types.

Date Window

The window of time before and after a defined date and time trigger when Relevant Date text will appear on the lock screen.

For Apple Wallet passes, also see Relevance Information Displays Passes on the Lock Screen, including Table 4-2, in Apple Wallet Developer Guide: Pass Design and Creation.

Layouts

In addition to the layout information provided here, please also refer to Apple and Google developer documentation for the position of fields, images, and other design elements for each pass type.

• Apple Wallet Developer Guide: Pass Design and Creation
• Google Pay API for Passes: Gift cards
• Google Pay API for Passes: Loyalty
• Google Pay API for Passes: Offer/Coupon
• Google Pay API for Passes: Boarding passes
• Google Pay API for Passes: Event tickets

Fields

• Most passes can have up to three header fields, a single primary field, up to four secondary fields and up to four auxiliary fields.

• Boarding passes use two primary fields to show origination and destination. They also can have up to five auxiliary fields.

• Coupons and Member Cards combine secondary and auxiliary fields onto a single line, for up to four fields total.

• Event Tickets with a background image and Generic passes with a square bar code (QR code or Aztec) will not use auxiliary fields.

• On Google Pay, Loyalty passes will display the content of the MemberID/AccountID fields where the barcode should be if a barcode is missing. To avoid this you can leave the fields blank and check the Hide this field.

• The number of fields on a pass also depends on the text in each field. If there is too much text in a field, some fields will not be displayed.

Images

Pass type also determines the types of images that will appear on the pass. Event Ticket passes have two different layouts, determined by the type of images and/or barcode types that are selected.

<sup>1. Icon images are available on iOS only.
2. Hero images are available on Android only.</sup>

Image Sizes

For Apple Wallet, each image type should adhere to the specifications below.

For Google Pay, specifications for each image type may change. The currently supported specs for Google Pay images can be found in the Google API Brand guidelines.

Images that are too large are automatically resized, which may reduce quality or change the expected proportions of the image. Always send and install a test pass, and verify the pass’s appearance prior to distribution to end users.

Image file size limits are not enforced when uploading via the dashboard or the API.

Schematics

The images below indicate where each field appears on the pass. In some cases, field placement is determined by the images selected.

PASS TYPE	APPLE WALLET	GOOGLE PAY
Loyalty
Coupon
Gift card
Member card
Event ticket (Layout 1)
Event ticket (Layout 2)
Boarding pass
Generic

Barcode Types

TYPE	DISPLAY	API KEY	APPLE WALLET	GOOGLE PAY
PDF417		PKBarcodeFormatPDF417	✓	✓
Aztec		PKBarcodeFormatAztec	✓	✓
QR		PKBarcodeFormatQR	✓	✓
Code 128		PKBarcodeFormatCode128	✓	✓
UPC-A		UPC_A		✓
EAN-13		EAN_13		✓
Code 39		CODE_39		✓

Sharing Policy

By default, templates allow pass sharing across users and devices. You can change the sharing policy for templates from the Templates menu for a mobile wallet project.

Apple Wallet and Google Pay support slightly different sharing settings.

Security

Omnibasis Mobile Wallet does not support ciphers that are considered weak. 

Only TLS 1.2 and TLS 1.3 are supported for Wallet API endpoint access.

In an effort to make Wallet projects as secure as possible, we’ve removed support for several legacy platforms:

• Android and iOS devices running unsupported operating systems
• Java 6 or lower
• Java 7 and 8 without Unlimited Strength cipher libraries enabled
• Windows XP, Windows 7, Server 2003, Server 2008, Server 2008 R2, and Internet Explorer 9 (or lower)

Apple vs Google Distribution URL Differences

From the user’s perspective, the pass installation experience is similar on either iOS or Android — the pass is ultimately downloaded directly to either the Apple Wallet or Google Pay app. However, there are differences between the pass URLs:

• Apple Wallet: Pass URLs generated from Apple Wallet templates point to a stored .pkpass file. A .pkpass file can be considered similar to a PDF or any other document that you might link to.

• Google Pay: Pass URLs generated from Google Pay templates provide a deep link from Google into the Google Pay app so that the pass can be downloaded directly without requiring a browser window to facilitate the request.

Troubleshooting Apple Wallet Passes

In rare instances, some passes created in Omnibasis Wallet projects will not load in Apple Wallet. Here are some probable causes:

1. We’ve found inconsistent support of PNG image bit-depths by Apple Wallet and OS X PassViewer. 8-bit .png images are not currently supported by Apple Wallet. We recommend that you re-create your PNG at 24-bits (in Photoshop use Save for Web, and choose PNG-24), then re-upload your image in Omnibasis Wallet Designer.

2. Corrupt graphics will sometimes cause an image to not appear on the pass. Regenerate your graphics using your favorite graphics editor (you can use Apple’s Preview app if you prefer) as 24-bit PNGs and re-upload them to your Omnibasis Wallet Designer.

Pass Design Elements

Pass appearance is dependent on the template design, but all passes have the same primary elements:

• Background color
• Images
• Data fields
• Barcode (optional)

For Apple Wallet passes, you can also set:

• Text color
• Icon image: This is displayed on the lock screen along with any notifications. It is also displayed when a pass is provided by an app, e.g., a mail attachment.
• Data fields on the back of the pass

These are iOS examples of a boarding pass, a coupon, and a loyalty card.