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.
URI: /services/data/vXX.X/actions/standard/getPointsBalance
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token
| Input | Type | Description |
|---|---|---|
LoyaltyProgramMemberId | string | Required. ID of the loyalty program member to whom the points balance are to be fetched. |
ProgramCurrencyName | string | Required. The name of the program currency. |
ProgramName | string | Required. The name of the loyalty program. |
| Output | Type | Description |
|---|---|---|
LoyaltyProgramMemberId | ID | ID of the loyalty program member. |
PointsBalance | integer | The points available for the loyalty program member. |
ProgramCurrencyName | string | The name of the program currency. |
ProgramName | string | The name of the loyalty program. |
EscrowPointsBalance | double | The number points that are placed in escrow for the member. This field is available in API version 53.0 and later. |
Sample Request
Sample Response