Guest opens the Loyalty code page on the RBI app

• No action

• Loyalty code page is displayed:

  Image Modified

• 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

Image Modified

• No action

• No action

Guest scans the loyalty code or inputs 6 digit code in Kiosk

• Kiosk authenticates the guest and shows the home page

Image Modified

• Scanner remains active

• Guest receives a successful confirmation modal

Image Modified

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

Guest opens an reward on the RBI app in a different device, using a different user, and chooses to redeem in restaurant

• No action

• Reward of is added to the guest’s pre-selection (on the second device)

  Image Modified

• A unique reward code is generated

• No action

Guest (on their second device) either scans the reward’s QR code, or inputs the 6 digit code in the Kiosk

• Modal shows in the Kiosk, letting the user know that the last scan was made using a different user account

• Contents of the second scan are not added to the guest’s basket (so the current basket remains unchanged)

• The second scan is cancelled/voided

• Initial order can continue normally

• Modal is shown to the second user confirming that the offer has been added to cart (displaying this modal cannot be avoided)

Image Modified

• The 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

• A few seconds later, the loyalty points are returned to the second user

• Keep track of the current basket contents including rewards

• Call the Identify endpoint again, and wait for the response

• The new transaction will come with a different loyaltyId

• Check the Loyalty ID of this transaction does not match Loyalty ID of previous transaction

• Void this second transaction

• Keep the current basket open with previous transaction

Guest opens the Loyalty code page on the RBI app

• No action

• Loyalty code page is displayed:

  Image Modified

• 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

Image Modified

• No action

• No action

Guest scans the loyalty code or inputs 6 digit code in Kiosk

• Kiosk authenticates the guest and shows the home page

Image Modified

• Scanner remains active

• Guest receives a successful confirmation modal

Image Modified

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

Guest opens an reward on the RBI app, chooses to redeem in restaurant

• No action

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

  Image Modified

• A unique reward code is generated

• No action

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

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

Image Modified

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

Image Modified

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

• Reward pre-selection is cleared

• Keep track of the current basket contents including rewards

• Call the Identify endpoint again, which will create a new transaction ID and return selected reward(s)

• Void the previous transaction

• Wait for Void Confirmation

Guest customizes reward(s) at will and adds to basket

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

Image Modified

• 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 v1 - Error List for details.

• 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

• Rewards are displayed

Image Modified

• No action

• Query Sanity to Display Rewards in the Kiosk Listing

• offers and rewards on kiosks

Guest adds a reward to basket

• Guest selects and adds reward to cart

Image Modified

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

  Image Modified

• 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 v1 - Error List for details.

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

Guest remove a reward from basket

• Guest removes a reward from Kiosk basked

• The reward’s loyalty points is temporarily added back to the guest’s loyalty points balance in the app

• 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 v1 - Error List for details.

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

Guest goes to checkout screen

• Guest sees basket of all items at checkout

• 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 v1 - Error List for details.

Guest chooses to pay at the counter using cash

• Kiosk and POS exchange an order ID (this depends on the specific POS/Kiosk integration)

• Receipt is printed with the pending order ID

• No change

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

• Kiosk sends this transaction information with the order details to POS vendor

Guest arrives at the counter to pay, guests add 1 more menu item to order and pays for the order

• Cashier finds the order of guest

• Cashier adds 1 more menu item to open order

• Cashier finalizes the order at POS after receiving cash payment

• POS prints receipt with points earned & points balance

• Guest sees updated points balance

Image Modified

• The Kiosk should communicate with the POS to transfer the order over (this step is implementation-dependent and out of scope for this document)

• No action performed on the Loyalty API

• 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

• v1 - Error List for details.

• After collecting the payment, the POS should call the Transaction Update endpoint with a status of CLAIMED

• After this call it is not possible to modify the loyalty transaction anymore

• POS cancels the order after X minutes (configurable by the POS) that the guest has not paid the order started at the Kiosk

• Temporary reward points that were deducted from User’s account are returned back to user balance after X minutes

• Call the Void endpoint to cancel the order after X minutes

Guest opens an offer on the RBI app

• N/A

• Offer page is displayed:

Image Added

• No action

Guest taps “Use at restaurant”

• N/A

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

Image Added

• A unique offer code is generated

• No action

Guest taps on the Kiosk screen to start a new order

• User clicks on Offers tab and prepares to scan offer

• N/A

• No action

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

• User sees pop up in Kiosk letting user know they will not gain/burn any loyalty points with this order

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

  Image Added

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

Image Added

• Loyalty points balance is not updated, since the guest is scanning an offer

• Offer pre-selection is cleared

• Call the Identify endpoint, which will return the Loyalty User ID, a list of offer(s) pre-selected, loyalty points balance and a transaction ID

• The Loyalty API will know this store does not have Loyalty enabled

Guest customizes offers at will and adds to basket

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

  Image Added

• 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 v1 - Error List for details.

• The Validate call will return an error if any Rewards are added to cart

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

• No action

• Only the second offer is added to the guest’s pre-selection

  Image Added

• A unique offer code is generated

• No action

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

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

Image Added

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

Image Added

• Loyalty points balance is not updated, since the guest is scanning an offer

• Offer pre-selection is cleared

• Keep track of the current basket contents including offers

• Void the previous transaction

• Call the Identify endpoint again, which will create a new transaction ID and selected offers

• Update the basket with the offers returned

Guest customizes offers at will and adds to basket

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

Image Added

• 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 v1 - Error List for details.

Guest checks out and pays

• Order number shows up on the screen

• Receipt is printed

  Image Added

• Guest does NOT sees updated points balance

• Points do not change from before and after the order was placed

Image Added

• Call the Transaction Update endpoint with a status of CLAIMED to complete the order

• After this call it is not possible to modify the loyalty transaction anymore

• Once this transaction is CLAIMED no Loyalty points are updated in the user’s balance

Guest opens an offer on the RBI app

• N/A

• Reward page is displayed:

  Image Added

• No action

Guest taps “Redeem In restaurant”

• N/A

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

• A unique Reward code is generated

  Image Added

• No action

Guest taps on the Kiosk screen and scans the reward’s QR code or inputs 6 digit code into Kiosk

• User sees pop up in Kiosk letting user Rewards are not supported in this store and they will not gain/burn any loyalty points with this order

• Nothing changes on order / cart that was gathered in the Kiosk

• Modal is shown to guest informing that this store does not participate in the loyalty program and no loyalty points will be earned

• Call the Identify endpoint, which will return the Loyalty User ID, a list of Reward(s) pre-selected, loyalty points balance and a transaction ID

• The Kiosk vendor will know this store does not have Loyalty enabled and show error message to let user know they cannot redeem rewards

• If a transaction is sent with a reward in cart for a store that does not have in-store loyalty, the Loyalty APIs will return an error

Guest opens Loyalty Code on the RBI app

• N/A

• Image Added

• Not

Guest taps on the Kiosk screen and scans the Loyalty QR code or inputs 6 digit code into Kiosk

• User sees pop up in Kiosk letting user know loyalty is not supported in this store and they will not gain/burn any loyalty points with this order

• Nothing changes on order / cart that was gathered in the Kiosk

• Modal is not shown to guest

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

• The Kiosk vendor will know this store does not have Loyalty enabled and show an error message to let users know that they won’t earn points with this transaction (e.g. e.g. ‘Thanks for scanning your MyBK code! Unfortunately this restaurant does not support loyalty yet so you won’t earn points with this transaction.’).