MX Technologies

Delete manual account. This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of `204 No Content`. via DELETE /users/{user_guid}/accounts/{account_guid}

Delete a budget. via DELETE /users/{user_guid}/budgets/{budget_guid}

Delete category. Use this endpoint to delete a specific custom category according to its unique GUID. The API will respond with an empty object and a status of `204 No Content`. via DELETE /users/{user_guid}/categories/{category_guid}

Delete a goal. via DELETE /users/{user_guid}/goals/{goal_guid}

Deprecated by MX. Delete managed member. Use this endpoint to delete the specified partner-managed `member`. The endpoint will respond with a status of `204 No Content` without a resource. <Warning> This endpoint has been deprecated. For more information, reference the Migration guide. </Warning> via DELETE /users/{user_guid}/managed_members/{member_guid}

Deprecated by MX. Delete managed account. Use this endpoint to delete a partner-managed account according to its unique GUID. If successful, the API will respond with a status of `204 No Content`. <Warning> This endpoint has been deprecated. For more information, reference the Migration guide. </Warning> via DELETE /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}

Deprecated by MX. Delete managed transaction. Use this endpoint to delete the specified partner-managed `transaction`. The endpoint will respond with a status of `204 No Content` without a resource. <Warning> This endpoint has been deprecated. For more information, reference the Migration guide. </Warning> via DELETE /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}

Delete a microdeposit. Use this endpoint to delete the specified microdeposit. via DELETE /users/{user_guid}/micro_deposits/{micro_deposit_guid}

Delete spending plan. Use this endpoint to delete a user's `spending_plan`. via DELETE /users/{user_guid}/spending_plans/{spending_plan_guid}

Delete spending plan iteration item. Use this endpoint to delete a spending plan `iteration_item`. via DELETE /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}

Delete spending plan account. Use this endpoint to delete a `spending_plan_account`. via DELETE /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}

Delete tagging. Use this endpoint to delete a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content. via DELETE /users/{user_guid}/taggings/{tagging_guid}

Delete tag. Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of `204 No Content`. via DELETE /users/{user_guid}/tags/{tag_guid}

Delete transaction rule. Use this endpoint to permanently delete a transaction rule based on its unique GUID. via DELETE /users/{user_guid}/transaction_rules/{transaction_rule_guid}

Delete manual transactions. Delete a manual transaction. In the path, use the manual transaction guid as the `transaction_guid`, such as `MAN-810828b0-5210-4878-9bd3-f4ce514f90c4`. via DELETE /users/{user_guid}/transactions/{transaction_guid}

Delete split transactions. This endpoint deletes all split transactions linked to a parent transaction, but it leaves the parent transaction active. This request will also update the parent transaction's has_been_split field to false. This endpoint accepts the optional MX-Skip-Webhook header. via DELETE /users/{user_guid}/transactions/{transaction_guid}/split

Delete user. Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. <Warning> Deleting a user is permanent. Deleted users can never be restored. For more info, see Deleting Objects. </Warning> via DELETE /users/{user_identifier}

Delete member. Accessing this endpoint will permanently delete a member. via DELETE /users/{user_identifier}/members/{member_identifier}

Delete split transactions by account. This endpoint deletes all split transactions linked to a parent transaction, but it leaves the parent transaction active. This request will also update the parent transaction's has_been_split field to false. This endpoint accepts the optional MX-Skip-Webhook header. via DELETE /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}/split

Request an account number (Processors Only). Get account information such as routing number and account number, scoped to your access token. Not callable with a client_id:api_key connection: this is a processor-token (Bearer) operation. via GET /account/account_numbers

Get account owner information (Processors Only) Not callable with a client_id:api_key connection: this is a processor-token (Bearer) operation. via GET /account/transactions

List ACH Returns. Use this endpoint to get all ACH returns. via GET /ach_returns

Read ACH Return. Use this endpoint to get an ACH return by its `guid` or `id`. via GET /ach_returns/{ach_return_guid}

Read a default category. Use this endpoint to read the attributes of a default category. via GET /categories/{category_guid}

List default categories. Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience. via GET /categories/default

Read a Credit Card Product. This endpoint returns the specified `credit_card_product` according to the unique GUID. via GET /credit_card_products/{credit_card_product_guid}

List institutions. Lists financial institutions available through the MX platform. This endpoint has been updated in `v20250224` to enhance search and filtering capabilities based on the products supported by each institution. via GET /institutions

Read institution. This endpoint returns information about the institution specified by `institution_code`. The `v20250224` update enhances the granularity of the information provided about the services and products supported by the institution. via GET /institutions/{institution_code}

List institution credentials. Use this endpoint to see which credentials will be needed to create a member for a specific institution. Passing an invalid `institution_identifier` returns a `404`. via GET /institutions/{institution_identifier}/credentials

List favorite institutions. This endpoint returns a paginated list containing institutions that have been set as favorites, sorted by popularity. Please contact MX to set a list of favorites. via GET /institutions/favorites

Deprecated by MX. List managed institutions. This endpoint returns a list of institutions which can be used to create partner-managed members. <Warning> This endpoint has been deprecated. For more information, reference the Migration guide </Warning> via GET /managed_institutions

Read merchant location. This endpoint returns the specified `merchant_location` resource. The `merchant_location_guid` can be found on `transaction` objects. via GET /merchant_locations/{merchant_location_guid}

List merchants. This endpoint returns a paginated list of all the merchants in the MX system. via GET /merchants

Read merchant. Returns information about a particular merchant, such as a logo, name, and website. via GET /merchants/{merchant_guid}

Read the account balance (Processors Only) Not callable with a client_id:api_key connection: this is a processor-token (Bearer) operation. via GET /payment_account

WITHHELD: refused without calling MX. View a List of Tokens. View a list of tokens that exist for a user, member, or account. No request shape for this operation has been measured to succeed (MX refuses the documented GET body and answers 500 to query-string forms), so it is not sent. via GET /tokens

List users. Use this endpoint to list every user you've created in the MX Platform API. via GET /users

List all verifications for a user. This endpoint returns a list of the account verifications associated with the user, as well as the status of those verifications. via GET /users/{user_guid}/account_verifications

Read account. This endpoint returns the specified `account` resource. via GET /users/{user_guid}/accounts/{account_guid}

List category totals by account. Returns a list of categories that have transactions dated within the provided date range, and the total of all transactions that belong to each category. via GET /users/{user_guid}/accounts/{account_guid}/date_range_category_totals

List insights by account. Use this endpoint to list all insights associated with an account GUID. via GET /users/{user_guid}/accounts/{account_guid}/insights

List holdings by account. This endpoint lists all holdings associated with the particular account defined. via GET /users/{user_guid}/accounts/{account_guid}/investment_holdings

List account balances by month. Use this endpoint to list all monthly account balances associated with an account GUID. Setting `from_date` returns account balances starting from the set month. Setting `to_date` returns account balances ending with the set month. via GET /users/{user_guid}/accounts/{account_guid}/monthly_account_balances

List transactions by account. Requests to this endpoint return a list of transactions associated with the specified account. <br /><br /> Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the Optional Enhancement Query Parameter guide. via GET /users/{user_guid}/accounts/{account_guid}/transactions

List all budgets via GET /users/{user_guid}/budgets

Read a specific budget. via GET /users/{user_guid}/budgets/{budget_guid}

List categories. Use this endpoint to list all categories associated with a `user`, including both default and custom categories. via GET /users/{user_guid}/categories

Read a custom category. Use this endpoint to read the attributes of either a default category or a custom category. via GET /users/{user_guid}/categories/{category_guid}

List default categories by user. Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience. via GET /users/{user_guid}/categories/default

List category totals by user. Returns a list of categories that have transactions dated within the provided date range, and the total of all transactions that belong to each category. via GET /users/{user_guid}/date_range_category_totals

List goals. List all goals a user can set. via GET /users/{user_guid}/goals

Read a goal. Read a specific goal. via GET /users/{user_guid}/goals/{goal_guid}

List all insights for a user. Use this endpoint to list all the insights associated with the user. via GET /users/{user_guid}/insights

Read insight. Use this endpoint to read the attributes of an insight according to its unique GUID. via GET /users/{user_guid}/insights/{insight_guid}

List all accounts associated with an insight. Use this endpoint to list all the accounts associated with the insight. via GET /users/{user_guid}/insights/{insight_guid}/accounts

List all categories associated with an insight. Use this endpoint to list all the categories associated with the insight. via GET /users/{user_guid}/insights/{insight_guid}/categories

List all merchants associated with an insight. Use this endpoint to list all the merchants associated with the insight. via GET /users/{user_guid}/insights/{insight_guid}/merchants

List all scheduled payments associated with an insight. Use this endpoint to list all the scheduled payments associated with the insight. via GET /users/{user_guid}/insights/{insight_guid}/scheduled_payments

List all transactions associated with an insight. Use this endpoint to list all the transactions associated with the insight. via GET /users/{user_guid}/insights/{insight_guid}/transactions

List holdings by user. This endpoint lists all holdings associated with the user across all accounts. via GET /users/{user_guid}/investment_holdings

Read holding. Use this endpoint to read the attributes of a specific `holding`. via GET /users/{user_guid}/investment_holdings/{holding_guid}

Deactivate user from Investment Holdings. This endpoint deactivates the specific user from the `/investment_holdings` product. To reactivate a user, use any of the current `/investment_holding` endpoints. via GET /users/{user_guid}/investment_holdings_deactivate

Deprecated by MX. List managed members. This endpoint returns a list of all the partner-managed members associated with the specified `user`. <Warning> This endpoint has been deprecated. For more information, reference the Migration guide. </Warning> via GET /users/{user_guid}/managed_members

Deprecated by MX. Read managed member. This endpoint returns the attributes of the specified partner-managed`member`. <Warning> This endpoint has been deprecated. For more information, reference the Migration guide. </Warning> via GET /users/{user_guid}/managed_members/{member_guid}

Deprecated by MX. List managed accounts. Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-managed member. <Warning> This endpoint has been deprecated. For more information, reference the Migration guide. </Warning> via GET /users/{user_guid}/managed_members/{member_guid}/accounts

Deprecated by MX. Read managed account. Use this endpoint to read the attributes of a partner-managed account according to its unique guid. <Warning> This endpoint has been deprecated. For more information, reference the Migration guide. </Warning> via GET /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}

Deprecated by MX. List managed transactions. This endpoint returns a list of all the partner-managed transactions associated with the specified `account`, scoped through a `user` and a `member`. <Warning> This endpoint has been deprecated. For more information, reference the Migration guide. </Warning> via GET /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions

Deprecated by MX. Read managed transaction. Requests to this endpoint will return the attributes of the specified partner-managed `transaction`. <Warning> This endpoint has been deprecated. For more information, reference the Migration guide. </Warning> via GET /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}

List account numbers by member. This endpoint returns a list of account numbers associated with the specified `member`. via GET /users/{user_guid}/members/{member_guid}/account_numbers

List holdings by member. This endpoint lists all holdings associated with the specified member. via GET /users/{user_guid}/members/{member_guid}/investment_holdings

List Rewards. Use this endpoint to list all the `rewards` associated with a specified `member`. Member guids are defined by MX. via GET /users/{user_guid}/members/{member_guid}/rewards

Read Reward. Use this endpoint to read a specific `reward` based on its unique GUID. Member and Rewards guids are defined by MX. via GET /users/{user_guid}/members/{member_guid}/rewards/{reward_guid}

List statements by member. Use this endpoint to get an array of available statements. via GET /users/{user_guid}/members/{member_guid}/statements

Read statement by member. Use this endpoint to read a JSON representation of the statement. via GET /users/{user_guid}/members/{member_guid}/statements/{statement_guid}

List all microdeposits for a user. Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. via GET /users/{user_guid}/micro_deposits

Read a microdeposit for a user. Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. <br></br> Webhooks for microdeposit status changes are triggered when a status changes. The actual status of the microdeposit guid updates every minute. You may force a status update by calling the read microdeposit endpoint. via GET /users/{user_guid}/micro_deposits/{micro_deposit_guid}

List notifications. All notifications for the user can be listed, including notifications created by MX for other channels besides `PUSH`. via GET /users/{user_guid}/notifications

Read notifications. Can pull up any notification associated with the user, including notifications created by MX for other channels besides `PUSH`. via GET /users/{user_guid}/notifications/{notification_guid}

List Repeating Transactions. Retrieve a list of all recurring transactions for a user. <br /><br />For more see the Repeating Transactions guide. via GET /users/{user_guid}/repeating_transactions

Get a Repeating Transaction. Get a Specific Repeating Transaction. via GET /users/{user_guid}/repeating_transactions/{repeating_transaction_guid}

List spending plans. Use this endpoint to list all the spending plans associated with the user. via GET /users/{user_guid}/spending_plans

Read a spending plan for a user. Use this endpoint to read the attributes of a specific spending plan according to its unique GUID. via GET /users/{user_guid}/spending_plans/{spending_plan_guid}

List spending plan iterations. Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`. via GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations

Read a spending plan iteration. Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`. via GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number}

Read current spending plan iteration. Use this endpoint to read the attributes of the current spending plan `iteration`. via GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current

List spending plan iteration items. Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`. via GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items

Read a spending plan iteration item. Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID. via GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}

List spending plan accounts. Use this endpoint to list all the spending plan accounts associated with the spending plan. via GET /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts

Read spending plan account. Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID. via GET /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}

List taggings. Use this endpoint to retrieve a list of all the taggings associated with a specific user. via GET /users/{user_guid}/taggings

Read tagging. Use this endpoint to read the attributes of a `tagging` according to its unique GUID. via GET /users/{user_guid}/taggings/{tagging_guid}

List tags. Use this endpoint to list all tags associated with the specified `user`. Each user includes the `Business` tag by default. via GET /users/{user_guid}/tags

Read tag. Use this endpoint to read the attributes of a particular tag according to its unique GUID. via GET /users/{user_guid}/tags/{tag_guid}

List transaction rules. Use this endpoint to read the attributes of all existing transaction rules belonging to the user. via GET /users/{user_guid}/transaction_rules

Read transaction rule. Use this endpoint to read the attributes of an existing transaction rule based on the rule’s unique GUID. via GET /users/{user_guid}/transaction_rules/{transaction_rule_guid}

Read transaction. Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. <br /><br /> Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the Optional Enhancement Query Parameter guide. via GET /users/{user_guid}/transactions/{transaction_guid}

List insights by transaction. Use this endpoint to list all insights associated with a transaction GUID. via GET /users/{user_guid}/transactions/{transaction_guid}/insights

Read user. Use this endpoint to read the attributes of a specific user. via GET /users/{user_identifier}

List accounts. This endpoint returns a list of all the accounts associated with the specified `user`. <Warning> This request will not return the full account number. It may return the last four digits of the account number if that information has been provided during aggregation. If you need the full account number, please refer to List account numbers by member or List account numbers by account. </Warning> via GET /users/{user_identifier}/accounts

List account numbers by account. This endpoint returns a list of account numbers associated with the specified `account`. via GET /users/{user_identifier}/accounts/{account_identifier}/account_numbers

Read job. Use this endpoint to read the attributes of a specific job. > **Warning:** New implementations shouldn't use this endpoint. It is maintained for compatibility with our Nexus API only. via GET /users/{user_identifier}/jobs/{job_guid}

List members. This endpoint returns an array which contains information on every member associated with a specific user. via GET /users/{user_identifier}/members

Read member. Use this endpoint to read the attributes of a specific member. via GET /users/{user_identifier}/members/{member_identifier}

List account owners by member. This endpoint returns an array with information about every account associated with a particular member. via GET /users/{user_identifier}/members/{member_identifier}/account_owners

List member accounts. This endpoint returns a list of all the accounts associated with the specified `member`. via GET /users/{user_identifier}/members/{member_identifier}/accounts

Read member account. This endpoint allows you to read the attributes of an `account` resource. via GET /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}

List transactions by account per member. Requests to this endpoint return a list of transactions associated with the specified account. <br /><br /> Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the Optional Enhancement Query Parameter guide. via GET /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions

Read transaction by account. Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. <br /><br /> Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the Optional Enhancement Query Parameter guide. via GET /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}

List member challenges. Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member. If the aggregation is not challenged, i.e., the member does not have a connection status of `CHALLENGED`, then code `204 No Content` will be returned. If the aggregation has been challenged, i.e., the member does have a connection status of `CHALLENGED`, then code `200 OK` will be returned - along with the corresponding credentials. via GET /users/{user_identifier}/members/{member_identifier}/challenges

List member credentials. This endpoint returns an array which contains information on every non-MFA credential associated with a specific member. via GET /users/{user_identifier}/members/{member_identifier}/credentials

Request oauth window uri. This endpoint will generate an `oauth_window_uri` for the specified `member`. via GET /users/{user_identifier}/members/{member_identifier}/oauth_window_uri

Read member status. This endpoint provides the status of the members most recent aggregation event. The results returned by this endpoint should determine what you do next in order to successfully aggregate a member. via GET /users/{user_identifier}/members/{member_identifier}/status

List transactions by member. Requests to this endpoint return a list of transactions associated with the specified `member`, across all accounts associated with that `member`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the Optional Enhancement Query Parameter guide. via GET /users/{user_identifier}/members/{member_identifier}/transactions

Read monthly cash flow profile. via GET /users/{user_identifier}/monthly_cash_flow_profile

List transactions by tag. Use this endpoint to get a list of all transactions associated with a particular tag according to the tag's unique GUID. This lists all transactions that have been assigned to a particular tag using the create tagging endpoint. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the Optional Enhancement Query Parameter guide. via GET /users/{user_identifier}/tags/{tag_guid}/transactions

List transactions. Requests to this endpoint return a list of transactions associated with the specified `user`, across all members and accounts associated with that `user`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the Optional Enhancement Query Parameter guide. via GET /users/{user_identifier}/transactions

Get Transactions Data. Get an MX-issued verifiable credential of a user's transaction data. via GET /vc/users/{user_guid}/accounts/{account_guid}/transactions

Get Accounts Data. Get an MX-issued verifiable credential of a user's accounts data. via GET /vc/users/{user_guid}/members/{member_guid}/accounts

Get Identity Data. Get an MX-issued verifiable credential of a user's identity data. via GET /vc/users/{user_guid}/members/{member_guid}/customers

Check Real Time Account Balance (Processors Only). Check the real-time account balance using your access token. Not callable with a client_id:api_key connection: this is a processor-token (Bearer) operation. via POST /account/check_balance

Create ACH Return. Use this endpoint to create an ACH return in our system. via POST /ach_returns

Request an authorization code. Clients use this endpoint to request an authorization code according to the parameters specified in the scope. Clients then pass this code to processors. Processor access is scoped only to the GUIDs and features specified in this request. Before requesting an authorization code which includes a member in the scope, clients must have verified that member. via POST /authorization_code

Enhance transactions. Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform. <br /><br />For more information on returned data, please see the Enhanced Transactions fields guide. via POST /transactions/enhance

Create user. Use this endpoint to create a new user. The API will respond with the newly-created user object if successful, containing a `guid` that you'll set as the `user_guid` in other requests when required. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user’s data until they are no longer disabled. via POST /users

Create manual transaction. This endpoint can only be used to create manual transactions that are under a manual account. This endpoint accepts the optional MX-Skip-Webhook header and `skip_webhook` parameter. via POST /users/{user_guid}/accounts/{account_guid}/transactions

Merge accounts. Merge two or more financial accounts that an end user has identified as duplicates. Provide at least two account GUIDs belonging to the same user. <Warning> The response will return a single consolidated account. Any other accounts you provided that were not included in the response will be deleted. This is a destructive action and can't be undone. </Warning> via POST /users/{user_guid}/accounts/merge

Create a budget. This endpoint accepts the optional `MX-Skip-Webhook` header and `skip_webhook` parameter. You cannot create a duplicate budget. For example, if you attempt to create a budget for "Gas", but that budget already exist, the request will fail. You can retrieve a list of all existing categories by using the List Categories endpoint. via POST /users/{user_guid}/budgets

Auto-generate budgets. This endpoint will automatically create budgets for several categories based on existing transactions; these budgets are returned as an array. Specifically, budgets will only be generated if the `user` has at least one `transaction` in a given category during each of the two previous calendar months. For example, if the request is made on March 6, and there is at least one "Bills & Utilities" `transaction` in both January and February, a budget will be generated for "Bills & Utilities." If there are two "Bills & Utilities" transactions in February but none in January, no budget will be generated for that category. If budgets already exist for particular categories, new budgets will be generated and returned based on the available transactions. If one or more budgets remain unchanged, they will nevertheless be returned in the response. If no transaction data for the `user` meet the above criteria, a `422 Unprocessable Entity` error will be returned with status code 4221 along with the message, `There aren't enough transactions to automatically create any budgets`. via POST /users/{user_guid}/budgets/generate

Create category. Use this endpoint to create a new custom category for a specific `user`. via POST /users/{user_guid}/categories

Create a goal. This endpoint accepts the optional `MX-Skip-Webhook` header and `skip_webhook` parameter. via POST /users/{user_guid}/goals

Deprecated by MX. Create managed member. Use this endpoint to create a new partner-managed `member`. <Warning> This endpoint has been deprecated. For more information, reference the Migration guide. </Warning> via POST /users/{user_guid}/managed_members

Deprecated by MX. Create managed account. Use this endpoint to create a partner-managed account. <Warning> This endpoint has been deprecated. For more information, reference the Migration guide. </Warning> via POST /users/{user_guid}/managed_members/{member_guid}/accounts

Deprecated by MX. Create managed transaction. Use this endpoint to create a new partner-managed `transaction`. <Warning> This endpoint has been deprecated. For more information, reference the Migration guide. </Warning> via POST /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions

Create or pre-initiate a microdeposit. Use this endpoint to create or pre-initiate a microdeposit. The response will include the new microdeposit record with a status of `INITIATED` or `PREINITIATED` respectively. To pre-initiate a microdeposit, you only need to set `email` (string), `first_name` (string), and `last_name` (string) in the request body. Pre-initiating a microdeposit allows you to pass the end user's first name, last name, and email if this data has already been collected. If the end user selects an institution which requires the microdeposit flow, the pre-initiated `micro_deposit` will be used and the Connect Widget step that normally requests this info from the end user will be skipped. However, if the end user selects an institution which supports IAV, the pre-initiated `micro_deposit` will be deleted and IAV will be used instead. When requesting a Connect Widget URL after pre-initiating, make sure to set the `current_microdeposit_guid` to the resulting microdeposit's `guid` and set `data_request.products` to include `account_verification`. If you use this enhanced flow, a `micro_deposit` should be pre-initiated for all connect sessions in verification mode. After pre-initiating a microdeposit, pass the GUID to the config as `current_microdeposit_guid` and set `data_request.products` to include `account_verification` when requesting a Connect URL. Pre-initiating a microdeposit is optional. If you choose to implement this flow, it should be used for all Connect Widget sessions in verification mode. via POST /users/{user_guid}/micro_deposits

Create a notification. All notifications created through the API will be of notification type `API_NOTIFICATION`, channel `PUSH`, and will not be associated to an entity. No other channels are supported. This will only have an effect for clients using an MX mobile application. via POST /users/{user_guid}/notifications

Create spending plan. This endpoint creates a new `spending_plan` for the user. via POST /users/{user_guid}/spending_plans

Create spending plan iteration item. This endpoint creates a new `spending_plan_iteration_item`. via POST /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items

Create tagging. Use this endpoint to create a new association between a tag and a particular transaction, according to their unique GUIDs. via POST /users/{user_guid}/taggings

Create tag. Use this endpoint to create a new custom tag. via POST /users/{user_guid}/tags

Create transaction rule. Use this endpoint to create a new transaction rule. The newly-created `transaction_rule` object will be returned if successful. For more information about transaction rules, see the Transaction Rules Guide. via POST /users/{user_guid}/transaction_rules

Create split transactions. This endpoint creates two or more child transactions that are branched from a previous transaction. This endpoint allows you to link multiple categories, descriptions, and amounts to a parent transaction. When a split transaction is created, the parent transaction's `has_been_split` field will automatically be updated to true and the child transactions' `parent_guid` will have the transaction guid of the parent. The total amount of the child transactions must equal the amount of the parent transaction. Once a transaction has been split it can't be split again. In order to re-split a transaction, it must first be un-split. This can be done by calling the Delete Split Transactions endpoint. Calling this endpoint will delete the existing child transactions and update the parent transaction's `has_been_split` field to false. You can then re-split the parent transaction by calling Create Split Transaction again. via POST /users/{user_guid}/transactions/{transaction_guid}/split

Create manual account. This endpoint can only be used to create manual accounts. Creating a manual account will automatically create it under the Manual Institution member. Since a manual account has no credentials tied to the member, the account will never aggregate or include data from a data feed. <Warning> You must use the user `guid` when setting `user_identifier` in the path. </Warning> via POST /users/{user_identifier}/accounts

Create member. This endpoint allows you to create a new member using the required parameters `institution_code`, `credentials` (if creating a non-OAuth member), and `data_request.products`. When creating a non-OAuth member, include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the `/institutions/{institution_code}/credentials` endpoint. Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data. A status of 200 indicates the member was created successfully, and no aggregation was requested. A status of 201 indicates the member was created, but a product within `data_request` failed to aggregate. A status of 202 indicates the member was successfully created, and standard aggregation (no `data_request`) was requested (does not indicate success or failure). via POST /users/{user_identifier}/members

Aggregate all members. This endpoint will kick off a new aggregation job for each member which belongs to the user. If you've set the `use_cases` field when creating the member, then the member's use case must be set to `PFM`, otherwise a 403 will return. The response will include important information about the members' aggregations including the `is_being_aggregated` and `connection_status` fields. Aggregations can take some time to finish; you can use the the read member or list members endpoints to track the status and completion of each individual aggregation as it progresses. via POST /users/{user_identifier}/members/aggregate_all

Create split transactions by account. This endpoint creates two or more child transactions that are branched from a previous transaction. This endpoint allows you to link multiple categories, descriptions, and amounts to a parent transaction. When a split transaction is created, the parent transaction's `has_been_split` field will automatically be updated to true and the child transactions' `parent_guid` will have the transaction guid of the parent. The total amount of the child transactions must equal the amount of the parent transaction. Once a transaction has been split it can't be split again. In order to re-split a transaction, it must first be un-split. This can be done by calling the Delete Split Transactions endpoint. Calling this endpoint will delete the existing child transactions and update the parent transaction's `has_been_split` field to false. You can then re-split the parent transaction by calling Create Split Transaction again. via POST /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}/split

Aggregate member. Calling this endpoint initiates an aggregation event for the member. This brings in the latest account and transaction data from the connected institution. If this data has recently been updated, MX may not initiate an aggregation event. via POST /users/{user_identifier}/members/{member_identifier}/aggregate

Check balances. This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data. via POST /users/{user_identifier}/members/{member_identifier}/check_balance

Extend history. Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication. via POST /users/{user_identifier}/members/{member_identifier}/extend_history

Fetch Rewards. Calling this endpoint initiates an aggregation-type event which will gather the member's rewards information, as well as account and transaction information. Rewards data is also gathered with daily background aggregations. Member and Rewards guids are defined by MX. via POST /users/{user_identifier}/members/{member_identifier}/fetch_rewards

Fetch statements. Use this endpoint to fetch the statements associated with a particular member. via POST /users/{user_identifier}/members/{member_identifier}/fetch_statements

Identify member. The identify endpoint begins an identification process for an already-existing member. via POST /users/{user_identifier}/members/{member_identifier}/identify

Verify member. The verify endpoint begins a verification process for a member. via POST /users/{user_identifier}/members/{member_identifier}/verify

Request widget URL. Get an embeddable URL for integrating a widget into your website or app. The URL expires after ten minutes or upon first use, whichever occurs first. You'll need to obtain a new URL each time the page loads or reloads. Include the `widget_type` in the request body to specify which widget you want to embed—the Connect Widget, a Personal Financial Management widget, or an Insights widget. Some request parameters are specific to certain widget types. To embed the Connect Widget, set `widget_type` to `connect_widget`. For a full list of available widget types, see Widget Types. via POST /users/{user_identifier}/widget_urls

Verify a Microdeposit. Use this endpoint to verify the amounts deposited into the account during a microdeposit verification. The verification has not successfully completed until the `status` is `VERIFIED`. Poll the `/users/{user_guid}/micro_deposits/{micro_deposit_guid}` (read microdeposit) endpoint until you see this status or an error state. via PUT /users/{user_guid}/micro_deposits/{micro_deposit_guid}/verify

Block an account. This endpoint is used to delete existing data and block new data from being stored on the specified account. This may be necessary to comply with certain rules, regulations, or standards. This endpoint also: - Immediately and permanently deletes most data from the account object. Certain information is retained that is necessary for MX to prevent the account from being re-added. - Prevents MX from creating or storing any additional data associated with the account, for example transactions, holdings, statements, and so on. - Immediately and permanently deletes all data associated with the account, for example transactions, holdings, statements, etc. This action is scoped to the member the account belongs to. This means that if the real world account is connected or reconnected via another member, the block will have no effect on that account. This action cannot be taken on accounts where `is_manual` is `true`. Objects deleted as a result of blocking an account will issue a webhook for that object with the action set to deleted. For example, account deleted, transaction deleted, and so on. There is no special webhook or action for blocking. via PUT /users/{user_guid}/accounts/{account_guid}/block

Update a specific budget. via PUT /users/{user_guid}/budgets/{budget_guid}

Update category. Use this endpoint to update the attributes of a custom category according to its unique GUID. via PUT /users/{user_guid}/categories/{category_guid}

Update a goal. This endpoint updates a specific goal. via PUT /users/{user_guid}/goals/{goal_guid}

Reposition goals. This endpoint repositions goal priority levels. If one goal is set to a lower priority, then any other goals need to be adjusted accordingly. via PUT /users/{user_guid}/goals/reposition

Update insight. Use this endpoint to update the attributes of an insight according to its unique GUID. via PUT /users/{user_guid}/insights/{insight_guid}

Deprecated by MX. Update managed member. Use this endpoint to update the attributes of the specified partner_managed `member`. <Warning> This endpoint has been deprecated. For more information, reference the Migration guide. </Warning> via PUT /users/{user_guid}/managed_members/{member_guid}

Deprecated by MX. Update managed account. Use this endpoint to update the attributes of a partner-managed account according to its unique GUID. <Warning> This endpoint has been deprecated. For more information, reference the Migration guide. </Warning> via PUT /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}

Deprecated by MX. Update managed transaction. Use this endpoint to update the attributes of the specified partner_managed `transaction`. <Warning> This endpoint has been deprecated. For more information, reference the Migration guide. </Warning> via PUT /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}

Update a spending plan iteration item. Use this endpoint to update an existing `spending_plan_iteration_item`. via PUT /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}

Update tagging. Use this endpoint to update a tagging. via PUT /users/{user_guid}/taggings/{tagging_guid}

Update tag. Use this endpoint to update the name of a specific tag according to its unique GUID. via PUT /users/{user_guid}/tags/{tag_guid}

Update transaction rule. Use this endpoint to update the attributes of a specific transaction rule based on its unique GUID. The API will respond with the updated transaction_rule object. Any attributes not provided will be left unchanged. For more information about transaction rules, see the Transaction Rules Guide. via PUT /users/{user_guid}/transaction_rules/{transaction_rule_guid}

Update transaction. Use this endpoint to update the `description` of a specific transaction according to its unique GUID. via PUT /users/{user_guid}/transactions/{transaction_guid}

Update user. Use this endpoint to update the attributes of the specified user. via PUT /users/{user_identifier}

Update member. Use this endpoint to update a members attributes. Only the credentials, id, and metadata parameters can be updated. To get a list of the required credentials for the member, use the list member credentials endpoint. via PUT /users/{user_identifier}/members/{member_identifier}

Update account by member. This endpoint allows you to update certain attributes of an `account` resource, including manual accounts. For manual accounts, you can update every field listed. For aggregated accounts, you can only update `is_business`, `is_hidden` and `metadata`. via PUT /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}

Update transaction by account. Use this endpoint to update the `description` of a specific transaction according to its unique GUID. via PUT /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}

Resume aggregation. This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication. via PUT /users/{user_identifier}/members/{member_identifier}/resume

Update monthly cash flow profile. Use this endpoint to update the attributes of a `monthly_cash_flow_profile`. via PUT /users/{user_identifier}/monthly_cash_flow_profile