Page History
Last Updated:
Lastupdatedate |
---|
Livesearch | ||||
---|---|---|---|---|
|
Overview
Vibes’ Wallet Manager platform enables updates to offers and loyalty cards already saved to a Person's Apple Wallet/Passbook or Google Wallet/Android Pay application. Mobile Wallet Campaigns cannot be created with an API, they must be created through the Wallet Manager UI (mpages.vibescm.com).
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Topics in this Section
|
Note |
---|
Note: Passbook was renamed as Apple Wallet. Google Wallet was renamed as Android Pay. |
Each Company can have one or more Mobile Wallet Campaigns active at any given time. A Mobile Wallet Campaign is a template and a definition of a Wallet Item. A Wallet Item is a specific instance of a Mobile Wallet Campaign template that has been installed on one or more devices for a Person.
A Wallet Item can contain content, like brand logo, that is common to all other Persons participating in the campaign. A Wallet Item can also contain Person-specific information like a name or loyalty point balance. Only Person-specific information can be updated with an API. Common content can be updated through the UI.
Mobile Wallet Campaign Entity
Code Block |
---|
{ "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" } |
Elements
Data Element | Type | Max Char Length | Description |
---|---|---|---|
wallet_id | String | Unique Mobile Wallet Campaign ID automatically generated by Wallet Manager system. | |
name | String | Descriptive name of Mobile Wallet Campaign. | |
type | String | Valid values are “Offer” or “Loyalty”. | |
smartlink_url | String | URL to distribute the initial offer or loyalty card to people via Short Message Service (SMS) or email. | |
url | String | REST API reference to the Mobile Wallet Campaign entity. | |
created_at | Timestamp | When Mobile Wallet Campaign was initially created. It should be in the ISO 8601 format - for example: 2017-01-15T14:30Z. | |
updated_at | Timestamp | When Mobile Wallet Campaign was last updated. It should be in the ISO 8601 format - for example: 2017-02-18T19:30Z. |
Wallet Item Entity
Code Block |
---|
{ "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" } |
Elements
Data Element | Type | Description | ||
---|---|---|---|---|
wallet_item_id | String | Unique Wallet Item ID that was specified at creation. This can be system generated or customer supplied in the creation URL.
| ||
group_code | String | Optional string value to indicate groups of related Wallet items. Can be used for targeted messaging. | ||
campaign_ref | String | Reference to Mobile Wallet Campaign information. | ||
id | String | Reference to wallet_id. | ||
type | String | Campaign type (“Offer” or “Loyalty”). | ||
url | String | Reference to internal URL of Mobile Wallet Campaign entity. | ||
active | Boolean | True: Wallet item currently installed on Person’s device. False: Wallet item no longer installed on Person’s device. | ||
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 (Apple Wallet/Passbook, Android Pay/Google Wallet) 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; Apple Wallet/Passbook only (Android Pay/Google Wallet does not support custom text). | ||
providers | Array | Indicates the currently installed Mobile Wallet content providers for the specific Item instance.
| ||
created_at | Timestamp | When Mobile Wallet Campaign was initially created. It should be in the ISO 8601 format - for example: 2017-01-15T14:30Z. | ||
updated_at | Timestamp | When Mobile Wallet Campaign was last updated. It should be in the ISO 8601 format - for example: 2017-02-18T19:30Z. |
Apple Wallet/Passbook Provider
Defines the specific Apple Wallet/Passbook Provider JSON object that is included in the Wallet item.
Android Pay/Google Wallet Provider
Defines the specific Android Pay/Google Wallet JSON object that is included in the Wallet item.
Wallet Message Entity
Code Block |
---|
{ "wallet_message_id": "abcdef23SDF2", "message": { "template": "This is the updated message I would like to send.", "header": "Header, for Google Wallet only.", "image_url": "http://www.google.com/wallet.jpg" }, "campaign_ref": { "id": "abCDefGHij", "type": "Loyalty", "url": "/companies/:company_id/campaigns/wallet/abCDefGHij" }, "filters": [ { "name": "group_code", "selector": "starts_with", "value": "DEA" }, { "name": "providers", "selector": "any", "value": [ "Passbook" ] } ], "recipient_count": 75, "url": "/companies/:company_id/campaigns/wallet/abCDefGHij/messages/abcdef23SDF2", "created_at": "2017-01-15T14:30Z", "updated_at": "2017-02-18T19:30Z" } |
Elements
Data Element | Type | Description | ||
---|---|---|---|---|
wallet_message_id | String | Unique system-generated Identifier for each message created. | ||
message | Object | Object reference for the message components. | ||
template | String | Message template that contains the message to be sent to each item. | ||
header | String | Optional header value to display with the message.
| ||
url | String | Optional URL to an image to display with the message.
| ||
recipient_count | Integer | Number of items that were included in the message. | ||
campaign_ref | Object | Reference to Mobile Wallet Campaign information. | ||
id | String | Reference to wallet_id. | ||
type | String | Campaign type (“Offer” or “Loyalty”). | ||
url | String | Reference to internal URL of Mobile Wallet Campaign entity. | ||
filters | Array | Array of filter objects that will target the message to specific items in the Wallet campaign. | ||
created_at | Timestamp | When Mobile Wallet Campaign was initially created. It should be in the ISO 8601 format - for example: 2017-01-15T14:30Z. | ||
updated_at | Timestamp | When Mobile Wallet Campaign was last updated. It should be in the ISO 8601 format - for example: 2017-02-18T19:30Z. |