Get Points Balance

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.

Query Params

source

string

required

Source in which the customer identifier is available.

accountId

string

Account in which the customer details are available (Required only for sources with multiple accounts).

identifierName

string

required

Identifier type used for the customer.

identifierValue

string

required

Value of the respective identifier. For example if identifierName is email, then the identifierValue needs to be the email ID of the customer.

programId

int32

Unique ID of the loyalty program from which points balance needs to retrieve. If not passed, it shows the points balance in the default program.

entityType

string

Pass CUSTOMER to fetch the individual customer’s points balance, FLEET to see group-level details. Default value is CUSTOMER.

fetchDataForAllPrograms

boolean

Defaults to false

Pass true to fetch the sum of points balance from all the available programs of the org. Default value is false.

Headers

X-CAP-API-OAUTH-TOKEN

string

Responses

Language

Credentials

Basic

base64

URL

Request


xxxxxxxxxx
1
http://eu.api.capillarytech.com/v2/customers/points/balance/{{id}}?programId=115&entityType=CUSTOMER&fetchDataForAllPrograms=true

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Important Note

Response Parameters

200200

400400