Our Wallet Manager APIs allows you to create, update, and track coupons, event passes, mobile pages, and loyalty cards that can be saved right in your customer’s digital wallet. Our public APIs allow you to retrieve information about your wallet campaigns.

Please note that new mobile wallet campaigns cannot be created via an API call. While you can create new templates and messages, the actual wallet campaign must first be created in the Wallet Manager UI in our platform.

What is a Mobile Wallet Campaign?

A mobile wallet campaign is a way to create wallet items for your users to download onto their mobile devices. These items can be used as coupons, discounts, rewards cards, tickets, and more.

In each campaign, you will create templates for these wallet items. Each wallet item can be customized with your brand content—such as a logo or rewards program name—and with content personal to each individual, such as their name or loyalty point balance.

What Can Be Managed via Public APIs?

Within our public APIs, there are four basic APIs that help you manage your wallet campaigns.

Wallet Campaign API: This API allows you to update wallet retrieve information about campaigns currently associated with your account, as well as retrieve relevant wallet item entities, and update wallet item content.

Wallet Messaging API: This API allows you to send targeted messages to users who have already installed your wallet item. Please note that some messaging features are only available on certain operating systems.

Android Wallet Templates API: This API allows you to make updates and retrieve metadata about wallet templates for Android.

iOS Wallet Templates API: This API allows you to make updates and retrieve metadata about wallet templates for iOS.

Note: Apple Wallet was previously known as Passbook. Google Wallet was previously known as Google Pay and Android Pay. In an effort to make this documentation evergreen, we will refer to these by the operating system they each are supported by: iOS and Android, respectively. However, be aware you may see some legacy references in the code.

Getting Started with Wallet

Before you get started, we recommend you familiarize yourself with the basics of SmartLinks, Liquid Template Language, and First Class Fields.

If you’re already familiar with these concepts, feel free to skip these introductions.