Newer Version Available

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

Get Points Balance Actions

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

This object 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
GET, HEAD, POST
Authentication
Authorization: Bearer token

Inputs

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

Outputs

Output Details
PointsBalance
Type
integer
Description
The points available for the loyalty program member.
ProgramName
Type
string
Description
The name of the loyalty program.
ProgramCurrencyName
Type
string
Description
The name of the program currency.
LoyaltyProgramMemberId
Type
ID
Description
ID of the loyalty program member.

Example

Sample Request

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

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   }
10}