API Reference

Wallet Messaging API

A wallet message is a way to communicate with your end users directly in their wallet app. These messages may display differently depending on which operating system the end user is on.

For example, Android devices can only receive location notifications; they cannot receive scheduled notifications.

📱

Geofenced notifications on Android

Google has temporarily made geofenced notifications unavailable for a majority of users while they make platform improvements.

Available API Methods

Elements & Attributes

Data ElementTypeDescription
wallet_message_idStringUnique system-generated identifier for each message created
messageObjectObject reference for the message components.
message.templateStringMessage template that contains the message to be sent to each item.
message.headerStringOptional header value to display with the message.

Note: Currently only used with Android wallet objects.
message.urlStringOptional URL to an image to display with the message.

Note: Currently only used with Android wallet objects.
recipient_countIntegerNumber of items that were included in the message.
campaign_refObjectObject that contains data relevant to the wallet campaign this wallet message is associated with.
campaign_ref.idStringReference to wallet_id that identifies the wallet campaign this message is associated with.
campaign_ref.typeStringCampaign type (“Offer” or “Loyalty”).
campaign_ref.urlStringReference to internal URL of mobile wallet campaign entity associated with this message.
filtersArrayOptional array of filter objects that will target the message to specific items in the wallet campaign.
created_atTimestampTimestamp for when the campaign was created. It should be in the ISO 8601 format - for example: 2017-01-15T14:30Z.
updated_atTimestampTimestamp for when the campaign was last updated. It should be in the ISO 8601 format - for example: 2017-02-18T19:30Z.

Entity Example

This is an example of a wallet message entity.

{
  "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"
}