Envestnet · Schema

RewardBalance

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name	Type	Description
expiryDate	string	The date on which the balance expires. Account Type: Aggregated Applicable containers: reward Endpoints: GET accounts GET accounts/{accountId}
balanceToReward	string	The balance required to qualify for a reward such as retaining membership, business reward, etc. Account Type: Aggregated Applicable containers: reward Endpoints:
balanceType	string	The type of reward balance. Account Type: Aggregated Applicable containers: reward Endpoints: GET accounts GET accounts/{accountId} GET dataExt
balance	number	The actual reward balance. Account Type: Aggregated Applicable containers: reward Endpoints: GET accounts GET accounts/{accountId} GET dataExtr
description	string	The description for the reward balance as available at provider source. Account Type: Aggregated Applicable containers: reward Endpoints: GET accounts
balanceToLevel	string	The balance required to reach a reward level. Account Type: Aggregated Applicable containers: reward Endpoints: GET accounts GET accounts/{accountId}
units	string	Unit of reward balance - miles, points, segments, dollars, credits. Account Type: Aggregated Applicable containers: reward Endpoints: GET accounts GET

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RewardBalance",
  "title": "RewardBalance",
  "type": "object",
  "properties": {
    "expiryDate": {
      "type": "string",
      "description": "The date on which the balance expires.<br><br><b>Account Type</b>: Aggregated<br><b>Applicable containers</b>: reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
      "readOnly": true
    },
    "balanceToReward": {
      "type": "string",
      "description": "The balance required to qualify for a reward such as retaining membership, business reward, etc.<br><br><b>Account Type</b>: Aggregated<br><b>Applicable containers</b>: reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
      "readOnly": true
    },
    "balanceType": {
      "type": "string",
      "description": "The type of reward balance.<br><br><b>Account Type</b>: Aggregated<br><b>Applicable containers</b>: reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values</b><br>",
      "readOnly": true,
      "enum": [
        "EXPIRING_BALANCE",
        "BALANCE_TO_LEVEL",
        "BALANCE_TO_REWARD",
        "BALANCE",
        "TOTAL_BALANCE"
      ]
    },
    "balance": {
      "type": "number",
      "description": "The actual reward balance.<br><br><b>Account Type</b>: Aggregated<br><b>Applicable containers</b>: reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
      "format": "double",
      "readOnly": true
    },
    "description": {
      "type": "string",
      "description": "The description for the reward balance as available at provider source.<br><br><b>Account Type</b>: Aggregated<br><b>Applicable containers</b>: reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
      "readOnly": true
    },
    "balanceToLevel": {
      "type": "string",
      "description": "The balance required to reach a reward level.<br><br><b>Account Type</b>: Aggregated<br><b>Applicable containers</b>: reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
      "readOnly": true
    },
    "units": {
      "type": "string",
      "description": "Unit of reward balance - miles, points, segments, dollars, credits.<br><br><b>Account Type</b>: Aggregated<br><b>Applicable containers</b>: reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
      "readOnly": true
    }
  }
}