v1
latestOpenAPI 3.0.32026-07-243003151.2 MBCalculate Points to be Earned
This API method allows the calling application to request an amount of points calculation (how much points should be credited for that potential transaction). EES AIR will use Scheme Earn definitions, take into account what is the Total Transaction Value, where this transaction would happen (which Client Location) or which Rate should be used for that calculation and return proposed points amount.
Path parameters
EES AIR Scheme ID
Query parameters
The monetary value of the transaction to base the earn calculation on, denominated to the smallest currency unit
The incoming identifier of the store. If provided, it will be used by EES AIR to find a specific earn rate for a specific location. If not provided, the caller unit (arisen from used API key) will be used to find earn rate information. In both cases, we will also try and traverse the hierarchy to find a matching earn rate.
The incoming identifier of the parent store. If passed, it will be used by EES AIR to find a specific earn rate for a specific location. Please note this parameter would be ignored if no location[storeId] provided
If passed, it will instruct EES AIR to use the specific override rate (not a default one)
Response
OK