Overview

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.

info

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. PENDING transactions are typically taken into account with the available balance, but this may not always be the case. available_balance will usually be a positive value for all account types, determined in the same way as the balance field.
available_credit	Decimal	The amount of credit available for use in liability accounts like credit cards and lines of credit. PENDING transactions are typically taken into account with available credit, but this may not always be the case. available_credit will usually be a positive value for all account types, determined in the same way as the balance field.
balance	Decimal	The current balance of the account. PENDING transactions are typically not taken into account with the current balance, but this may not always be the case. This is the value used for the account balance displayed in MX UIs. The balance will usually be a positive value for all account types. Asset-type accounts (CHECKING, SAVINGS, INVESTMENT) may have a negative balance if they are in overdraft. Debt-type accounts (CREDIT_CARD, LOAN, LINE_OF_CREDIT, MORTGAGE) may have a negative balance if they are overpaid.
cash_balance	Decimal	The cash balance of the account.
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, or the insured event occurs.
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. For example, the 14th is passed as 14.
death_benefit	Integer	The amount paid to the beneficiary of the account upon death of the account owner.
federal_insurance_status	String	The federal insurance status of the account. Indicates whether the account is insured by the FDIC or NCUA (FDIC for banks, NCUA for credit unions). The possible values are INSURED and 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	This indicates whether an 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. This can apply to any debt account. Max length is 10,2.
name	String	The human-readable name for the account.
original_balance	Decimal	The original balance associated with the account. This will always be positive.
pay_out_amount	String	The amount paid out to the insured individual or beneficiary under the conditions of the insurance policy.
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. This will normally be a positive number.
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, the sweep account and/or cash balance, and any margin debt associated with a particular account. This amount includes the market value of all positions held in the account and is reduced by any debit balance and the amount of short options positions that are "in the money". This may sum to a negative value, and it does not represent an account balance. Max length is 14,2.
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

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.

Account types

ANY Not provided by data partner or invalid number provided

CHECKING

SAVINGS

LOAN

CREDIT_CARD

INVESTMENT

LINE_OF_CREDIT

MORTGAGE

PROPERTY

CASH

INSURANCE

PREPAID

CHECKING_LINE_OF_CREDIT

DIGITAL_WALLET