v1

latestOpenAPI 3.0.02026-07-267581167.5 KB

iOS Wallet Templates API

Get the Apple Wallet template

Retrieve the Apple Wallet (iOS) pass template for a wallet campaign. Each campaign has a single Apple Wallet template.

get/companies/{company_key}/campaigns/wallet/{token}/passbook_template

Path parameters

company_keystring required

tokenstring required

The token is the SmartLink token (wallet_id) for the campaign.

Headers

X-API-Versionstring

Response

Successful response

idstring

Unique identifier of the Apple Wallet template.

activeboolean

Whether the template is active.

created_atstring

When the template was created, in ISO-8601 format.

updated_atstring

When the template was last updated, in ISO-8601 format.

organization_namestring

Organization name shown next to the lock-screen notification. Falls back to the signing certificate's value if not set.

pass_descriptionstring

Short accessibility (VoiceOver) description of the pass. Required by Apple Wallet; defaults to the card type if left blank.

logo_textstring

Text rendered beside the logo at the top of the pass.

nfc_messagestring

Payload delivered when the pass is tapped on an NFC terminal (tap-to-interact).

app_idstring

Optional iOS App Store identifier (for example id123456 or 123456). When set, the pass links to the associated app and surfaces an open-app affordance.

thank_you_urlstring

Optional URL opened after the pass is installed.

thank_you_messagestring

Optional message shown after the pass is installed. Ignored when thank_you_url is set.

sharing_prohibitedboolean

When true, hides the pass's share button.