Skip to main content

Fields Descriptions

Rewards Fields

Here's the provided information formatted as a Markdown table:

FieldData TypeDefinition
account_guidStringThe 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_typeString (enumerated)The type of balance associated with the reward, for example, BALANCE_TO_LEVEL, or TOTAL_BALANCE.
balanceDecimalThe balance of the reward.
created_atStringThe time at which the reward was created.
descriptionStringThe description for the reward as given by the data provider.
expires_onStringThe date on which the balance expires.
guidStringThe unique identifier for the reward. Defined by MX.
member_guidStringThe unique identifier for the member associated with the reward. Defined by MX.
unit_typeString (enumerated)The units in which the balance is given, for example, MILES or POINTS.
user_guidStringThe 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 TypeDefinition
BALANCEThe reward balance.
BALANCE_TO_LEVELThe balance required to reach a reward level.
BALANCE_TO_REWARDThe balance required to qualify for a reward.
EXPIRING_BALANCEThe reward balance that will be expiring.
TOTAL_BALANCEThe total reward balance available.

Unit Types

  • MILES
  • POINTS
  • SEGMENTS
  • DOLLARS

Account Fields

Here's the Markdown table with code ticks added to the first column:

Field NameData TypeDefinition
account_numberStringThe account number. This will typically be a masked or partial account number.
aprDecimalAnnual Percentage Rate. Max length is 10,6.
apyDecimalAnnual Percentage Yield. Max length is 10,6.
available_balanceDecimalThe balance currently available in an account. Max length is 14,2.
available_creditDecimalThe currently available credit balance of an account. This field is for accounts with types CREDIT CARD and LINE OF CREDIT.
balanceDecimalAn account's current balance. Max length is 14,2.
cash_balanceDecimalThe cash balance of the account. Max length is 14,2.
cash_surrender_valueDecimalThe 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_atStringThe date and time the account was created.
credit_card_product_guidStringThe unique identifier for the credit_card_product associated with the account. Defined by MX.
credit_limitDecimalThe credit limit for the account. Max length is 10,2.
currency_codeStringThe three-character ISO 4217 currency code, e.g. USD.
current_reward_levelStringThe current level of reward program associated with the account, e.g., silver, jade, platinum.
day_payment_is_dueIntegerThe day of the month the payment is due. Max length is 2. So, for example, the 14th is passed as 14).
death_benefitDecimalAmount paid to the beneficiary of the account upon death of the account owner. Max length is 14,2.
enrolled_in_rewards_onStringThe date on which the account was enrolled in a rewards program.
guidStringUnique identifier for the account. Defined by MX.
holdings_valueDecimalThe value of the holdings associated with the account.
institution_codeStringUnique identifier for the financial institution which holds the account. Defined by MX.
interest_rateDecimalInterest rate. Max length is 10,6.
is_closedBooleanIf an account is closed, this field will be true. Otherwise, this field will be false.
last_payment_atStringThe date and time the last payment toward a debt account was applied.
last_paymentDecimalThe 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_amountDecimalThe amount of the loan. Max length is 14,2.
matures_onStringDate on which an account matures.
member_guidStringUnique identifier for the member to which this account belongs. Defined by MX.
minimum_balanceDecimalMinimum required balance for the account. This is normally a positive number. Max length is 14,2.
minimum_paymentDecimalThe minimum payment required for an account. This can apply to any debt account. Max length is 10,2.
nameStringThis must be a human-readable name for the account. It will be visible to the user.
next_reward_levelStringThe next level of reward program for which the account is eligible , e.g., silver, jade, platinum.
original_balanceDecimalThe original balance on an account. This will be a positive value. Max length is 14,2.
payment_due_atStringThe date and time the next payment on a debt account is due.
payoff_balanceDecimalPayoff Balance (positive value normally). Can apply to any debt account. Max length is 14,2.
primary_reward_unitStringThe unit type for the reward program associated with the account, for example, MILES or POINTS.
started_onStringThe date on which a debt account was started.
subtypeStringThe account's subtype, e.g., PLAN_401_K, MONEY_MARKET, or HOME_EQUITY.
total_account_valueDecimalThe total value of the account. Max length is 14,2.
typeStringThe main type of an account, e.g., INVESTMENT, PREPAID, or SAVINGS.
updated_atStringThe date and time at which the account was last updated.
user_guidStringA unique identifier for the user to which the account belongs. Defined by MX.

Credit Card Product Fields

FieldData TypeDefinition
annual_feeDecimalThe annual fee associated with the credit_card_product.
duration_of_introductory_rate_on_balance_transferIntegerThe duration of an introductory rate on balance transfers, given in months.
duration_of_introductory_rate_on_purchasesIntegerThe duration of an introductory rate on purchases, given in months.
guidStringThe unique identifier for the credit_card_product. Defined by MX.
has_cashback_rewardsBooleanThis indicates whether the credit card offers cashback rewards.
has_other_rewardsBooleanThis indicates whether the credit card offers a rewards system that is different than standard cashback or travel rewards.
has_travel_rewardsBooleanThis indicates whether the credit card offers travel rewards.
has_zero_introductory_annual_feeBooleanThis indicates whether the credit card offers a limited time period where a membership fee is waived.
has_zero_percent_introductory_rateBooleanThis indicates whether the credit card offers a zero percent introductory rate.
has_zero_percent_introductory_rate_on_balance_transferBooleanThis indicates that the credit card offers a zero percent rate when transferring a balance from a different credit card.
is_accepting_applicantsBooleanThis indicates whether the financial institution is still accepting applicants for the credit card.
is_active_credit_card_productBooleanThis indicates whether the credit card is still supported by the financial institution.
is_small_business_cardBooleanThis indicates whether the credit card is associated with a small business.
nameStringThe name associated with the credit_card_product.

_10