Skip to main content

Account Fields

Field NameData TypeDescription
account_numberStringThe account number. In some cases this may be a partial or masked value.
aprDecimal (10,6)Annual percentage rate.
apyDecimal (10,6)Annual percentage yield.
available_balanceDecimal (14,2)The balance available for use in asset accounts like checking and savings. Pending transactions are typically included.
available_creditDecimal (14,2)The amount of credit available for liability accounts like credit cards and lines of credit. Pending transactions are typically included.
balanceDecimal (14,2)The current balance of the account. Pending transactions are typically not included.
cash_advance_aprDecimal (10,6)APR values for cash advances.
cash_surrender_valueDecimal (10,2)Amount paid if the policy is terminated before maturity or insured event occurs.
credit_limitDecimal (14,2)The credit limit on the account.
currency_codeStringThree-character ISO 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 the month payment is due.
death_benefitDecimal (10,0)Amount paid to beneficiary upon death.
guidStringUnique MX-defined account identifier.
federal_insurance_statusStringIndicates whether account is insured by FDIC or NCUA.
has_monthly_transfer_limitBooleanIndicates if account limits transfers monthly.
hold_totalDecimal (14,2)Total monetary amount of holds on the account.
idString (1024)Unique partner-provided identifier for the account.
insured_nameStringName of insured individual.
interest_paid_previous_yearDecimal (10,2)Interest paid during previous year.
interest_paid_ytdDecimal (10,2)Interest paid year to date.
interest_rateDecimal (10,2)Interest rate percentage.
is_closedBooleanIndicates whether the account is closed.
is_hiddenBooleanIndicates whether the account is hidden.
last_paymentDecimal (10,2)Amount of last payment.
last_payment_atIntegerDate and time of last payment.
last_payment_onStringDate of last payment.
loan_amountDecimal (14,2)Original loan amount.
matures_atIntegerDate and time account matures.
matures_onStringMaturity date of account.
member_guidStringMX-defined member identifier associated with account.
member_idStringPartner-provided member identifier.
metadataStringAdditional partner-defined account 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 for current cycle.
monthly_transfer_countDecimalNumber of limited transfers this month.
nameString (1024)Human-readable account name visible to users.
next_paymentDecimal (10,2)Amount due for next payment.
nicknameString (1024)User-provided nickname for the account.
original_balanceDecimal (14,2)Original balance of account.
past_due_amountDecimal (10,2)Delinquent payment amount.
past_due_atIntegerDate and time payment becomes delinquent.
past_due_onStringDate payment becomes delinquent.
payment_due_atIntegerDate and time payment is due.
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 amount of pending transactions.
premium_amountDecimal (10,2)Insurance premium amount.
principal_balanceDecimal (10,2)Principal balance for loan accounts.
routing_numberStringRouting number for account.
started_atIntegerDate and time loan or liability account started.
started_onStringDate loan or liability account started.
statement_balanceDecimal (14,2)Balance at end of last statement period.
statement_closed_onStringClosing date of last billing cycle.
statement_late_chargesDecimal (10,2)Late charges applied during statement period.
subtypeStringAdditional account subtype information.
typeStringSpecific account type.
user_guidStringMX-defined user identifier associated with account.
user_idStringPartner-provided user identifier.

Account Types

TypeSupertypeNotes
ANYUNKNOWNDefault if invalid or not provided.
CHECKINGASSET
SAVINGSASSET
LOANLIABILITY
CREDIT_CARDLIABILITY
INVESTMENTASSET
LINE_OF_CREDITLIABILITY
MORTGAGELIABILITY
PROPERTYASSET
CASHASSET
INSURANCELIABILITYOptional type.
PREPAIDLIABILITYOptional type.

Account Subtypes

SubtypeParent Type
MONEY_MARKETSAVINGS
CERTIFICATE_OF_DEPOSITSAVINGS
AUTOLOAN
STUDENTLOAN
SMALL_BUSINESSLOAN
PERSONALLOAN
HOME_EQUITYLOAN
PLAN_401_KINVESTMENT
IRAINVESTMENT
ROTH_IRAINVESTMENT
BROKERAGEINVESTMENT
PENSIONINVESTMENT
BOATLOAN
RVLOAN
HELOCLOAN
FIXED_ANNUITYINVESTMENT
VARIABLE_ANNUITYINVESTMENT
VEHICLE_INSURANCEINSURANCE
HEALTHINSURANCE
TERM_LIFEINSURANCE
WHOLE_LIFEINSURANCE
HSAINVESTMENT
CASH_MANAGEMENT_ACCOUNTINVESTMENT
CORPORATE_ACCOUNTINVESTMENT
LIMITED_LIABILITY_ACCOUNTINVESTMENT
HSA_SAVINGSINVESTMENT
HSA_CHECKINGINVESTMENT

Account Supertypes

SupertypeNotes
UNKNOWN
ASSETAccounts that are generally considered to be an asset to the user.
LIABILITYAccounts that are generally considered to be a liability to the user.