get https://{host}/v2/customers/lookup/points/balance
Retrieves points balance of a customer from a single program or all programs of the org. Points are aggregated for each Point Category - Main, delayed accrual, and external trigger based.
This is a light API.
Important Note
| When | fetchDataForAllPrograms is true | fetchDataForAllPrograms is false |
|---|---|---|
| programId is passed | You will still see points balance of the customer across all programs. | You will still see points balance of the customer for that particular program. |
| programId is not passed | You will still see points balance of the customer across all programs. | You will still see points balance of the customer for the default program. |
Response Parameters
| Parameter | Datatype | Description |
|---|---|---|
| entityId | long | Unique ID of the customer. |
| promisedPointsBreakup | obj | Break up details of promised points. |
| mainPoints | int | The current redeemable points |
| totalPoints | int | The sum of both current redeemable points and promised points. |
| delayedAccrualPoints | int | Promised points |
| externalTriggerBasedPoints | int | Promised points converted to regular points upon receipt of an external trigger. |