ResponseCheck

Response to an inquire, redeem, or accure request. For an inquire response this field is requried. For all other responses it is optional unless any of the redemptions were rejected. If the account corresponding to the identifier was not found, the service should return a 404 response.

object (AccountInfo)

Identifying information about a specific loyalty account.

Array of objects (Redemption)

A list of redemptions that were submitted as part of a LOYALTY_INQUIRE or LOYALTY_REDEEM request that are valid for the given loyalty account and the contents of the check. For item level redemptions the selectionGuid will be set to indicate which item it applies to.

Array of objects (Offer)

An array of offers that are currently available to the holder of this account.

object (RedemptionLimit)

Controls the maximum number of rewards a guest can redeem for this check.

When this object is present (non-null), the Toast POS enforces the limit you specify by disabling the ability to select additional rewards once the limit is reached. Guests can always deselect rewards to choose different ones.

The effective limit accounts for rewards that are already applied. If you return maxRedemptions = 3 and the guest has 1 reward already applied, the guest can select 2 more rewards.

When this object is absent or null, the Toast POS applies no redemption restrictions.

The Toast POS does NOT validate that the appliedRedemptions array length matches the maxRedemptions value. You are responsible for ensuring consistency in your responses. If you send maxRedemptions = 2 but include 5 items in appliedRedemptions, the Toast POS may behave unexpectedly.

This object applies to LOYALTY_INQUIRE responses. For other transaction types, this object should be absent or null.

Array of objects (RejectedRedemption)

A list of redemptions that were submitted as part of a LOYALTY_INQUIRE or LOYALTY_REDEEM request that are not valid for the given loyalty account and the contents of the check.

userMessage
string

An optional message to be relayed to the guest at the restaurant. Examples could include "Visit http://www.website.com to check your points balance" or "You will accrue 15 points with this transaction!"

{
  • "accountInfo": {
    },
  • "offers": [
    ],
  • "rejectedRedemptions": [
    ],
  • "appliedRedemptions": [
    ],
  • "userMessage": "string",
  • "redemptionLimit": {
    }
}