Overview - MX Documentation

An account represents a financial account held by a financial institution, e.g., a user’s checking or savings account. An account belongs to a member, which represents the user’s overall relationship with a particular financial institution. A checking account may be just one part of a larger relationship that could also include a car loan and a savings account.

Accounts and the transactions associated with them — are updated every 24 hours, unless the associated user is disabled. This is technically done by updating member connections.

Account Fields

Field Name	Data type	Description
`account_number`	String	The account number associated with the `account`. This will typically be a masked or partial account number.
`apr`	Decimal	The annual percentage rate associated with the `account`.
`apy`	Decimal	The annual percentage yield associated with the `account`.
`available_balance`	Decimal	The balance that is available for use in asset accounts like checking and savings.
`available_credit`	Decimal	The amount of credit available for use in liability accounts like credit cards and lines of credit.
`balance`	Decimal	The current balance of the account. This is the value used for the account balance displayed in MX UIs.
`cash_balance`	Decimal	The cash balance of the `account`.
`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.
`created_at`	String	The date and time at which the `account` was created on the MX Platform.
`credit_limit`	Decimal	The credit limit associated with the `account`.
`currency_code`	String	The three-character ISO 4217 currency code.
`day_payment_is_due`	String	The day of the month the payment is due.
`death_benefit`	Integer	The amount paid to the beneficiary of the account upon death of the account owner.
`federal_insurance_status`	String	Whether the account is insured by the FDIC or NCUA. Possible values: `INSURED`, `NOT_INSURED`.
`guid`	String	The unique identifier for the `account`. Defined by MX.
`holdings_value`	Decimal	The value of the holdings associated with the account.
`institution_code`	String	A unique identifier for the `institution` associated with this `account`. Defined by MX.
`insured_name`	String	The name of the insured individual.
`interest_rate`	Decimal	The interest rate associated with the `account`.
`is_closed`	Boolean	Whether the account has been closed.
`last_payment_at`	String	The date and time of the most recent payment on the `account`.
`last_payment`	Decimal	The amount of the most recent payment on the `account`.
`loan_amount`	Decimal	The amount of the loan associated with the `account`.
`matures_on`	String	The date on which the `account` matures.
`member_guid`	String	The unique identifier for the `member` to which the `account` belongs, assigned by MX.
`minimum_balance`	Decimal	The minimum balance associated with the `account`.
`minimum_payment`	Decimal	The minimum payment required for an account.
`name`	String	The human-readable name for the `account`.
`original_balance`	Decimal	The original balance associated with the `account`. Always positive.
`pay_out_amount`	String	The amount paid out to the insured individual or beneficiary.
`payment_due_at`	String	The date and time at which the next payment is due on the `account`.
`payoff_balance`	Decimal	The payoff balance for a debt `account`.
`premium_amount`	Decimal	The insurance policy’s premium amount.
`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 sum of the long and short positions, sweep account, cash balance, and margin debt. Does not represent an account balance.
`type`	String	The general or parent type of the `account`.
`updated_at`	String	The date and time at which the `account` was most recently updated.
`user_guid`	String	The unique identifier for the `user` to which the `account` belongs.

Account Types and Subtypes

Each top-level item represents an account_type. Items in each dropdown represent an account_subtype.

ANY

Not provided by data partner or invalid number provided.

CHECKING

SAVINGS

MONEY_MARKET
CERTIFICATE_OF_DEPOSIT

LOAN

AUTO
STUDENT
SMALL_BUSINESS
PERSONAL
PERSONAL_WITH_COLLATERAL
HOME_EQUITY
BOAT
POWERSPORTS
RV
HELOC

CREDIT_CARD

INVESTMENT

PLAN_401_K, PLAN_403_B, PLAN_529, IRA, ROLLOVER_IRA, ROTH_IRA
TAXABLE, NON_TAXABLE, BROKERAGE, TRUST
UNIFORM_GIFTS_TO_MINORS_ACT, PLAN_457, PENSION
EMPLOYEE_STOCK_OWNERSHIP_PLAN, SIMPLIFIED_EMPLOYEE_PENSION, SIMPLE_IRA
PLAN_ROTH_401_K, FIXED_ANNUITY, VARIABLE_ANNUITY, HSA
TAX_FREE_SAVINGS_ACCOUNT, INDIVIDUAL, REGISTERED_RETIREMENT_INCOME_FUND
CASH_MANAGEMENT_ACCOUNT, EMPLOYEE_STOCK_PURCHASE_PLAN
REGISTERED_EDUCATION_SAVINGS_PLAN, PROFIT_SHARING_PLAN
UNIFORM_TRANSFER_TO_MINORS_ACT, PLAN_401_A, SARSEP_IRA
FIXED_ANNUITY_TRADITIONAL_IRA, VARIABLE_ANNUITY_TRADITIONAL_IRA
SEPP_IRA, INHERITED_TRADITIONAL_IRA, FIXED_ANNUITY_ROTH_IRA
VARIABLE_ANNUITY_ROTH_IRA, INHERITED_ROTH_IRA, COVERDELL
ADVISORY_ACCOUNT, BROKERAGE_MARGIN, CHARITABLE_GIFT_ACCOUNT
CHURCH_ACCOUNT, CONSERVATORSHIP, CUSTODIAL
DEFINED_BENEFIT_PLAN, DEFINED_CONTRIBUTION_PLAN, EDUCATIONAL
ESTATE, EXECUTOR, GROUP_RETIREMENT_SAVINGS_PLAN
GUARANTEED_INVESTMENT_CERTIFICATE, HRA, INDEXED_ANNUITY
INVESTMENT_CLUB, IRREVOCABLE_TRUST, JOINT_TENANTS_BY_ENTIRITY
JOINT_TENANTS_COMMUNITY_PROPERTY, JOINT_TENANTS_IN_COMMON
JOINT_TENANTS_WITH_RIGHTS_OF_SURVIVORSHIP, KEOUGH_PLAN
LIFE_INCOME_FUND, LIVING_TRUST, LOCKED_IN_RETIREMENT_ACCOUNT
LOCKED_IN_RETIREMENT_INVESTMENT_FUND, LOCKED_IN_RETIREMENT_SAVINGS_ACCOUNT
MONEY_PURCHASE_PLAN, PARTNERSHIP, PLAN_409_A, PLAN_ROTH_403_B
REGISTERED_DISABILITY_SAVINGS_PLAN, REGISTERED_LOCKED_IN_SAVINGS_PLAN
REGISTERED_PENSION_PLAN, REGISTERED_RETIREMENT_SAVINGS_PLAN
REVOCABLE_TRUST, ROTH_CONVERSION, SOLE_PROPRIETORSHIP
SPOUSAL_IRA, SPOUSAL_ROTH_IRA, TESTAMENTARY_TRUST
THRIFT_SAVINGS_PLAN, INHERITED_ANNUITY, CORPORATE_ACCOUNT
LIMITED_LIABILITY_ACCOUNT

LINE_OF_CREDIT

MORTGAGE

PROPERTY

APPLIANCES, ART, COMPUTER, ELECTRONICS, FURNITURE
JEWELRY, MISCELLANEOUS, REAL_ESTATE, SPORTS_EQUIPMENT, VEHICLE

CASH

INSURANCE

VEHICLE_INSURANCE, DISABILITY, HEALTH, LONG_TERM_CARE
PROPERTY_AND_CASUALTY, UNIVERSAL_LIFE, TERM_LIFE, WHOLE_LIFE
ACCIDENTAL_DEATH_AND_DISMEMBERMENT, VARIABLE_UNIVERSAL_LIFE

PREPAID

CHECKING_LINE_OF_CREDIT

DIGITAL_WALLET

​Account Fields

​Account Types and Subtypes

Account Fields

Account Types and Subtypes