Use the PKAddPassButton class to create an Add to Apple Wallet button for your Wallet-enabled app. Place the button directly on or near the item that can be stored in Wallet.
To learn more about making passes available to users, see the Human Interface Guidelines.
Place the button on or near the pass that can be stored in Wallet. Users can add their pass to Wallet directly from email opened on their iPhone, iPod touch, or Mac. Because users might open the email on another device, include instructions for opening the email on iPhone, iPod touch, or Mac.
Place the button on or near the pass that can be stored in Wallet. Users can add their pass to Apple Wallet directly from a web page opened on iPhone, iPod touch, or Mac. Because users might open the web page on another device, include instructions for opening the page on their iPhone, iPod touch, or Mac.
Using the Badge on Printed Materials
In printed materials, the Add to Apple Wallet badge should appear only in association with a Wallet-compatible pass and must be accompanied by a QR code or bar code. Customers can use the Camera app or Wallet app to scan the code on point-of-sale signage, coupons, posters, or other printed material. Scanning the code adds the pass to Wallet.
Place the Add to Apple Wallet badge and suggested messaging near the code. Place the badge on the layout so that it is clearly visible yet in a subordinate position following the main graphics and messages.
On large printed materials, the Add to Apple Wallet badge cannot be larger than the maximum height requirement of 25 mm.
Printing the Badge with a Code
Clear Space and Size Requirements
Minimum clear space is one-quarter the height of the badge. On printed materials, the minimum size for the Add to Apple Wallet badge is 10 mm in height and the maximum size is 25 mm in height. Do not reduce or enlarge the badge beyond these sizes.
QR Codes and Bar Codes
A recommended minimum code size for optimum scanning to Wallet is 40 mm wide. At this size QR codes of version 10 or lower, PDF 417 bar codes with five or fewer data columns, and Aztec codes of six or fewer data layers are recommended.
Badge and Code Alignment
It is recommended that the code and Add to Apple Wallet badge be aligned to equal width. It is also acceptable to have the codes left or center aligned.
Allow minimum clear space around the Add to Apple Wallet badge. Make sure you also comply with the requirements for a surrounding “quiet zone” for the type of code you are using. Codes must be printed on a white or light background. If your layout includes a dark background, do not extend the code’s required surrounding white space to include the Add to Apple Wallet badge. The white space should surround only the code. On dark backgrounds, the Add to Apple Wallet badge should not touch the code’s required surrounding white space.
Messaging that describes Wallet can be used in communications promoting Wallet-compatible passes. Messaging can be placed near the Add to Apple Wallet button or badge that accompanies your pass, or it can be used in general product communications to describe compatibility with Wallet.
You can use the suggested messaging below to describe and promote Wallet, or you can develop your own copy. Always follow the guidelines for using the name Wallet described below.
- Wallet description—long version:
“The Wallet app on Apple Watch, iPhone, and iPod touch is where you store and access all your boarding passes, movie tickets, coupons, rewards cards, and more.”
- Wallet description—short version:
“Wallet is where you store and access all your boarding passes, movie tickets, retail coupons, rewards cards, and more.”
- Instructions for adding a pass to Wallet if opened on a device other than iPhone or iPod touch:
“To add this [pass/ticket/coupon/card] to Wallet, open this [email, web page] on your iPhone or iPod touch.”
- Instructions for scanning a code—for use on printed materials:
“Wallet on Apple Watch, iPhone, and iPod touch is where you store and access all your boarding passes, movie tickets, retail coupons, rewards cards, and more. Now you can even scan this code to have a [insert brand/type of pass here] appear right in Wallet. To scan, just open Wallet on your iPhone or iPod touch and select Scan Code.”
Using the Name Wallet or Apple Wallet
When using the app name Wallet or Apple Wallet in headlines or copy, always typeset Wallet with an uppercase W followed by lowercase letters. Typeset Apple with an uppercase A followed by lowercase letters. Apple Wallet is set as two words.
If a headline is typeset all uppercase, the words Apple Wallet within the headline can also be uppercase.
You can refer to the Wallet app from Apple or Apple Wallet on the first mention of the app. In subsequent references, just Wallet can be used.
In U.S. communications, use the registered trademark symbol (®) the first time Apple appears in body copy.
Only the Apple-provided buttons and badges shown in these guidelines are approved by Apple.
- Do not let the Add to Apple Wallet badge dominate your layout as the primary message or main graphic. It must be secondary to your main message and product or company identity.
- Do not create your own version of the Add to Apple Wallet button or badge.
- Do not obstruct the badge or button with text, graphics, violators, or images.
- Do not display a dimmed version of the badge or button to indicate that it has not been selected.
- Do not use the Wallet icon alone.
- Do not flip, rotate, or animate the artwork.
- Do not add visual effects such as shadows, glows, or reflections to the mark.
- Do not use graphics or images from Apple’s website.
- Do not imitate Apple communications.
Add to Apple Wallet button and Wallet messaging cannot be used in any manner that falsely suggests an association with Apple or is likely to reduce, diminish, or damage the goodwill, value, or reputation associated with any Apple product or Apple itself.
Trademark Symbols and Credit Lines
For communications distributed only in the United States, the appropriate symbol (™, ℠, or ®) must follow each Apple trademark the first time it is mentioned in body copy—for example:
Refer to the Apple Trademark List for the correct trademark symbol. Do not add a trademark symbol to the Add to Apple Wallet button artwork provided by Apple.
In all regions, include the following credit line wherever legal information is provided on the communication:
Apple, Apple Watch, iPhone, and iPod touch are trademarks of Apple Inc., registered in the U.S. and other countries.
List only the trademarks actually used in your communication.
For more information about using Apple trademarks, see Guidelines for Using Apple Trademarks and Copyrights.
With Apple’s approval, a translation of the legal notice and credit lines (but not the trademarks) can be used in materials distributed outside the United States.