Skip to main content

Account Fields

Field NameData TypeDescription
account_numberStringAccount number (may be partial or masked).
aprDecimal (10,6)Annual percentage rate.
apyDecimal (10,6)Annual percentage yield.
available_balanceDecimal (14,2)Balance available for use in asset accounts (e.g. checking, savings). May include pending transactions.
available_creditDecimal (14,2)Credit available for liability accounts (e.g. credit cards). May include pending transactions.
balanceDecimal (14,2)Current account balance used in MX UIs.
cash_advance_aprDecimal (10,6)APR for cash advances.
cash_surrender_valueDecimal (10,2)Value returned if policy is terminated early.
credit_limitDecimal (14,2)Credit limit for the account.
currency_codeStringISO 4217 currency code.
daily_deposit_limit_currentDecimal (10,2)Current daily deposit limit.
daily_deposit_limit_totalDecimal (10,2)Total daily deposit limit.
day_payment_is_dueIntegerDay of month payment is due.
death_benefitDecimal (10,0)Amount paid upon death of account holder.
guidStringMX-defined account identifier.
federal_insurance_statusStringFDIC/NCUA insurance status.
has_monthly_transfer_limitBooleanIndicates monthly transfer limit (Reg D).
hold_totalDecimal (14,2)Total holds on account.
idString (1024)Partner-defined unique account ID.
insured_nameStringName of insured individual.
interest_paid_previous_yearDecimal (10,2)Interest paid last year.
interest_paid_ytdDecimal (10,2)Interest paid year-to-date.
interest_rateDecimal (10,2)Interest rate percentage.
is_closedBooleanWhether account is closed.
is_hiddenBooleanWhether account is hidden.
last_paymentDecimal (10,2)Last payment amount.
last_payment_atIntegerTimestamp of last payment.
last_payment_onStringDate of last payment.
loan_amountDecimal (14,2)Original loan amount.
matures_atIntegerTimestamp of maturity.
matures_onStringMaturity date.
member_guidStringMX member ID.
member_idStringPartner member ID.
metadataStringAdditional stored metadata.
minimum_balanceDecimal (14,2)Minimum required balance.
monthly_deposit_limit_currentDecimal (10,2)Current monthly deposit limit.
monthly_deposit_limit_totalDecimal (10,2)Total monthly deposit limit.
minimum_paymentDecimal (10,2)Minimum payment due.
monthly_transfer_countDecimalNumber of transfers this month.
nameString (1024)Human-readable account name.
next_paymentDecimal (10,2)Next payment amount.
nicknameString (1024)User-defined account nickname.
original_balanceDecimal (14,2)Original account balance.
past_due_amountDecimal (10,2)Past due amount.
past_due_atIntegerTimestamp when account becomes past due.
past_due_onStringDate when account becomes past due.
payment_due_atIntegerPayment due timestamp.
payment_due_onStringPayment due date.
payoff_balanceDecimal (14,2)Payoff balance.
pay_out_amountDecimal (10,2)Insurance payout amount.
pending_balanceDecimal (14,2)Balance after pending transactions.
pending_transactions_totalDecimal (14,2)Total pending transactions.
premium_amountDecimal (10,2)Insurance premium amount.
principal_balanceDecimal (10,2)Loan principal balance.
routing_numberStringRouting number (may be masked).
started_atIntegerLoan start timestamp.
started_onStringLoan start date.
statement_balanceDecimal (14,2)Last statement balance.
statement_closed_onStringStatement close date.
statement_late_chargesDecimal (10,2)Late charges in statement period.
subtypeStringAccount subtype.
typeStringAccount type.
user_guidStringMX user ID.
user_idStringPartner user ID.

Account Federal Insurance Statuses

StatusNotes
UNKNOWN_INSUREDDefault when unknown.
NOT_INSUREDAccount is not insured.
INSUREDAccount is insured.

Account Types

TypeSupertypeNotes
ANYUNKNOWNDefault value
CHECKINGASSET
SAVINGSASSET
LOANLIABILITY
CREDIT_CARDLIABILITY
INVESTMENTASSET
LINE_OF_CREDITLIABILITY
MORTGAGELIABILITY
PROPERTYASSET
CASHASSET
INSURANCELIABILITYOptional
PREPAIDLIABILITYOptional

Account Subtypes

SubtypeParent Type
MONEY_MARKETSAVINGS
CERTIFICATE_OF_DEPOSITSAVINGS
AUTOLOAN
STUDENTLOAN
SMALL_BUSINESSLOAN
PERSONALLOAN
HOME_EQUITYLOAN
PLAN_401_KINVESTMENT
IRAINVESTMENT
ROTH_IRAINVESTMENT
TAXABLEINVESTMENT
BROKERAGEINVESTMENT
PENSIONINVESTMENT
HELOCLOAN
BOATLOAN
RVLOAN
VEHICLE_INSURANCEINSURANCE
HEALTHINSURANCE
TERM_LIFEINSURANCE
WHOLE_LIFEINSURANCE
HSAINVESTMENT
BROKERAGE_MARGININVESTMENT
CUSTODIALINVESTMENT
TRUSTINVESTMENT
ROTH_CONVERSIONINVESTMENT

Account Supertypes

SupertypeNotes
UNKNOWN
ASSETAccounts considered assets to the user.
LIABILITYAccounts considered liabilities to the user.