What is it?
Loyalty Point Exchange API creates or updates the conversion rate between points used in a loyalty program and an ISO currency code. This allows a guest to redeem points for a free or discounted hotel night.
Why use it?
This API allows a chain to upload a bulk mapping between currencies and loyalty points. This is an Administration function that is used to set rate that the chain is willing to accept for exchanging 1 point to 1 unit of a given currency for a provided date range.
How to use
Response Parameters
| Parameter | Description | Type |
|---|---|---|
| chainId | Unique ID that identifies a hotel chain or management group in SynXis. | String |
| loyaltyPrograms/@code | Unique loyalty program code for the chain that supports point redemptions. | String |
| loyaltyPrograms/PointExchangeRates/@amount | Currency value per loyalty point, if null, then clear existing season. | Number |
| loyaltyPrograms/PointExchangeRates/@startDate | Start date of the exchange season. | String(Date) |
| loyaltyPrograms/PointExchangeRates/@endDate | End date of the exchange season. | String(Date) |
| loyaltyPrograms/PointExchangeRates/@currencyCode | Currency code for the monetary unit. Use ISO 4217, three alpha code. | String |
| loyaltyPrograms/PointExchangeRates/@roundingRule | Determine how a value is calculated when it includes decimals. Values: nearestwholeamount, roundup, rounddown. |
String |
Create Loyalty Point conversion to USD for all of 2022
@amount=0.1 means that 1 loyalty point equals $0.10.
"chainId": 12345,
"loyaltyPrograms": [{
"code": "LP1_POINTS",
"pointExchangeRates": [{
"amount": 0.1,
"startDate": "2022-01-01",
"endDate": "2022-12-31",
"currencyCode": "USD",
"roundingRule": "roundup"
}]
}]
}
Create Loyalty Point conversion to EUR with no end date
By ommiting @endDate creates a pricing season that doesn't expire.
"chainId": 12345,
"loyaltyPrograms": [{
"code": "LP1_POINTS",
"pointExchangeRates": [{
"amount": 0.25,
"startDate": "2022-01-01",
"currencyCode": "EUR",
"roundingRule": "roundup"
}]
}]
}
Create Mulitple Loyalty Point to Currency Exchange Rates
Multiple loyalty point to currency exchange rates can be included in the same request.
"chainId": 12345,
"loyaltyPrograms": [{
"code": "LP1_POINTS",
"pointExchangeRates": [{
"amount": 0.1,
"startDate": "2022-01-01",
"endDate": "2022-12-31",
"currencyCode": "USD",
"roundingRule": "roundup"
}, {
"amount": 0.2,
"startDate": "2023-01-01",
"currencyCode": "USD",
"roundingRule": "roundup"
}, {
"amount": 0.135,
"startDate": "2022-01-01",
"currencyCode": "CAD",
"roundingRule": "roundup"
}]
}]
}
Delete a Loyalty Point Exchange Rate
An exchange rate can be deleted by removing the @amount parameter from the request.
"chainId": 12345,
"loyaltyPrograms": [{
"code": "LP1_POINTS",
"pointExchangeRates": [{
"startDate": "2022-03-01",
"endDate": "2022-03-17",
"currencyCode": "USD",
"roundingRule": "roundup"
}]
}]
}