Versions Compared

Old Version 10

changes.mady.by.user Silva, Carlos

Saved on

compared with

New Version Current

changes.mady.by.user Lopes da Costa, Valentina

Saved on

Key

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

...

The scenarios above are accompanied by the Loyalty API - ReferenceDeveloper Guide documentation, which details the different endpoints needed to integrate POS, Kiosk or other systems to the RBI platform.

If you are ready to use the Loyalty API, you can start here: Loyalty API - Getting Started.

In general, the API integration follows the same pattern for both POS and Kiosk applications:

  • Call Loyalty API v1 - Identify once per scan and keep track of all the offers and rewards that were added to the basket (remembering to call Loyalty API v1 - Void on the second and subsequent scans);

  • Call Loyalty API v1 - Update with a status of PENDING when a reward is added to basket to update the guest’s loyalty points;

  • Call Loyalty API v1 - Validate prior to collecting payment, to ensure that the combination of offers and rewards in the cart do not trigger any rule evaluation errors;

  • Call Loyalty API v1 - Update with a status of CLAIMED to conclude the Loyalty transaction after payment has been collected;

  • Call Loyalty API v1 - Void if the guest cancels the transaction at any point.