Calculate Points to be Earned

get

https://wallet.uk.eagleeye.com/2.0/scheme/{schemeId}/earn/calculate

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

schemeId

string

required

EES AIR Scheme ID

Query Params

totalTransactionValue

int64

required

The monetary value of the transaction to base the earn calculation on, denominated to the smallest currency unit

location[storeId]

string

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.

location[storeParentId]

string

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

rateName

string

If passed, it will instruct EES AIR to use the specific override rate (not a default one)

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Choose an example:

application/json

request

response

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

415Unsupported Media Type

423Locked

429Too Many Requests

500Server Error