Get 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

WhenfetchDataForAllPrograms is truefetchDataForAllPrograms is false
programId is passedYou 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 passedYou 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

ParameterDatatypeDescription
entityIdlongUnique ID of the customer.
promisedPointsBreakupobjBreak up details of promised points.
mainPointsintThe current redeemable points
totalPointsintThe sum of both current redeemable points and promised points.
delayedAccrualPointsintPromised points
externalTriggerBasedPointsintPromised points converted to regular points upon receipt of an external trigger.
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!