Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

Get Points Balance

Retrieve the loyalty points balance for a specified loyalty program member.

This action is available in API version 51.0 and later for users with Loyalty Management license.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/getPointsBalance
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token

Inputs

Input	Details
LoyaltyProgramMemberId	Type string Description Required. ID of the loyalty program member to whom the points balance are to be fetched.
ProgramCurrencyName	Type string Description Required. The name of the program currency.
ProgramName	Type string Description Required. The name of the loyalty program.

Outputs

Output	Details
LoyaltyProgramMemberId	Type ID Description ID of the loyalty program member.
PointsBalance	Type integer Description The points available for the loyalty program member.
ProgramCurrencyName	Type string Description The name of the program currency.
ProgramName	Type string Description The name of the loyalty program.
EscrowPointsBalance	Type double Description The number points that are placed in escrow for the member. This field is available in API version 53.0 and later.

Example

Sample Request

Sample Response