The unique identifier for the account associated with the reward. Defined by MX. This value may be null if data is not available from the provider.
balance_type
String (enumerated)
The type of balance associated with the reward, for example, BALANCE_TO_LEVEL, or TOTAL_BALANCE.
balance
Decimal
The balance of the reward.
created_at
String
The time at which the reward was created.
description
String
The description for the reward as given by the data provider.
expires_on
String
The date on which the balance expires.
guid
String
The unique identifier for the reward. Defined by MX.
member_guid
String
The unique identifier for the member associated with the reward. Defined by MX.
unit_type
String (enumerated)
The units in which the balance is given, for example, MILES or POINTS.
user_guid
String
The unique identifier for the user associated with the reward. Defined by MX.
Balance Types
Balance type
Definition
BALANCE
The reward balance.
BALANCE_TO_LEVEL
The balance required to reach a reward level.
BALANCE_TO_REWARD
The balance required to qualify for a reward.
EXPIRING_BALANCE
The reward balance that will be expiring.
TOTAL_BALANCE
The total reward balance available.
Unit Types
Unit type
MILES
POINTS
SEGMENTS
DOLLARS
Fetch Rewards
Calling this endpoint initiates an aggregation-type event which will gather the member’s rewards information, as well as account and transaction information.Rewards data is also gathered with Atrium’s daily background aggregations.
WARNINGThis endpoint can trigger multi-factor authentication. It is therefore important that the end user be present when fetching rewards.
Endpoint: POST /users/{user_guid}/members/{member_guid}/fetch_rewards