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

Cashier is prompted whether the Guest has loyalty, and confirms

• Cashier asked if guest is a loyalty member and clicks on “Ok”

• No action

• No action

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

• Either by scanning or entering the code, POS confirms successful identification (since the reward code also identifies the Loyalty user):

• Reward is added to POS cart

• Guest receives a successful confirmation modal

• 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

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

Cashier attempts to finalize the order but there is a payment failure and order is not completed

• Order at the POS is cancelled

• A few seconds later, the loyalty points of the pre-selected reward are returned to the guest

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

• Call the Void endpoint to cancel the order

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

Cashier checks out and pays

• Order number shows up on the POS screen

• Receipt is printed

• 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

Cashier taps on the POS screen and scans the reward’s QR code or inputs the guest’s 6 digit code into POS

• Cashier sees pop up in POS letting user know loyalty is not supported in this store and that the guest will not gain/burn any loyalty points with this order

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

• 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 POS vendor will know this store does not have Loyalty enabled and show error message to let cashier know the guest 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

Cashier taps on the POS screen and scans the reward’s QR code or inputs the guest’s 6 digit code into POS

• Cashier sees pop up in POS letting user know loyalty is not supported in this store and that the guest will not gain/burn any loyalty points with this order

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

• 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 POS 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.’).