---
title: "Calculate Points to be Earned"
method: GET
path: "/scheme/{schemeId}/earn/calculate"
tags: ["Accounts"]
---

# Calculate Points to be Earned

`GET /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.

## Path parameters

- `schemeId` string, string, required

## Query parameters

- `totalTransactionValue` integer, required
- `location[storeId]` string, string
- `location[storeParentId]` string, string
- `rateName` string, string

## Response `200`

OK

- object
  - `totalTransactionValue` integer, required — The value of the transaction used for the calculation
  - `rateName` string, string, required — The name of the used rate definition
  - `location` LocationEntity, required
    - `location` string, string — [Optional] Outlet incoming identifier where Transaction has happened
  - `balances` object, required
    - `current` integer, required — Points amount suggested by EES AIR based on provided values and existing Scheme Earn Rates definitions

## Other responses

- `400` — Bad Request.
- `401` — Unauthorized.
- `403` — Forbidden.
- `404` — Not Found.
- `415` — Unsupported Media Type
- `423` — Locked
- `429` — Too Many Requests
- `500` — Server Error

---

[API](https://skmtc.net/eagleeye/apis/wallet-api.md) · [All operations](https://skmtc.net/eagleeye/apis/wallet-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeye/wallet-api/revisions/90a122bb14cc/schema)