| Table of Contents |
|---|
Identify (POST)
Use Case: Successfully identify the loyalty user along with any potential rewards/offers that they had pre-selected within the app.
...
| Code Block |
|---|
{
"balances": [
{
"amount": 14464,
"currency": "points"
}
],
"loyaltyUser": {
"created": "2021-08-10T12:18:39.180Z",
"id": "$loyaltyUserId",
"name": "$loyaltyUserName"
},
"order": [
{
"productId": "$incentivePlu",
"quantity": "1"
"referenceId": "00",
"productType": "REWARD or OFFER"
},
],
"transactionId": "$loyaltyTransactionId"
} |
Transaction Validation (POST)
Use Case: POS sends the Loyalty API a preliminary version of the user’s order so that the Loyalty Platform can evaluate the order and determine if the user meets eligibility requirements of any included incentives (Rewards or Offers). This request should be an exact mirror of what the POS expects to send when they actually claim the transaction.
...
| Code Block |
|---|
{
"code": "RulesError",
"details": {
"ruleEvaluation": [
{
"code": "insufficient-point-balance",
"currentValue": 0,
"message": "User does not have sufficient funds to redeem reward",
"ruleId": "point-balance",
"targetValue": 250
}
],
"isEngineError": true,
"errorConfig": {
"timeout": 0,
"method": "put",
"data": "__REDACTED__",
"url": $url
}
},
"message": "Rule evaluation failed"
} |
Transaction Update (PUT) - Claim / Commit
Use Case: POS sends this transaction request with the order details to update the loyalty transaction. If the POS states this transaction should be claimed, this will result in the user earning and redeeming eligible points.
...
| Code Block |
|---|
{
"points": 102220,
"pointsEarned": 5000,
"pointsRedeemed": 0,
"loyaltyId": "$loyaltyUserId",
"presentation": {
"footer": "Crowns expire 180 days from last purchase. At participating U.S. restaurants. Terms at bk.com/rewards-terms",
"header": "Royal Perks",
"identifier": "Transaction ID: $loyaltyTransactionId",
"pointsEarned": "Earned: 5000",
"totalPoints": "Balance: 102220"
},
"receiptCode": "J25QL1WAH5KJ7P75",
"transactionId": "$loyaltyTransactionId"
} |
Unclaimed Transaction (POST)
Use Case: POS sends the RBI Loyalty Platform a copy of the transaction that takes place without a loyalty user initially identified.
...
| Code Block |
|---|
{
"presentation": {
"footer": "receipt footer",
"header": "receipt header",
"marketing": "receipt marketing promo",
"identifier": "Transaction ID: "$loyaltyTransactionId"
},
"transactionId": "$loyaltyTransactionId"
} |
Void Transaction (PUT)
Use Case: Loyalty transaction needs to be voided/refunded.
...