| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The unique ID of the reward. |
globally unique identifier |
None. |
| payoutId |
The unique ID of the payout that the reward is associated with. |
globally unique identifier |
None. |
| payoutDescription |
A description of the payout. |
string |
None. |
| programId |
The unique ID of the referral program. |
globally unique identifier |
None. |
| programName |
The name of the referral program |
string |
None. |
| memberId |
The unique ID of the member assocaiated with the reward. |
globally unique identifier |
None. |
| referralId |
The unique ID of the referral assocaiated with the reward. |
globally unique identifier |
None. |
| type |
The type of reward. This can either be a 'Member' or 'Referral' |
string |
None. |
| recipientId |
The unique ID of the recipient of the reward. This will be the same as either MemberId or ReferralId |
globally unique identifier |
None. |
| recipientName |
The name of the recipient of the reward. |
string |
None. |
| recipientEmailAddress |
The email address of the recipient of the reward |
string |
None. |
| recipientExternalIdentifier |
The external identifier of the recipient |
string |
None. |
| externalIdentifier |
An alternative ID provided to help link the reward to relevant data in external systems. |
string |
None. |
| status |
The status of the reward. This can either be Pending, Processing, or Issued. |
string |
None. |
| amount |
The monetary value of the reward, if any. |
decimal number |
None. |
| createDate |
The date when the recipient earned the reward. |
date |
None. |
| issueDate |
The date when the recipient received the reward. |
date |
None. |
| eligibilityDate |
The date when the recipient received the reward. |
date |
None. |
| description |
The date when the recipient received the reward. |
string |
None. |
| transactionID |
Reward's Transaction ID. |
globally unique identifier |
None. |
| updateDate |
The date when the reward was last updated. |
date |
None. |
| referralDisplayName |
Reward's Display Name. |
string |
None. |
| currencyCode |
Payout's Currency Code. |
string |
None. |
| source |
Source of the Reward. This can either be Referral Action, Status Based or Manual |
string |
None. |
| programRewardRuleId |
The Program Reward Rule Id |
globally unique identifier |
None. |
| paymentType |
The Reward payout type |
string |
None. |
| paymentCode |
The Reward payout code |
string |
None. |
| completeNote |
The Reward payout completion note |
string |
None. |