Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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

1{
2   "inputs":[{
3      "LoyaltyProgramMemberId":"0lMxx0000A000001EAA",
4      "ProgramCurrencyName":"Avios",
5      "ProgramName":"baLoyalty"
6   }]
7}

Sample Response

1{
2   "errors":null,
3   "isSuccess":true,
4   "outputValues":{ 
5        "LoyaltyprogramMemberId":"0lMxx0000A000001EAA",
6        "ProgramCurrencyName":"Avios",
7        "ProgramName":"baLoyalty"
8        "PointsBalance":500.0
9        "EscrowPointsBalance": 25.00
10   }
11}