Fields Descriptions
Rewards Fields
Here's the provided information formatted as a Markdown table:
| Field | Data Type | Definition |
|---|---|---|
account_guid | String | 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. |
This table provides a clear overview of each field's data type and definition.
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
MILESPOINTSSEGMENTSDOLLARS
Account Fields
Here's the Markdown table with code ticks added to the first column:
| Field Name | Data Type | Definition |
|---|---|---|
account_number | String | The account number. This will typically be a masked or partial account number. |
apr | Decimal | Annual Percentage Rate. Max length is 10,6. |
apy | Decimal | Annual Percentage Yield. Max length is 10,6. |
available_balance | Decimal | The balance currently available in an account. Max length is 14,2. |
available_credit | Decimal | The currently available credit balance of an account. This field is for accounts with types CREDIT CARD and LINE OF CREDIT. |
balance | Decimal | An account's current balance. Max length is 14,2. |
cash_balance | Decimal | The cash balance of the account. Max length is 14,2. |
cash_surrender_value | Decimal | The sum of money paid to the policyholder or annuity holder in the event the policy is voluntarily terminated before it matures, or the insured event occurs. Max length is 14,2. |
created_at | String | The date and time the account was created. |
credit_card_product_guid | String | The unique identifier for the credit_card_product associated with the account. Defined by MX. |
credit_limit | Decimal | The credit limit for the account. Max length is 10,2. |
currency_code | String | The three-character ISO 4217 currency code, e.g. USD. |
current_reward_level | String | The current level of reward program associated with the account, e.g., silver, jade, platinum. |
day_payment_is_due | Integer | The day of the month the payment is due. Max length is 2. So, for example, the 14th is passed as 14). |
death_benefit | Decimal | Amount paid to the beneficiary of the account upon death of the account owner. Max length is 14,2. |
enrolled_in_rewards_on | String | The date on which the account was enrolled in a rewards program. |
guid | String | Unique identifier for the account. Defined by MX. |
holdings_value | Decimal | The value of the holdings associated with the account. |
institution_code | String | Unique identifier for the financial institution which holds the account. Defined by MX. |
interest_rate | Decimal | Interest rate. Max length is 10,6. |
is_closed | Boolean | If an account is closed, this field will be true. Otherwise, this field will be false. |
last_payment_at | String | The date and time the last payment toward a debt account was applied. |
last_payment | Decimal | The amount of the last payment made on a debt account, such as an account of type CREDIT CARD or MORTGAGE. Max length is 10,2. |
loan_amount | Decimal | The amount of the loan. Max length is 14,2. |
matures_on | String | Date on which an account matures. |
member_guid | String | Unique identifier for the member to which this account belongs. Defined by MX. |
minimum_balance | Decimal | Minimum required balance for the account. This is normally a positive number. Max length is 14,2. |
minimum_payment | Decimal | The minimum payment required for an account. This can apply to any debt account. Max length is 10,2. |
name | String | This must be a human-readable name for the account. It will be visible to the user. |
next_reward_level | String | The next level of reward program for which the account is eligible , e.g., silver, jade, platinum. |
original_balance | Decimal | The original balance on an account. This will be a positive value. Max length is 14,2. |
payment_due_at | String | The date and time the next payment on a debt account is due. |
payoff_balance | Decimal | Payoff Balance (positive value normally). Can apply to any debt account. Max length is 14,2. |
primary_reward_unit | String | The unit type for the reward program associated with the account, for example, MILES or POINTS. |
started_on | String | The date on which a debt account was started. |
subtype | String | The account's subtype, e.g., PLAN_401_K, MONEY_MARKET, or HOME_EQUITY. |
total_account_value | Decimal | The total value of the account. Max length is 14,2. |
type | String | The main type of an account, e.g., INVESTMENT, PREPAID, or SAVINGS. |
updated_at | String | The date and time at which the account was last updated. |
user_guid | String | A unique identifier for the user to which the account belongs. Defined by MX. |
Credit Card Product Fields
Field | Data Type | Definition |
|---|---|---|
annual_fee | Decimal | The annual fee associated with the credit_card_product. |
duration_of_introductory_rate_on_balance_transfer | Integer | The duration of an introductory rate on balance transfers, given in months. |
duration_of_introductory_rate_on_purchases | Integer | The duration of an introductory rate on purchases, given in months. |
guid | String | The unique identifier for the credit_card_product. Defined by MX. |
has_cashback_rewards | Boolean | This indicates whether the credit card offers cashback rewards. |
has_other_rewards | Boolean | This indicates whether the credit card offers a rewards system that is different than standard cashback or travel rewards. |
has_travel_rewards | Boolean | This indicates whether the credit card offers travel rewards. |
has_zero_introductory_annual_fee | Boolean | This indicates whether the credit card offers a limited time period where a membership fee is waived. |
has_zero_percent_introductory_rate | Boolean | This indicates whether the credit card offers a zero percent introductory rate. |
has_zero_percent_introductory_rate_on_balance_transfer | Boolean | This indicates that the credit card offers a zero percent rate when transferring a balance from a different credit card. |
is_accepting_applicants | Boolean | This indicates whether the financial institution is still accepting applicants for the credit card. |
is_active_credit_card_product | Boolean | This indicates whether the credit card is still supported by the financial institution. |
is_small_business_card | Boolean | This indicates whether the credit card is associated with a small business. |
name | String | The name associated with the credit_card_product. |
_10