Account - MX Documentation

The account file should contain only accounts belonging to the member objects contained in the Member File.

All date fields ending with _on are expected as an ISO 8601 formatted date only with no timestamp (for example, 2024-04-20).

Account Fields

Field Name	Data Type (Max)	Description
`account_number`	String	The account number. In some cases this may be a partial or masked value.
`apr`	Decimal (10,6)	Annual percentage rate.
`apy`	Decimal (10,6)	Annual Percentage yield.
`available_balance`	Decimal (14,2)	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 (14,2)	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 (14,2)	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_surrender_value`	Decimal (10,2)	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.
`credit_limit`	Decimal (14,2)	The credit limit on this account. Can apply to any liability account.
`currency_code`	String	The three-character ISO 4217 currency code.
`day_payment_is_due`	Integer	The day of the month a payment is due. Use `payment_due_at` or `payment_due_on` instead of `day_payment_is_due` if the full date is available.
`death_benefit`	Decimal (10,0)	The amount paid to the beneficiary of the account upon death of the account owner.
`guid`	String	The unique identifier for the account. Defined by MX.
`id`	String (1024)	The unique partner-provided identifier for the account. The `id` can’t begin with `ACT-` as this is reserved for the system. It must be unique for all accounts belonging to a member. The account ID is used for matching purposes within MX’s PFM product (widgets) and must be returned as the same value in all subsequent account synchronizations. It can include numbers, letters, dashes, and underscores.
`insured_name`	String	The name of the insured individual as provided by the data provider.
`interest_rate`	Decimal (10,2)	The interest rate percentage.
`is_closed`	Boolean	This identifies if an account is closed.
`is_hidden`	Boolean	This indicates whether the account has been hidden. Defaults to `false`.
`last_payment`	Decimal (10,2)	The amount of the account’s last payment.
`last_payment_at`	Integer	The date and time of the account’s last payment.
`last_payment_on`	String	The date of the account’s last payment.
`loan_amount`	Decimal (14,2)	The original amount of the loan.
`matures_at`	Integer	The date and time the account matures.
`matures_on`	String	This is the maturity date for this account.
`member_guid`	String	The unique identifier for the member associated with this account. Defined by MX.
`member_id`	String	The unique, partner-provided identifier for the member associated with this account.
`metadata`	String	Additional information you can store on the account. Metadata will not be displayed to a user unless specific arrangements are made.
`minimum_balance`	Decimal (14,2)	The minimum required balance, normally a positive value.
`minimum_payment`	Decimal (10,2)	The minimum payment for the current payment cycle. Can apply to any liability account.
`name`	String (1024)	The account name is the textual representation of the account. This value is visible to the user and must be human-readable. WARNING: Unescaped XML or JSON characters will break your integration. See Escaped Characters for more information.
`nickname`	String (1024)	The user-provided nickname for the account. This may be displayed to the user in place of the account `name`.
`original_balance`	Decimal (14,2)	This is the original balance for this account, normally a positive value.
`payment_due_at`	Integer	The date and time for the current payment cycle.
`payment_due_on`	String	The due date for the current payment cycle.
`payoff_balance`	Decimal (14,2)	The payoff balance, normally a positive value. Can apply to any liability account.
`premium_amount`	Decimal (10,2)	The insurance policy’s premium amount.
`started_at`	Integer	The date and time the loan or other debt account was started.
`started_on`	String	The date the loan or other liability account started.
`statement_balance`	Decimal (14,2)	The balance at the end of the account’s last statement period.
`subtype`	String	The account subtype represents additional type information on the account being returned. See Account Subtypes for available account subtypes.
`type`	String	The account type represents the specific type of account being returned. See Account Types for available account types.
`user_guid`	String	The unique identifier for the user associated with this account. Defined by MX.
`user_id`	String	The unique, partner-provided identifier for the user associated with this account.

Account File Parameters

The action field tells us what data operation to perform for each row in the file. Options are upsert (an insert/update depending on if the object already exists) and delete (which will destroy the record). If no action is provided the default action is upsert.

The skip_webhook parameter prevents a webhook being sent for the action effected by each row. Accepted values are true or false. If skip_webhook is not provided, MX will default to your internal batch configuration setting.

Field	Required for Upsert?	Required for Delete?	Type
`id`	Yes	Yes	String
`user_id`	Yes	Yes	String
`member_id`	Yes	Yes	String
`balance`	Yes	No	Decimal
`name`	Yes	No	String
`type`	Yes	No	String
`account_number`	No	No	String
`apr`	No	No	Decimal
`apy`	No	No	Decimal
`available_balance`	No	No	Decimal
`available_credit`	No	No	Decimal
`cash_surrender_value`	No	No	Decimal
`credit_limit`	No	No	Decimal
`currency_code`	No	No	String
`day_payment_is_due`	No	No	Integer
`death_benefit`	No	No	String
`insight_parameters`	No	No	String
`insured_name`	No	No	String
`insured_status`	No	No	String
`interest_rate`	No	No	Decimal
`is_closed`	No	No	Boolean
`is_hidden`	No	No	Boolean
`last_payment`	No	No	Decimal
`last_payment_at`	No	No	Integer
`last_payment_on`	No	No	String
`loan_amount`	No	No	Decimal
`matures_at`	No	No	Integer
`matures_on`	No	No	String
`metadata`	No	No	String
`minimum_balance`	No	No	Decimal
`minimum_payment`	No	No	Decimal
`nickname`	No	No	String
`original_balance`	No	No	Decimal
`pay_out_amount`	No	No	Decimal
`payment_due_at`	No	No	Integer
`payment_due_on`	No	No	String
`payoff_balance`	No	No	Decimal
`premium_amount`	No	No	Decimal
`skip_webhook`	No	No	Boolean
`started_at`	No	No	Integer
`started_on`	No	No	String
`statement_balance`	No	No	Integer
`subtype`	No	No	String

Sample File

The following is a sample Account batch CSV file.

CSV

"action","id","user_id","member_id","balance","name","type"
"upsert","A-1234-Chk","U-39XBF7","M-39XBF7",100.00,"Primary Checking","CHECKING"

​Account Fields

​Account File Parameters

​Sample File

Account Fields

Account File Parameters

Sample File