MX Technologies · Controlled Vocabulary
MX Technologies API Vocabulary
Terms and field definitions extracted from the MX Platform API OpenAPI specification
397 Terms
Updated
MX Technologies Vocabulary is a controlled vocabulary published by MX Technologies on the APIs.io network, defining 397 terms.
Defined terms include scope, authorization_code, code, account_guid, and account_number_last_four.
A controlled vocabulary pins the words an API’s schemas, parameters and documentation use to one agreed definition each — the shared language a human or an agent needs to read the API the same way its authors do.
Showing the first 250 of 397 terms. The full vocabulary is in
the source file linked above.
Terms
scope
authorization_code
code
account_guid
The unique identifier for an account. Defined by MX.
account_number_last_four
The last 4 digits of the account number used for the transaction by the Originating Depository Financial Institution (ODFI).
account_type
The type of account. Some account types may include subtypes.
ach_initiated_at
The date and time when the transaction was initiated by the Originating Depository Financial Institution (ODFI) in ISO 8601 format without timestamp.
client_guid
The unique identifier for the client associated with the insight. Defined by MX.
corrected_account_number
The account number correction reported by the RDFI. Populate only if the `resolution_code` is `NOTICE_OF_CHANGE`.
corrected_routing_number
The routing number correction reported by the RDFI. Populated only if the `resolution_code` is `NOTICE_OF_CHANGE`. Must be a valid 9-digit routing number format.
created_at
The date and time the ACH return was created, represented in ISO 8601 format with a timestamp.
guid
The unique identifier for the ACH return record. Defined by MX.
id
Client-defined identifier for this specific return submission. Allows you to track and reference your requests.
institution_guid
The unique identifier for an institution. Defined by MX.
investigation_notes
Notes added by Product Support during investigation of the ACH return.
member_guid
The unique identifier for the member. Defined by MX.
processing_errors
Any errors that occurred during processing.
resolution_code
A short, machine-readable code that categorizes the type of resolution or reason for the status. See [Resolution Codes](/api-reference/platform-api/reference/ach-return-fields#resolution-codes) for a complete list.
resolution_detail
A more detailed, human-readable message providing context and next steps related to the `return_status` and `resolution_code`.
resolved_status_at
Date and time when the return was marked as resolved.
return_code
The associated ACH return codes and notice of change codes (for example, R02, R03, R04, R05, R20, NOC). See [Return Codes](/api-reference/platform-api/reference/ach-return-fields#return-codes) for a complete list
return_notes
Notes that you set to inform MX on internal ACH processing.
return_account_number
Incorrect account number used in the ACH transaction.
return_routing_number
Incorrect routing number used in the ACH transaction.
return_status
The current processing status of the ACH return. See [Return Status](/api-reference/platform-api/reference/ach-return-fields#return-status) for a complete list of statuses.
returned_at
The date and time when the return was reported by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp.
sec_code
The three-letter SEC code (Standard Entry Class Code) describing how a payment was authorized (for example, `WEB`). See [SEC Codes](/api-reference/platform-api/reference/ach-return-fields#sec-codes) for a complete list.
started_processing_at
Date and time when MX started processing the return.
submitted_at
Date and time when the record was submitted through the API.
transaction_amount
The amount of the transaction.
updated_at
Date and time when the ACH return record was last updated.
user_guid
The unique identifier for the user. Defined by MX.
ach_return
current_page
The page delivered by the current response.
per_page
The number of records delivered with each page.
total_entries
The total number of records available.
total_pages
The total number of pages available.
ach_returns
pagination
transaction_amount_range
The transaction amount range, used for impact assessment.
is_default
Indicates whether the category is an MX-created default category. This will always be `false` for custom categories.
is_income
Indicates whether the transaction is income.
metadata
Additional information you stored on the `category`.
name
The name of the category.
parent_guid
The unique identifier for the parent category. Defined by MX.
categories
category
forgot_password_url
URL for the forgot password page of the institution.
forgot_username_url
URL for the forgot username page of the institution.
instructional_text
instructional_text_steps
An array of instructional steps that may contain html elements.
is_disabled_by_client
Indicates whether the institution is disabled by the client.
is_hidden
If the institution is available for creating new member connections, this field will be `false`. Otherwise, this field will be `true`.
iso_country_code
The ISO country code associated with the institution.
medium_logo_url
The URL for a 100px X 100px logo for each `institution`. A generic logo is returned for institutions that don't have one.
small_logo_url
The URL for a 50px X 50px logo for each `institution`. A generic logo is returned for institutions that don't have one.
supported_products
supports_oauth
If true, this indicates that the institution supports OAuth and that you have been properly registered for OAuth with that institution.
supports_tax_document
This indicates whether the institution supports tax documents.
trouble_signing_in_url
The URL of the institution for helping users troubleshoot any other sign-in issue.
url
The URL for an institution's website.
institutions
institution
display_order
field_name
field_type
label
type
credentials
city
The city name.
country
The country name.
latitude
The latitude of the location where the transaction occurred. The number is a signed decimal (for example, Rio de Janeiro's latitude is -22.9027800 and Tokyo's latitude is 35.689488).
longitude
The longitude of the location where the transaction occurred. The number is a signed decimal (for example, Rio de Janeiro's longitude is -43.2075000 and Tokyo's longitude is 139.691706).
merchant_guid
The unique identifier for the merchant. Defined by MX.
phone_number
The phone number of the merchant location.
postal_code
The postal code of the merchant location.
state
The state abbreviation of the merchant location.
street_address
The street address of the merchant location.
merchant_location
logo_url
The URL for a 100px X 100px logo for the merchant.
website_url
URL to the merchant's website.
merchants
merchant
amount
The monetary amount of the `transaction`.
description
The description of the `transaction` to be enhanced.
extended_transaction_type
The transaction type assigned by the partner.
memo
This field contains additional descriptive information about the `transaction`.
merchant_category_code
The ISO 18245 category code for the `transaction`.
transactions
categorized_by
The method used to determine the category assigned to the transaction.
category_guid
The unique identifier for the category. Defined by MX.
described_by
The method used to describe the `transaction`.
is_bill_pay
Indicates whether the transaction is a bill payment.
is_direct_deposit
Indicates whether the transaction is a direct deposit.
is_expense
Indicates whether the transaction is an expense.
is_fee
Indicates whether the transaction is a fee.
is_international
Indicates whether the transaction is international. If the data provider determines it isn't international then it will be `false`. It will be `null` if the data provider does not have this information.
is_overdraft_fee
Indicates whether the transaction is an overdraft fee.
is_payroll_advance
Indicates whether the transaction is a payroll advance.
is_subscription
Indicates whether the transaction is a subscription payment.
merchant_location_guid
The unique identifier for the `merchant_location` associated with this `transaction`. Defined by MX.
original_description
The original description of the `transaction` as provided by our data feed.
top_level_category_guid
The unique identifier for the `top_level_category` associated with this `transaction`. Defined by MX.
email
The email address associated with the account.
is_disabled
Indicates whether the user has been disabled. Defaults to `false`.
users
user
account_number
The account number associated with the account. This will typically be a masked or partial account number.
account_ownership
The type of ownership associated with the account. `NULL` is returned if not received in the data feed.
annuity_policy_to_date
The date until which the policy is in effect.
annuity_provider
The provider of the insurance policy.
annuity_term_year
The effective duration of an insurance policy (one year, five years, etc.).
apr
The annual percentage rate associated with the `account`.
apy
The annual percentage yield associated with the `account`.
available_balance
The balance that is available for use in asset accounts like checking and savings. `PENDING` transactions are typically (not always) taken into account with the available balance. `available_balance` will usually be a positive value for all account types, determined in the same way as the balance field.
available_credit
The amount of credit available for use in liability accounts like credit cards and lines of credit. `PENDING` transactions are typically (not always) taken into account with available credit. `available_credit` will usually be a positive value for all account types, determined in the same way as the `balance` field.
balance
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. 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
The cash balance of the `account`.
cash_surrender_value
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
The credit limit associated with the `account`.
currency_code
The three-character ISO 4217 currency code, for example, `USD`.
day_payment_is_due
The day of the month the payment is due. For example, the 14th is passed as `14`.
death_benefit
The amount paid to the beneficiary of the account upon death of the account owner.
federal_insurance_status
The federal insurance status of the account. Indicates whether the account is insured by the FDIC (banks) or NCUA (credit unions). Returns an integer (`UNKNOWN_INSURED` = 0, `INSURED` = 1, `NOT_INSURED` = 2).
imported_at
The date and time at which the `account` was last successfully aggregated and received data.
interest_rate
The interest rate associated with the account.
institution_code
The code identifying a financial institution.
insured_name
The name of the insured person.
is_closed
Indicates whether an account has been closed. Closed accounts will no longer update balance or transaction information.
is_manual
Indicates whether the transaction was manually created or belongs to a manual account.
last_payment
The amount of the most recent payment on the `account`.
last_payment_at
The date and time when the last payment was made, represented in ISO 8601 format with a timestamp.
loan_amount
The amount of the loan associated with the `account`.
margin_balance
Represents the amount of debt the investor owes to the broker for the use of margin. It can be positive or negative, depending on the performance of the investments made with the borrowed funds. A positive margin balance indicates that the securities purchased on margin have increased in value, whereas a negative margin balance signifies that the securities have decreased in value.
matures_on
The date on which the `account` matures.
member_id
The unique, partner-defined, identifier for the member associated with this `account`.
member_is_managed_by_user
This indicates whether the member is managed by the user or the MX partner. Members created with the managed member feature will have this field set to `false`.
minimum_balance
The minimum balance associated with the `account`.
minimum_payment
The minimum payment required for an account. This can apply to any debt account.
nickname
An alternate name for the `account`.
original_balance
The original balance associated with the `account`. This will always be positive.
pay_out_amount
The amount paid out to the insured individual or beneficiary under the conditions of the insurance policy.
payment_due_at
The date and time at which the next payment is due on the `account`.
payoff_balance
The payoff balance for a debt `account`. This will normally be a positive number.
premium_amount
The insurance policy's premium amount.
property_type
Subtype if the account type is `PROPERTY`. This field should be ignored unless the type is set to PROPERTY.
routing_number
The routing number for the `account`.
started_on
The date on which the loan from a debt account started.
statement_balance
The balance at the end of the account's last statement period.
subtype
The account's subtype, for example, `PLAN_401_K`, `MONEY_MARKET`, or `HOME_EQUITY`. Each subtype belongs to an account `type`. For a full list of account subtypes and types, see [Accounts](/api-reference/platform-api/reference/accounts).
today_ugl_amount
The unrealized gain/loss amount for the day for the account.
today_ugl_percentage
The unrealized gain/loss percentage for the date for the account.
total_account_value
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.
total_account_value_ugl
The unrealized gains and losses represent the amount the account has gained or lost based on the purchase price. This is calculated by subtracting the purchase price from the current market value. It does not affect the account until the positions are sold and "realized". This may sum to a negative value, and it does not represent an account balance.
user_id
The unique partner-defined identifier for the user.
accounts
account_subtype
The account's subtype, for example, `PLAN_401_K`, `MONEY_MARKET`, or `HOME_EQUITY`. Each subtype belongs to an account `type`. For a full list of account subtypes and types, see [Accounts](/api-reference/platform-api/reference/account-types).
is_business
Indicates whether the account is a business account.
skip_webhook
If set to `true`, prevents sending an account webhook for the update if that webhook type is enabled for you.
account
institution_number
The three-digit number identifying a Canadian banking institution.
loan_guarantor
The guarantor of the student loan.
loan_reference_number
The reference number of the student loan.
passed_validation
This indicates whether the account and routing numbers passed MX's internal validity checks. If true, the account and routing/transit numbers are likely (but not guaranteed) to be valid. If false, either the account number, routing/transit number, or both are likely invalid.
sequence_number
The sequence number of the student loan.
transit_number
The five-digit number identifying the branch of a Canadian financial institution.
account_numbers
active_at
The date and time when the insight was activated, represented in ISO 8601 format with a timestamp.
cta_clicked_at
The date and time when a call-to-action was clicked, represented in ISO 8601 format with a timestamp.
has_associated_accounts
Indicates whether there are accounts associated with the insight.
has_associated_categories
Indicates whether there are categories associated with the insight.
has_associated_merchants
Indicates whether there are merchants associated with the insight.
has_associated_scheduled_payments
Indicates whether there are scheduled payments associated with the insight.
has_associated_transactions
Indicates whether there are transactions associated with the insight.
has_been_displayed
Indicates whether the insight has been shown to the end user.
is_dismissed
Indicates whether the insight has been dismissed by the user.
micro_call_to_action
A short call-to-action text for prompting user engagement.
micro_description
A condensed description of the insight.
micro_title
A shorter version of title. For example, `Price Increase` or `Paycheck Deposit`.
template
A short label for the type of `insight` being delivered, for example, `SubscriptionPriceIncrease` or `MonthlyCategoryTotal`.
title
The title for the specific `insight`, for example, `Price Increase` or `Paycheck Deposit`.
insights
account_guids
A list of account GUIDs to merge. Must include at least two GUIDs belonging to the same user.
account_id
The unique client-defined identifier for the account.
check_number_string
The check number for the `transaction`.
date
The date on which the transaction took place. This is the field used when searching for transactions by date and is generally the same as `transacted_at`, but uses `posted_at` as a fallback.
is_recurring
Deprecated. If required, reach out to MX to discuss an alternative.
localized_description
A human-readable description of the transaction, provided in a local language.
localized_memo
Additional descriptive information about the transaction, provided in a local language.
posted_at
The date and time the transaction was posted to the account.
status
The status of the transaction. All transaction data on our systems represent what we get through our data feed which depends what institutions make available for aggregation. Many institutions do not provide data for pending transactions; transactions from those accounts always have a status of `POSTED`. When we do receive data for pending transactions, a single transaction may be updated from `PENDING` to `POSTED` and keep the same `guid`. This is done through various matching methods performed automatically by MX. If a single transaction can't be updated, the `PENDING` transaction will often be deleted and replaced with a new `POSTED` transaction (with a new `guid`) when it is sent to us; this is the most common scenario when pending data is available. In unusual circumstances, there may be separate `PENDING` and `POSTED` transactions on MX systems for up to 14 days. All `PENDING` transactions are deleted after 14 days as a failsafe.
top_level_category
The parent category assigned to this transaction's category.
transacted_at
The date and time the transaction took place.
has_been_viewed
Indicates whether the transaction has been viewed.
transaction
is_completed
Indicates whether the `scheduled_payment` has been paid or not. This field is only applicable to one-time transactions.
occurs_on
The date on which the payment is scheduled to occur, given in ISO 8601 format without a timestamp.
recurrence_day
The day of the month where the next payment is expected to occur.
recurrence_type
The type of recurrence schedule.
transaction_type
The type of transaction.
scheduled_payments
insight
aggregated_at
The date and time the most recent aggregation-type job was started, given in ISO 8601 format with a time component. A job will automatically be started when a member is created or its credentials are updated, unless the `skip_aggregation` parameter is used. Jobs can also be started via manual aggregations, background aggregations, API endpoints, or when opening an MX widget. A job can be a normal aggregation, or a premium job such as identification, verification, fetching statements, or fetching an extended transaction history. If a member is deleted and then re-created with the `skip_aggregation` parameter set to `true` or if it is re-created within the throttle window (typically three hours), the previous value will be returned.
background_aggregation_is_disabled
Indicates whether background aggregation is disabled for the `member`.
connection_status
The status of a user's connection to an institution. See [Member Connection Status](/api-reference/platform-api/reference/member-connection-statuses).
connection_status_message
A human-readable message describing the connection status. See [Member Connection Status](/api-reference/platform-api/reference/member-connection-statuses).
is_being_aggregated
Indicates whether the member was being aggregated at the time of the request.
is_managed_by_user
Indicates whether the member is managed by the user or the MX partner. Members created with the managed member feature will have this field set to `false`.
is_oauth
Indicates whether the member uses OAuth to authenticate. Defaults to `false`.
most_recent_job_detail_code
(Deprecated) This field is no longer used and will be removed at a future date.
most_recent_job_detail_text
(Deprecated) This field is no longer used and will be removed at a future date.
most_recent_job_guid
The unique identifier for the most recent job. Defined by MX.
needs_updated_credentials
Internal field used by MX in some circumstances. When set to `true`, MX will not attempt to aggregate the member. It will be set to `false` automatically when the member's credentials are updated.
oauth_window_uri
When connecting a member using OAuth, this field will contain the URL to send the user to in order to authenticate, otherwise it will be blank.
successfully_aggregated_at
The date and time when the member was last successfully aggregated, represented in ISO 8601 format with a timestamp.
use_cases
The use case associated with the member. Valid values are `PFM` and/or `MONEY_MOVEMENT`. Only set this if you've met with MX and have opted in to using this field.
members
member
products
Contains the products you want to aggregate upon a successful connection. For accepted products, see [Defining Products](/products/connectivity/overview/intro-to-unified-product-ordering/#defining-products).
value
client_redirect_url
This determines the redirect destination at the end of OAuth when used with `is_mobile_webview: true` or `oauth_referral_source: 'APP'`.
data_request
enable_app2app
This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to `true`. When set to `false`, any `oauth_window_uri` generated will **not** direct the end user to the institution's mobile application. This setting is not persistent. This setting currently only affects Chase institutions.
referral_source
ui_message_webview_url_scheme
A client-defined scheme used in OAuth redirects in WebViews. Defaults to `mx`.
address
The account owner's street address.
first_name
The account owner's first name. This may also include a middle name. This field will be `null` unless name splitting has been enabled. Contact MX to have this feature enabled.
last_name
The last name of the account holder.
owner_name
The account owner's name.
phone
The account owner's phone number.
account_owners
data_uri
image_data
image_options
options
challenges
cost_basis
The original value of an asset for tax purposes, usually the purchase price, used to calculate capital gains or losses. Accumulated price.
coupon_yield
The rate of return the bonds coupon rate generates.
current_price
The present market price of a single unit of the holding (for example, stock price per share).
daily_change
The daily change in the `current_price` of the holding since the previous trading day.
expiration
The expiration date associated with the holding.
face_value
The nominal value of a bond or fixed-income security, paid to the holder at maturity.
frequency
The frequency of the interest paid on the bond (i.e. Annually, Monthly, etc.)
market_value
The current market value of the holding, calculated as the current price times the number of units (shares) owned.
maturity_date
The maturity date associated with the holding.
percentage_change
The percent change in the `current_price` of the holding compared to a previous time period. It is the percentage change that reflects the `daily_change`.
purchase_price
The average price paid for the holding.
quantity
The number of units of the holding owned (for example, number of shares of stock).
rate
The interest on the bond, subject to determining the payout amount of the bond.
strike_price
The strike price associated to the option.