Vibes currently supports wallet items for both Apple and Android, but due to the differences between the operating systems on which these items live, the Apple and Android wallet items must be created and updated separately. The Android API allows you to retrieve, create, and update templates for Android users.
The Android Wallet Templates API allows you to update, retrieve and create templates for Google Wallet (formerly known as Android Wallet). You can find the iOS documentation here.
Available API Methods
Parameters for URL
| Parameter | Description |
|---|---|
| token | Campaign SmartLink token |
| company_key | Company’s key |
| wallet_object_template_id | Unique identifier for the wallet_object_template to be retrieved |
Elements & Attributes
| Elements | Description | Required | Format/example |
|---|---|---|---|
title | A string to describe the wallet object | yes | "title": <a_string> |
provider | A string for the name of the merchant the loyalty card/offer is valid for | yes | "provider": <a_string> |
issuer | A string that is usually the company for the wallet object | yes | "issuer”: <a_string> |
loyalty_points | A hash for the loyalty_points field Note: loyalty_template only | no | loyalty_points": { "label”: <a_string>, "balance”: <a_string> } |
secondary_loyalty_points | A hash for the secondary_loyalty_points fieldNote: loyalty_template only | no | "secondary_loyalty_points": { "label”: <a_string>, "balance”: <a_string> } |
hero_image | A string for the source_url of the hero image on the wallet_object | no | "hero_image": <a_string> |
logo | A string for the source_url of the image on the wallet_object | yes | "logo": <a_string> |
strip_image | A string for the source_url of the strip_image on the wallet_object | no | "strip_image": <a_string> |
strip_images | An array of dynamic strip images with a source_url. None of the images here will be used as the default strip images, and each one requires a unique image code | no | "strip_images": s] { "data": { "h-0": "Elements", "h-1": "Description", "h-2": "Required", "h-3": "Format/example", "0-0": " title","0-1": "A string to describe the wallet object", |
barcode | A hash for describing the barcode on a wallet_objectNote: type must be one of the following "data": { "h-0": "Elements", "h-1": "Description", "h-2": "Required", "h-3 | yes | "barcode": { "type": <a_string>, "value": <a_string>, "alternate_text": <a_string> } |
background_color | A hex value for the background color Note: Must be hex format | no | "background_color": <a_string> |
nfc_message | A string that will be sent on a smart tap | no | "nfc_message": <a_string> |
account (Only for Offer Campaigns) | A hash representing the account field on the wallet_object | no | "account": { "name_label": <a_string>, "name": <a_string>, "id_label": <a_string>, "id": <a_string> } |
rewards_tier (Only for Offer Campaigns) | A hash representing the rewards tier section of the wallet_object | no | "rewards_tier": { "label": <a_string>, "name": <a_string> } |
subinfo | An array of hashes for the subinfo section of the wallet_object | no | "subinfo": meters] { "data": { "h-0": "Elements", "h-1": "Description", |
text_area | An array of hashes for the text area of the wallet_object | no | "text_area": ters] { "data": { "h-0": "Elements", "h-1": "Description", |
messages (Only for Offer Campaigns) | An array of hashes for the messages section of the wallet_object | no | "messages": eters] { "data": { "h-0": "Elements", "h-1": "Description", |
links | An array of hashes for the links section of the wallet_object | no | "links": rameters] { "data": { "h-0": "Elements", "h-1": "Description", |