Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Steps

Expected results (Kiosk)

Expected results (RBI app)

Loyalty API usage (Kiosk)

Guest opens a reward on the RBI app

  • No action

  • Reward page is displayed:

  • No action

Guest taps “Redeem in Restaurant”

  • No action

  • Reward is added to the guest’s pre-selection

  • A unique reward code is generated

  • No action

Guest taps on the Kiosk screen to start a new order

  • Loyalty sign in page shows up on the Kiosk and scanner becomes active

  • N/A

  • No action

Guest either scans the reward’s QR code or inputs 6 digit code into Kiosk

Info

Note: the pre-selected reward(s) will show in the Kiosk screen after scanning with an option for the user to customize it

  • Reward(s) are shown on the Kiosk and guest has an option to customize

  • Modal is shown to guest confirming that the reward has been added to cart

  • The reward’s loyalty points cost is temporarily subtracted from the guest’s loyalty points balance at this moment

  • Reward pre-selection is cleared

  • Call the Identify endpoint, which will return the Loyalty User ID, the pre-selected reward, the loyalty points balance and a transaction ID

Guest customizes rewards at will and touches confirm

  • These reward(s) are incrementally added to the cart and do not replace any of the existing cart items

  • No action

  • No action

Guest opens a second Reward on the RBI app, chooses to redeem in restaurant

  • No action

  • User will see modal in the app letting user know, user can only add 1 reward per order and prompting user to replace reward in basket with newly selected reward

  • No action

Guest taps Replace

  • No action

  • New Reward is added to the guest’s pre-selection and the old reward is removed from pre-selection cart

  • No action

Guest either scans the reward’s QR code, or tells the 6 digit code to the cashier

  • New reward replaces the previous selected reward in the POS basket

  • Other items in the POS basket are not removed or replaced

  • Modal is shown to guest confirming that the reward has been added to the POS basket

  • The replaced reward’s loyalty points are returned to user balance

  • The new reward’s loyalty points cost is temporarily subtracted from the guest’s loyalty points balance

  • Loyalty points that will be accrued after the order will not be added to the guest’s loyalty points balance at this stage

  • Reward pre-selection is cleared

  • Keep track of the current basket contents including the past scanned reward

  • Call the Identify endpoint again, which will create a new transaction ID with the new reward

  • Void the previous transaction

  • Wait for Void Confirmation

  • Replace the previous reward in the basket with the new reward

  • Call the Update endpoint with all of the Kiosk basket contents and a status of PENDING

On the Kiosk UI, navigates to the rewards page

Info

Note: this step is only possible if the market has decided to allow showing rewards on the UI.

  • Rewards are displayed

  • No action

Guest adds a reward to basket

Guest selects and adds reward to cart

Guests selects reward in Kiosk screen

  • Guest sees message in the Kiosk letting user know, user can only add 1 reward per order and prompting user to replace reward in basket with newly selected reward

  • No action

  • No action

Guest clicks on Replace reward

  • New reward replaces the previous selected reward in the POS basket

  • Other items in the POS basket are not removed or replaced

  • The reward’s loyalty points cost is temporarily subtracted from the guest’s loyalty points balance in the app

  • No modal is shown

  • Call the Update endpoint with all of the Kiosk basket contents and a status of PENDING

Guest goes to checkout screen

  • Guest sees list of all chosen items in basket

Info

Note: If an reward can’t be redeemed because the reward rules are not met, the Kiosk displays a modal to the guest explaining why the reward can’t be added to cart

  • No action

  • Call the Transaction Validate endpoint to verify that the current basket selection is valid

  • Note that the call above may return errors. Please refer to Loyalty API - Error List for details.

Guest finalizes the order and pays at Kiosk

  • Kiosk prints receipt with points earned & points balance

  • Guest sees updated points balance

 

  • Call the Transaction Update endpoint with a status of CLAIMED

...