A wallet campaign refers to a campaign that involves the customer downloading a wallet item directly into their Apple or Android mobile wallet. These items can be used to distribute one-time offers or be utilized for loyalty cards and rewards programs.

Our Wallet Campaign API allows you to update campaigns and retrieve metadata on wallet items via API calls. However, please note that you can’t create wallet campaigns using an API call; all wallet campaigns must be initially created in the platform. For help on creating wallet campaigns, please see our resource center.

Available API Methods

Available Callbacks

Elements & Attributes

Wallet Campaign Entity

Data Element	Type	Description
`wallet_id`	String	Unique identifier for the wallet campaign, as automatically generated by Wallet Manager system.
`name`	String	Descriptive name of the mobile wallet campaign.
`type`	String	Valid values are “Offer” or “Loyalty”.
`smartlink_url`	String	URL used to distribute the initial offer or loyalty card to customers.
`url`	String	REST API reference to the mobile wallet campaign entity.
`created_at`	Timestamp	Timestamp for when the mobile wallet campaign was first created. It should be in the ISO 8601 format - for example: 2017-01-15T14:30Z.
`updated_at`	Timestamp	Timestamp for when the mobile wallet campaign was last updated. It should be in the ISO 8601 format - for example: 2017-02-18T19:30Z.

Wallet Item Entity

Data Element	Type	Description
`wallet_item_id`	String	Unique identifier for the wallet item specified at creation. This can be system generated or customer supplied in the creation URL. Note*: The `wallet_item_id` is the UUID, which is a campaign-specific identifier that is used to identify wallet objects. This is generally customer defined, as it can be included in links and used before a wallet object is created.
`group_code`	String	Optional string value to indicate groups of related wallet items. Can be used for targeted messaging.
`campaign_ref`	Object	Contains data related to the mobile wallet campaign this item is associated with.
`campaign_ref.id`	String	The `wallet_id` for the wallet campaign this item is associated with.
`campaign_ref.type`	String	Campaign type (“Offer” or “Loyalty”).
`campaign_ref.url`	String	Reference to internal URL of mobile wallet campaign entity.
`active`	Boolean	A Boolean that indicates if an item is currently installed on a person’s device. True: Wallet item is currently installed. False**: Wallet item is no longer installed.
`tokens`	Object	List of key/value pairs of item specific data that can be used to personalize the item.
`locations`	Array	Array of up to 10 latitude and longitude value pairs used by mobile wallet applications to determine when to present information to a person within proximity to a specified location.
`relevant_text`	String	Text displayed on person’s iPhone lock screen when the device is within 100 meters of an associated latitude-longitude value. Note*: This feature is only available for Apple. Android does not support custom text.
`providers`	Array	Indicates the currently installed wallet content providers for the specific Item instance. Note*: “Passbook” and “Google Wallet” are the only supported values. “Passbook” is now referred to as Apple Wallet, and “Google Wallet” is Google Pay.
`created_at`	Timestamp	Timestamp for when the mobile wallet campaign was created. It should be in the ISO 8601 format - for example: 2017-01-15T14:30Z.
`updated_at`	Timestamp	Timestamp for when mobile wallet campaign was last updated. It should be in the ISO 8601 format - for example: 2017-02-18T19:30Z.

Entity Examples

Below is an example of a wallet campaign entity.

{
   "wallet_id":"abcde12345",
   "name":"Gold Status",
   "type":"Loyalty",
   "smartlink_url":"http://mp.vibescm.com/c/a1b2c3",
   "url":"/companies/:company_id/campaigns/wallet/abcde12345",
   "created_at":"2017-01-15T14:30Z",
   "updated_at":"2017-02-18T19:30Z"
}

Below is an example of a wallet item entity.

{
  "wallet_item_id": "abcdef23SDF2",
  "group_code": "DEALS",
  "campaign_ref": {
    "id": "abCDefGHij",
    "type": "Loyalty",
    "url": "/companies/:company_id/campaigns/wallet/abCDefGHij"
  },
  "active": true,
  "tokens": {
    "first_name": "John",
    "last_name": "Doe",
    "loyalty_balance": "552"
  },
  "locations": [
    {
      "latitude": 43.6867,
      "longitude": -85.0102,
      "relevant_text": "Visit our State St store"
    },
    {
      "latitude": 37.789898,
      "longitude": -122.400751,
      "relevant_text": "Visit our Market St store"
    }
  ],
  "providers": [
    "Passbook",
    "Google Wallet"
  ],
  "url": "/companies/:company_id/campaigns/wallet/abCDefGHij/items/abcdef23SDF2",
  "created_at": "2017-01-15T14:30Z",
  "updated_at": "2017-02-18T19:30Z"
}