...
The scenarios above are accompanied by the Loyalty API - Reference documentation, which details the different endpoints needed to integrate POS, Kiosk or other systems to the RBI platform.
Using the API endpoints should follow this pattern:
...
Call the Identify endpoint using either the Loyalty Code or the unique code generated when offers/rewards are pre-selected
...
Call the Transaction Validate endpoint to check that the contents of the basket is valid. The endpoint will return errors in multiple scenarios documented here: Loyalty API - Error List. For an optimal guest (in the case of kiosks) or operator (in the case of POS) experience, our recommendation is to call Transaction Validate every time the user changes the offers and/or rewards contained in the basket. If network latency is an issue, integrators have the option to call this endpoint only once prior to payment. If Transaction Validate does not return errors, the loyalty transaction is expected to succeed in the last step below.
...
If the guest has made changes to rewards in their basket, call the Transaction Update endpoint which will update the guest’s loyalty points balance. Note that the Transaction Update endpoint returns less detailed error information than Transaction Validate in case it fails, which means they need to be called separately.
...
Collect payment from the guest
...
Call the Transaction Update endpoint with a status of CLAIMED, which will close the loyalty transaction and permanently alter the guest's loyalty point balance.
...
If you are ready to use the Loyalty API, you can start here: Loyalty API - Getting Started.