Added v20250224:
status and client_status fields to Institution responses and include_blocked_institutions query parameter to List Institutions.Added:
widget parameter to the deep_link_params in Get Widget URL With Configuration Options.Added v20250224: widget parameter to the deep_link_params in Request Widget URL.Added v20250224:
created 201 response to the Create Member, descriptions of all statuses.Added:
view to the deep_link_params in Get Widget URL With Configuration Options.Added v20250224: view to the deep_link_params in Request Widget URL.Added:
date_range and account_guid to the deep_link_params in Get Widget URL With Configuration Options.Added: date_range and account_guid to the deep_link_params in Request Widget URL.Replaced
user_guid with user_identifier in POST /widget_urls for v20250224.Added v20250224: List Category Totals by Account, List Category Totals, Read a Job, Aggregate All Members, List Account Balances by , Block an Account, Create Split Transactions by Account, Delete Split Transactions by Account, List Transactions by Account per Member, Read Transaction by Account, Update Transaction by Account.
Added:
date_range and account_guid to the deep_link_params in Request Widget URL.Updated v20250224 & v20111101:
records_per_page on List Institutions and List Favorite Institutions supports up to 1000.Added
deep_link_params to Get Widget URL With Configuration Options.Added deep_link_params to Request Widget URL.Added:
style object parameter to Get Widget URL with Configuration Options.Added: style object parameter to Request Widget URL.Added v20111101: Update Transaction by Account.
Added v20250224:
created_at, guid, and is_hidden fields to Institutions responses.Added v20250224:
/users/{user_guid}/accounts/merge endpoint.Added:
is_disabled_by_client to institution response.Added:
instructional_text_steps and is_disabled_by_client fields to institution.Added:
actionable_integration widget type.Updated v20111101: List Transactions: add new optional query parameters from/to_created_at and from/to_updated_at.Added: actionable_integration widget type to SSO V3.Updated v20111101: List Transactions: add new optional query parameters
category_guid and top_level_category_guid.Updated v20250224: Added fields
top_level_category_guid and user_guid to the Enhance Transaction Response.Updated v20250224: Notifications: add created_on and threshold to response, add request body to create, remove date range parameters from index.Added: Remap Transaction ID endpoint.
Updated v20250224: Member challenges: include
guid for options and image_options.Updated: The
color_scheme request parameter for Request Widget URL now works for all widgets (excluding legacy PFM widgets). It also accepts the optional browser value.Added:
v20250224 version with breaking changes. Full details in Migration guide.Added:
merchant fields: logo_url and website_url, added geolocation fields: country, city, and postal_code, changed merchant_name to name.Added:
include_holdings and include_transactions optional query params to Aggregate Member.Added:
*_set_by fields, feed_* fields, calculated_apr, holdings_value, institution_guid to Account Response.Added:
twice_a_ recurrence type to Repeating Transactions.Added: Initial Data Ready widget event. Only applies if you’re using Platform API v20250224.Added: Initial Data Ready webhook. Only applies if you’re using Platform API v20250224.
Added:
connections_use_case_filter parameter to Get Widget URL with Configuration Options (SSO V3).Added: connections_use_case_filter parameter to Request Widget URL (Platform API).Added: microdeposit_guid metadata parameter to the Microdeposit Comeback, Primary Action Selected widget event.Added: Endpoints to create, read, and list all ACH returns.
Added: Transaction endpoints may have an added optional parameter
includes which will return repeating_transactions, merchants, classifications, geolocations data.Added: Create Member, Update Member, Aggregate Member, Verify Member, and Request Widget URL accept a
X-CALLBACK-PAYLOAD header.Added: The X-CALLBACK-PAYLOAD header will appear in the Member and Member Data Updated webhooks if it was set in the Create/Update Member or Aggregate/Verify Member respectively. This is only for Platform API.Added: The x_callback_payload field will return in the metadata of each Widget Event if the X-CALLBACK-PAYLOAD header was set in the URL request.Added an optional
MX-SKIP-WEBHOOK header to create/update/delete for Holdings, Members, Transactions, and Users.Removed: Support for the
cusip, cusip_set_by, and cusip_set_by_name fields has been removed.Added:
money_dashboard_widget widget type.Added:
use_cases request parameter to Create Member and Update Member.Added: use_case query parameter to List Accounts, List Members, and List Transactions.Added support for
account_numbers to MDX Real Time API.Added:
use_cases field to the Get a Widget URL with Configuration Options endpoint. This only applies if you’ve opted in to using use cases.Added: use_cases field to the Member webhook.Added: use_cases field to the Member resource.Added: The following GET endpoints now accept a use_case query parameter: /members, /accounts, /accounts/partner_created, /accounts/user_created, /transactions, /transactions/by_category_guid/{category_guid}/by_date/{start_date}/{end_date}, /transactions/by_top_level_category_guid/{top_level_category_guids}/by_date/{start_date}/{end_date}, /transactions/created_between/{start_date}/{end_date}, /transactions/updated_between/{start_date}/{end_date}. This only applies if you’ve opted in to using use cases.Added: The following endpoints now accept a use_cases parameter: POST /members, PUT /members/{member_guid}. This only applies if you’ve opted in to using use cases.Added: When the widget makes a data request for an existing member, it will update the member with any new use_cases that were provided. This only applies if you’ve opted in to using use cases.Added: When a new member is created inside of the widget, the use_cases that were provided in the widget URL request will be saved to that member. This only applies if you’ve opted in to using use cases.Updated: The following GET endpoints will only aggregate data if PFM is defined as a use case: /members/{member_guid}/aggregate, /members/aggregate, /members/{member_guid}/refresh, /members/refresh. This only applies if you’ve opted in to using use cases.Added new field
federal_insurance_status to the accounts data model.10/08/2024
DataConnectivity
Account Aggregation, Balance Checks, Extended Transaction History, Investment Data
Added: Investment Data Enhancement. These new endpoints allow you to view investment holdings data by user, member, and account, as well as deactivate a user from the product. Please see the product overview for more information.Added:
federal_insurance_status field to accounts object.Added: Verifiable Credential endpoints.
Added: Insights API.
Added: A
invalidData postmessage for the Connect Widget. This postmessage will be triggered when there are no valid DDA accounts on a member.Added: We now automatically delete stale and inactive microdeposits after 21 days.Added:
micro_pulse_carousel_widget widget_type.Added: A
backToSearch postmessage for the Connect Widget to our INT environment. This postmessage is intended to be used in combination with the disable_search_institution configuration for the Connect Widget.Added:
SpendingPlanCreatedCelebration, lySpendingPlanCelebration, SavingsMilestoneEmergencyFund, and SavingsAccountDeposit insights.Added: Request an Insights Widget with a specified insight_guid at the top of the feed.Updated: WeeklyNoSpendDays now includes a postMessage UI event.Added/Released: Microdeposits is officially generally available. For more information about enabling Microdeposits, contact your MX representative. Documentation is now available publicly.
Added: Overview section clarifying that string values are not encoded.
Added: the
micro_call_to_action field to Insights.Added: Dark mode support that’s set for all users or based on each individual user’s system settings.
Added:
spending_plan_widget and mini_spending_plan_widget widget types.Added: The transactions_created_count and transactions_updated_count fields were removed from the verification webhook response. The accounts field was added.11/28/2023
Personal Finance ManagementConnectivityWebhooks
Connect Widget, Account Aggregation, Account Owner Identification, Connect Widget, Instant Account Verification
Added: Spending Plan Widget.Added: The request widget URL endpoint now accepts the optional
enable_app2app parameter.Added: Spending Plan webhook.Added: Spending Plan endpoints.Added: support for verification webhooks.Added: The list daily files endpoint was previously undocumented. Also added information and instructions on the necessity of byte serving all files over 1GB.
Added
merchant_category_code to the transactions data model. Clarified that values provided in Unix Epoch format must be adjusted by the partner to ensure they are UTC-based.10/23/2023
MDX Real Time APIMDX On Demand APIConnectivity
Account Aggregation, Extended Transaction History, Instant Account Verification, Statements, Account Owner Identification
Changed: The
zip_code field on user objects now supports postal codes in the MDX APIs from the following countries: Canada, Indonesia, Japan, Malaysia, Philippines, South Korea, Thailand, United States, and Vietnam.The supports_oauth field on institution objects returns as true only when the institution supports OAuth and you have been properly registered with that institution.Changed: The error message returned when attempting to create a microdeposit with the same account and routing numbers as an existing microdeposit now includes the GUID of the existing microdeposit.
The
is_recurring field should be ignored.Added new field
category_name to the transactions data model.Removed: The
CONFLICTED and REJECTED statuses are no longer possible in the production environment and have been removed from the status table.Changed: The account_name parameter is no longer required when creating a microdeposit.The
is_recurring field on transactions should be ignored.Added new fields
hold_total and pending_transactions_total to the accounts data model.08/08/2023
Connectivity
Account Aggregation, Instant Account Verification, Account Owner Identification, Extended Transaction History, Statements, Balance Checks
The
enable_app2app parameter was added for member create requests as a body parameter, and for generate OAuth URI requests as a query parameter.08/07/2023
Connectivity
Account Aggregation, Instant Account Verification, Account Owner Identification, Extended Transaction History, Balance Checks
Added: Create manual account and delete manual account endpoints. Expanded permissible fields for update account endpoint.
Added new field
running_balance to the MDX transactions data model.Added the estimated_payment_due_at field to account-related notification webhooks.Added new fields
interest_paid_previous_year, interest_paid_ytd, statement_late_charges, next_payment, principal_balance, daily_deposit_limit_current, daily_deposit_limit_total, ly_deposit_limit_current and ly_deposit_limit_total to the accounts data model.Added information about the
account_owners data model and associated On Demand API endpoint.Added information about the
account_numbers data model and associated On Demand API endpoint.Added additional field is_mobile_webview to Analytics Events and Analytics Pageviews.
03/16/2023
Connectivity
Account Aggregation, Instant Account Verification, Account Owner Identification, Extended Transaction History
Added: the
forgot_password_url, forgot_username_url, and trouble_signing_in_url fields to the institution object.Added: The Connect Widget will now issue a
postMessage when there are no valid DDA account in verification mode, and the user selects OK on the associated error screen.Added: The passed_validation field was added to account numbers objects.Added: Partners may optionally enable display of separate
last_name and first_name fields on account owner objects.Update: The Connect Widget will now issue a postMessage when there are no valid DDA account in verification mode, and the user selects OK on the associated error screen.
Added:
access_tokens for processors now expire 60 days from the time they were issued. All tokens created on or before 2023-02-03 will expire on 2023-04-19.Added: The
mini_pulse_carousel_widget now supports filtering through a query string.01/25/2023
Connectivity
Account Aggregation, Instant Account Verification, Extended Transaction History
Added: A new endpoint for reading account details:
/users/{user_guid}/members/{member_guid}/accounts/{account_guid}.01/12/2023
Connectivity
Account Aggregation, Instant Account Verification, Extended Transaction History
Added: The list accounts by user and list accounts by member endpoints now accept the optional
member_is_managed_by_user query string parameter.01/04/2023
Connectivity
Account Aggregation, Instant Account Verification, Account Owner Identification, Extended Transaction History, Statements
Added: The list users endpoint now accepts query parameters to search for users by
id, email, and is_disabled.12/21/2022
Connectivity
Account Aggregation, Instant Account Verification, Account Owner Identification, Extended Transaction History, Statements
Added: The list accounts by member endpoint (
/users/{user_guid}/members/{member_guid}/accounts) is now available for use.Added: The Connect Widget configuration now accepts the
include_identity parameter.Added: The Connect Widget configuration now accepts the
include_identity parameter.Added: The /authorization_code and /token endpoints were added for processor token.Changed: The /payment_processor_token endpoint has been deprecated. New processors should use the /token endpoint instead.Added: The response for the
/payment_account endpoint now returns the user_guid, member_guid, and account_guid.Changed: Only standard aggregations will trigger the agg throttle period. This throttle only applies standard aggs, and no other agg-type jobs are throttled.
Added: The
job_guid, user_id, and is_background fields were added to the AGGREGATION webhook payload.Added the
job_guid, is_background, and user_id fields to the AGGREGATION webhook payload.Added
member_guid to the payloads for transaction and account-related notification webhooks.Changed: Requests to microdeposit API endpoints no longer require the beta accept header.
Added: Microdeposit and account verification objects now include the
institution_name field.Added: Added a section to the introduction explaining the four resource groups, which ones are enabled by default, and which ones must be enabled separately. Added more information about each of the resources in the analytics events group.
Added
member_guid to the transactions webhook.Added: The get payment account information endpoint was un-deprecated.
Removed:
verifyError step has been removed and is no longer part of the Connect Widget flow. The widget now handles this scenario in the connecting step. The most common scenario that led users to this step has been optimized and no longer happens.Removed:
wait_for_full_aggregation is no longer used. Widget behaves as if it was true.Updated:
wait_for_full_aggregation is no longer used. Widget behaves as if it was true.Added: The
holding_type_id field now appears on holding resources.Added: Processor Token endpoints for instant account verification are now available.
Changed: Renamed
stepChange’s selectMember step to verifyExistingMember for clarification.Updated: Renamed Connect Widget’s
stepChange’s selectMember step to verifyExistingMember for clarification.Added: Added
error_reason to the values we may return as part of the client_redirect_url.The table explaining member connection statuses was expanded to include more information as well as the
PENDING status.Added: The
instructional_text field now appears on institution objects.Added:
disable_background_agg is now available as an option for the Connect Widget.Added: A
type field to credentials responses for the Platform API.The
created_at field was incorrectly shown as an ISO value in the example payload for beat webhooks. It has been corrected to a Unix timestamp.The check_number field was incorrectly documented as an integer. It has been corrected to a string.
Added:
member_guid field to oauthRequest postMessage payload.Added: The mini_pulse_carousel_widget now supports filtering through a query string.The
is_oauth field was added to member webhooks.The beats webhook was deprecated.
Added: List default categories endpoint and read default category endpoints.
Added:
es is now available as a language option for the Connect Widget.Added notification profiles to the list of resources available in a snapshot.
Several enumerated values were missing from the documentation for the
notification_type and notification_type_name fields. These values are not new, but were incorrectly left out of the documentation.Added: New fields to the enhance transactions endpoint:
category_guid, date, memo.Added:
es is now available as a language option for the Connect Widget.Changed: Updated the description on PostMessages (Come Back, Error, Verified). The cURL examples were corrected to use
GET instead of POST.11/02/2021
Personal Finance ManagementConnectivityLegacy APIsFinancial Insights
Connect Widget, SSO V3
Added:
es is now available as a language option for the Connect Widget.Removed: Support for IE11.Added the
available_credit, cash_advance_apr, cash_surrender_value, death_benefit, has_ly_transfer_limit, insured_name, is_personal, last_payment_on, loan_amount, ly_transfer_count, pay_out_amount, pending_balance, premium_amount, statement_balance, and statement_on fields to the spec for accounts objects.Added: The
category_guid field is now returned on transaction responses.The payload for the
member_data_updated webhook was corrected.Added the
FileName field for SFTP manifest files.Added:
imported_at field for accounts.Added discovered accounts and discovered transactions to the Reporting API.Added:
logo_updated_at field for merchant resources.The definition of the
aggregated_at field for members was updated to include more detail on when it is set and updated.Added several more entries to the list of beat templates.08/18/2021
Connectivity
Account Aggregation, Instant Account Verification, Account Owner Identification, Extended Transaction History
Added: The
user_id and member_id fields are now returned in account responses.Updated the definitions for the
balance, available_balance, and available_credit fields to conform with those used across all MX documentation.07/27/2021
Connectivity
Account Aggregation, Instant Account Verification, Account Owner Identification, Extended Transaction History
Added: The
user_id field is now returned in member responses.Added: The
member_is_managed_by_user field in the account and transaction fields lists.Added support for
holdings to MDX On Demand API.Added:
skip_aggregation query parameter for the generate OAuth window URI member endpoint.Added:
mx/connect/memberDeleted postMessage event.Added:
include_transactions parameter for verification and identification.Added: The merchant_location_guid field is now returned in responses from the enhance transactions endpoint.Clarified how partners should handle webhook requests and under what circumstances an error response should be returned to MX. Also clarified changes that can occur in webhook payloads.
Added definitions for the
is_recurring, is_subscription, and scheduled_payment_guid fields for transaction webhooks.Added documentation related to testing webhooks.Added: New postMessage event for Insights Widget.
Added: List transactions by account endpoint.
Added documentation on the is_being_aggregated field for member webhook payloads.
Removed the
statement_on and statement_at fields; these were replaced with the more clear statement_closed_on field.Added: Documented the list tag transactions endpoint.New product: Statements.
Added: Member connected, primary action selected postMessage for Connect Widget.
Added the
displayed_at and has_been_displayed fields to the spec for beat objects.Added:
is_recurring and is_subscription field on transaction objects.Added:
onEvent function/event handler for the Connect loader, which is compatible with ui_message_version: 4.Added: New extend history endpoint.
Added the
cash_advance_apr and statement_on fields to MDX APIs.Added the user_communication_profile resource to the Reporting API.Added: new insurance-related fields on the accounts resource:
insured_name, pay_out_amount, and premium_amount.Added the
EncryptedFileSize field for SFTP manifest files.Added documentation on the
is_relevant field for beats webhooks.Added: Five types of webhooks including: connection status, aggregation, balance, history, and statements.Added
is_relevant field in beats, and feed_localized_memo in transactions.Added:
pulse_widget as an option with which the Accept-Language header can be used.DISCOVERED_ACCOUNTS and DISCOVERED_TRANSACTIONS were removed from the list of the resource types that may be included in manifest files for SFTP delivery.MDX v5: Updated the format across several data specs to conform to the latest standards. Added the
cash_advance_apr and statement_on fields.Added the longitude, latitude, merchant_guid, and merchant_location_guid fields to batch response files.Added: New mx/connect/oauthError postMessage(v4) event for the Connect Widget.
Added two new fields to the data spec for users:
email_is_verified and phone_is_verified.Added a new field to the transaction spec:
feed_description.Added documentation on the remap user ID, remap member ID, and remap account ID endpoints.
Added information on manifest files for SFTP delivery.
Added the
is_recurring and is_subscription fields for transactions.The
user_agent field was added to the response for analytics events, and the user_agent_string field was deprecated.Added a new field to the account spec:
is_internal.Added a userkey option as a supported response for create session and update session requests in MDX On Demand API.Corrected webhook example payloads to show
null where no value is available.Added information analytics pageviews, analytics timed events, beat feedback, and notification profiles to the Reporting API.Two fields were added to the transactions webhook:
merchant_guid and merchant_location_guid.Added information on new account subtypes.
Added information on new account subtypes.
New product; Batch API is live.
Added a new field to the user spec:
created_at.Add documentation on currency code for notification webhooks.
Add documentation for email/SMS verification tokens in webhook alerts.
Add
client_id and name to budget fields. Add feed_is_international, is_international, and is_international_set_by to transaction fields. Add created_by and correct metatype to meta_type in the goals fields.Added clarifying information in the create session and update session endpoint descriptions to describe available MFA workflows.
Add documentation for notification webhooks.
Add
client_id field to budgets and budget notifications payload.Initial publication of documentation for Webhooks V1.
Added a clarification to the versioning section that some fields containing enumerated values, for example
account_subtype, may have additional values added from time to time. Partners should be aware of this and plan for it.Added a clarification in the section on date formats explaining that dates provided in ISO 8601 format must be convertible to Unix epoch time.
Added a ‘Number Limits’ section to outline the precision and scale of decimal numbers. Updated the maximum length values in the field definitions with the correct precision,scale values.
Added the
is_international field to the transactions data model.Added a Limitations section which outlines the rate limit that MX applies to each partner’s API requests. Error code
429 Too Many Requests was added to the Errors section.