# MX Documentation: API Reference Platform API v20111101 > Developer documentation for the MX platform. Covers connecting users to their financial institutions and retrieving enhanced account, transaction, and verification data with the Platform API and Connect Widget; Financial Insights, Personal Finance Management (PFM), and mobile banking experiences; and data products including Data Access, Customer Analytics, and Audiences. ## v20111101 ### #### Widgets - [(Deprecated) Request connect widget URL](https://docs.mx.com/api-reference/platform-api/v20111101/reference/widgets/deprecated-request-connect-widget-url.md): This endpoint will return a URL for an embeddable version of MX Connect. - [Create OAuth Authorization URL](https://docs.mx.com/api-reference/platform-api/v20111101/reference/widgets/create-oauth-authorization-url.md): Generate an `authorization_url` for OAuth authorization of the specified `member` during the connection flow. - [Request oauth window uri](https://docs.mx.com/api-reference/platform-api/v20111101/reference/widgets/request-oauth-window-uri.md): This endpoint will generate an `oauth_window_uri` for the specified `member`. - [Request widget URL](https://docs.mx.com/api-reference/platform-api/v20111101/reference/widgets/request-widget-url.md): 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. #### Users - [List users](https://docs.mx.com/api-reference/platform-api/v20111101/reference/users/list-users.md): Use this endpoint to list every user you've created in the MX Platform API. - [Create user](https://docs.mx.com/api-reference/platform-api/v20111101/reference/users/create-user.md): 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 b… - [Delete user](https://docs.mx.com/api-reference/platform-api/v20111101/reference/users/delete-user.md): Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. - [Read user](https://docs.mx.com/api-reference/platform-api/v20111101/reference/users/read-user.md): Use this endpoint to read the attributes of a specific user. - [Update user](https://docs.mx.com/api-reference/platform-api/v20111101/reference/users/update-user.md): Use this endpoint to update the attributes of the specified user. #### Members - [List members](https://docs.mx.com/api-reference/platform-api/v20111101/reference/members/list-members.md): This endpoint returns an array which contains information on every member associated with a specific user. - [Create member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/members/create-member.md): This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters id and metadata. When creating a member, youll need to include the correct type of credential required by the financial institution and prov… - [Delete member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/members/delete-member.md): Accessing this endpoint will permanently delete a member. - [Read member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/members/read-member.md): Use this endpoint to read the attributes of a specific member. - [Update member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/members/update-member.md): 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. - [Aggregate Transactions](https://docs.mx.com/api-reference/platform-api/v20111101/reference/members/aggregate-transactions.md): 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. - [Aggregate member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/members/aggregate-member.md): 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. - [List member challenges](https://docs.mx.com/api-reference/platform-api/v20111101/reference/members/list-member-challenges.md): 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 aggregati… - [Aggregate Account Balances](https://docs.mx.com/api-reference/platform-api/v20111101/reference/members/aggregate-account-balances.md): This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data. - [Check balances](https://docs.mx.com/api-reference/platform-api/v20111101/reference/members/check-balances.md): This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data. - [List member credentials](https://docs.mx.com/api-reference/platform-api/v20111101/reference/members/list-member-credentials.md): This endpoint returns an array which contains information on every non-MFA credential associated with a specific member. - [Identity Verification](https://docs.mx.com/api-reference/platform-api/v20111101/reference/members/identity-verification.md): The identify endpoint begins an identification process for an already-existing member. - [Identify member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/members/identify-member.md): The identify endpoint begins an identification process for an already-existing member. - [Resume aggregation](https://docs.mx.com/api-reference/platform-api/v20111101/reference/members/resume-aggregation.md): This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication. - [Read member status](https://docs.mx.com/api-reference/platform-api/v20111101/reference/members/read-member-status.md): This endpoint provides the status of the members most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member. MX has introduced new, more detailed informat… - [Account Verification](https://docs.mx.com/api-reference/platform-api/v20111101/reference/members/account-verification.md): The verify endpoint begins a verification process for a member. - [Verify member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/members/verify-member.md): The verify endpoint begins a verification process for a member. #### Institutions - [List institutions](https://docs.mx.com/api-reference/platform-api/v20111101/reference/institutions/list-institutions.md): This endpoint returns a list of institutions based on the specified search term or parameter. - [List favorite institutions](https://docs.mx.com/api-reference/platform-api/v20111101/reference/institutions/list-favorite-institutions.md): This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity. Please contact MX to set a list of favorites. - [Read institution](https://docs.mx.com/api-reference/platform-api/v20111101/reference/institutions/read-institution.md): This endpoint returns information about the institution specified by `institution_code`. - [List institution credentials](https://docs.mx.com/api-reference/platform-api/v20111101/reference/institutions/list-institution-credentials.md): Use this endpoint to see which credentials will be needed to create a member for a specific institution. #### Accounts - [List accounts](https://docs.mx.com/api-reference/platform-api/v20111101/reference/accounts/list-accounts.md): This endpoint returns a list of all the accounts associated with the specified `user`. - [Create manual account](https://docs.mx.com/api-reference/platform-api/v20111101/reference/accounts/create-manual-account.md): 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.. - [Read account](https://docs.mx.com/api-reference/platform-api/v20111101/reference/accounts/read-account.md): This endpoint returns the specified `account` resource. - [Delete manual account](https://docs.mx.com/api-reference/platform-api/v20111101/reference/accounts/delete-manual-account.md): This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of `204 No Content`. - [List account numbers by account](https://docs.mx.com/api-reference/platform-api/v20111101/reference/accounts/list-account-numbers-by-account.md): This endpoint returns a list of account numbers associated with the specified `account`. - [List account numbers by member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/accounts/list-account-numbers-by-member.md): This endpoint returns a list of account numbers associated with the specified `member`. - [List account owners by member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/accounts/list-account-owners-by-member.md): This endpoint returns an array with information about every account associated with a particular member. - [List accounts by member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/accounts/list-accounts-by-member.md): This endpoint returns a list of all the accounts associated with the specified `member`. - [Read account by member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/accounts/read-account-by-member.md): This endpoint allows you to read the attributes of an `account` resource. - [Update account by member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/accounts/update-account-by-member.md): 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`. #### Transactions - [Enhance transactions](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transactions/enhance-transactions.md): Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform.

For more information on returned data, please see the [Enhanced Transactions fields guide](/api-reference/platform-api/v20111101/reference/transactions#… - [Create manual transaction](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transactions/create-manual-transaction.md): 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. - [List transactions by account](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transactions/list-transactions-by-account.md): Requests to this endpoint return a list of transactions associated with the specified account.

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_transacti… - [Update Transaction by Account](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transactions/update-transaction-by-account.md): Use this endpoint to update a specific transaction according to its unique GUID. - [Aggregate Transaction History](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transactions/aggregate-transaction-history.md): 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… - [Extend history](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transactions/extend-history.md): 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… - [List transactions by member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transactions/list-transactions-by-member.md): Requests to this endpoint return a list of transactions associated with the specified `member`, across all accounts associated with that `member`.

Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optio… - [List Repeating Transactions](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transactions/list-repeating-transactions.md): Retrieve a list of all recurring transactions for a user.

For more information, see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions#repeating-transactions). - [Get a Repeating Transaction](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transactions/get-a-repeating-transaction.md): Get a Specific Repeating Transaction.

For more information, see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions#repeating-transactions). - [List transactions by tag](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transactions/list-transactions-by-tag.md): 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.

Enhanced transaction data may be requested using the `includ… - [List transactions](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transactions/list-transactions.md): Requests to this endpoint return a list of transactions associated with the specified `user`, across all members and accounts associated with that `user`.

Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include t… - [Read transaction](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transactions/read-transaction.md): 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`.

Enhanced transaction data may be requested using the `includes` parameter. To use this optional parame… - [Update transaction](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transactions/update-transaction.md): Use this endpoint to update a specific transaction according to its unique GUID. - [Delete manual transactions](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transactions/delete-manual-transactions.md): Delete a manual transaction. In the path, use the manual transaction guid as the `transaction_guid`, such as `MAN-810828b0-5210-4878-9bd3-f4ce514f90c4`. - [Delete split transactions](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transactions/delete-split-transactions.md): 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. - [Create split transactions](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transactions/create-split-transactions.md): 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 autom… #### Microdeposits - [Verify a Microdeposit](https://docs.mx.com/api-reference/platform-api/v20111101/reference/microdeposits/verify-a-microdeposit.md): 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 s… - [List all verifications for a user](https://docs.mx.com/api-reference/platform-api/v20111101/reference/microdeposits/list-all-verifications-for-a-user.md): This endpoint returns a list of the account verifications associated with the user, as well as the status of those verifications. - [List all microdeposits for a user](https://docs.mx.com/api-reference/platform-api/v20111101/reference/microdeposits/list-all-microdeposits-for-a-user.md): Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. - [Create or pre-initiate a microdeposit](https://docs.mx.com/api-reference/platform-api/v20111101/reference/microdeposits/create-or-pre-initiate-a-microdeposit.md): 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. - [Delete a microdeposit](https://docs.mx.com/api-reference/platform-api/v20111101/reference/microdeposits/delete-a-microdeposit.md): Use this endpoint to delete the specified microdeposit. - [Read a microdeposit for a user](https://docs.mx.com/api-reference/platform-api/v20111101/reference/microdeposits/read-a-microdeposit-for-a-user.md): Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID.

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… #### Managed Data [Sunset] - [List managed institutions](https://docs.mx.com/api-reference/platform-api/v20111101/reference/managed-data/list-managed-institutions.md): **Sunset.** This endpoint was sunset on 2026-09-29 and no longer returns data — it responds with `410 Gone` on all API versions. There is no direct replacement; to send data held at your institution to MX, use [MDX Real Time](/products/connectivity/overview/held-data/mdx-real-time). See [Deprecation… - [List managed members](https://docs.mx.com/api-reference/platform-api/v20111101/reference/managed-data/list-managed-members.md): **Sunset.** This endpoint was sunset on 2026-09-29 and no longer returns data — it responds with `410 Gone` on all API versions. There is no direct replacement; to send data held at your institution to MX, use [MDX Real Time](/products/connectivity/overview/held-data/mdx-real-time). See [Deprecation… - [Create managed member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/managed-data/create-managed-member.md): **Sunset.** This endpoint was sunset on 2026-09-29 and no longer returns data — it responds with `410 Gone` on all API versions. There is no direct replacement; to send data held at your institution to MX, use [MDX Real Time](/products/connectivity/overview/held-data/mdx-real-time). See [Deprecation… - [Delete managed member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/managed-data/delete-managed-member.md): **Sunset.** This endpoint was sunset on 2026-09-29 and no longer returns data — it responds with `410 Gone` on all API versions. There is no direct replacement; to send data held at your institution to MX, use [MDX Real Time](/products/connectivity/overview/held-data/mdx-real-time). See [Deprecation… - [Read managed member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/managed-data/read-managed-member.md): **Sunset.** This endpoint was sunset on 2026-09-29 and no longer returns data — it responds with `410 Gone` on all API versions. There is no direct replacement; to send data held at your institution to MX, use [MDX Real Time](/products/connectivity/overview/held-data/mdx-real-time). See [Deprecation… - [Update managed member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/managed-data/update-managed-member.md): **Sunset.** This endpoint was sunset on 2026-09-29 and no longer returns data — it responds with `410 Gone` on all API versions. There is no direct replacement; to send data held at your institution to MX, use [MDX Real Time](/products/connectivity/overview/held-data/mdx-real-time). See [Deprecation… - [List managed accounts](https://docs.mx.com/api-reference/platform-api/v20111101/reference/managed-data/list-managed-accounts.md): **Sunset.** This endpoint was sunset on 2026-09-29 and no longer returns data — it responds with `410 Gone` on all API versions. There is no direct replacement; to send data held at your institution to MX, use [MDX Real Time](/products/connectivity/overview/held-data/mdx-real-time). See [Deprecation… - [Create managed account](https://docs.mx.com/api-reference/platform-api/v20111101/reference/managed-data/create-managed-account.md): **Sunset.** This endpoint was sunset on 2026-09-29 and no longer returns data — it responds with `410 Gone` on all API versions. There is no direct replacement; to send data held at your institution to MX, use [MDX Real Time](/products/connectivity/overview/held-data/mdx-real-time). See [Deprecation… - [Delete managed account](https://docs.mx.com/api-reference/platform-api/v20111101/reference/managed-data/delete-managed-account.md): **Sunset.** This endpoint was sunset on 2026-09-29 and no longer returns data — it responds with `410 Gone` on all API versions. There is no direct replacement; to send data held at your institution to MX, use [MDX Real Time](/products/connectivity/overview/held-data/mdx-real-time). See [Deprecation… - [Read managed account](https://docs.mx.com/api-reference/platform-api/v20111101/reference/managed-data/read-managed-account.md): **Sunset.** This endpoint was sunset on 2026-09-29 and no longer returns data — it responds with `410 Gone` on all API versions. There is no direct replacement; to send data held at your institution to MX, use [MDX Real Time](/products/connectivity/overview/held-data/mdx-real-time). See [Deprecation… - [Update managed account](https://docs.mx.com/api-reference/platform-api/v20111101/reference/managed-data/update-managed-account.md): **Sunset.** This endpoint was sunset on 2026-09-29 and no longer returns data — it responds with `410 Gone` on all API versions. There is no direct replacement; to send data held at your institution to MX, use [MDX Real Time](/products/connectivity/overview/held-data/mdx-real-time). See [Deprecation… - [List managed transactions](https://docs.mx.com/api-reference/platform-api/v20111101/reference/managed-data/list-managed-transactions.md): **Sunset.** This endpoint was sunset on 2026-09-29 and no longer returns data — it responds with `410 Gone` on all API versions. There is no direct replacement; to send data held at your institution to MX, use [MDX Real Time](/products/connectivity/overview/held-data/mdx-real-time). See [Deprecation… - [Create managed transaction](https://docs.mx.com/api-reference/platform-api/v20111101/reference/managed-data/create-managed-transaction.md): **Sunset.** This endpoint was sunset on 2026-09-29 and no longer returns data — it responds with `410 Gone` on all API versions. There is no direct replacement; to send data held at your institution to MX, use [MDX Real Time](/products/connectivity/overview/held-data/mdx-real-time). See [Deprecation… - [Delete managed transaction](https://docs.mx.com/api-reference/platform-api/v20111101/reference/managed-data/delete-managed-transaction.md): **Sunset.** This endpoint was sunset on 2026-09-29 and no longer returns data — it responds with `410 Gone` on all API versions. There is no direct replacement; to send data held at your institution to MX, use [MDX Real Time](/products/connectivity/overview/held-data/mdx-real-time). See [Deprecation… - [Read managed transaction](https://docs.mx.com/api-reference/platform-api/v20111101/reference/managed-data/read-managed-transaction.md): **Sunset.** This endpoint was sunset on 2026-09-29 and no longer returns data — it responds with `410 Gone` on all API versions. There is no direct replacement; to send data held at your institution to MX, use [MDX Real Time](/products/connectivity/overview/held-data/mdx-real-time). See [Deprecation… - [Update managed transaction](https://docs.mx.com/api-reference/platform-api/v20111101/reference/managed-data/update-managed-transaction.md): **Sunset.** This endpoint was sunset on 2026-09-29 and no longer returns data — it responds with `410 Gone` on all API versions. There is no direct replacement; to send data held at your institution to MX, use [MDX Real Time](/products/connectivity/overview/held-data/mdx-real-time). See [Deprecation… #### Transaction Rules - [List transaction rules](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transaction-rules/list-transaction-rules.md): Use this endpoint to read the attributes of all existing transaction rules belonging to the user. - [Create transaction rule](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transaction-rules/create-transaction-rule.md): Use this endpoint to create a new transaction rule. The newly-created `transaction_rule` object will be returned if successful. - [Read transaction rule](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transaction-rules/read-transaction-rule.md): Use this endpoint to read the attributes of an existing transaction rule based on the rule’s unique GUID. - [Update transaction rule](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transaction-rules/update-transaction-rule.md): 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. - [Delete transaction rule](https://docs.mx.com/api-reference/platform-api/v20111101/reference/transaction-rules/delete-transaction-rule.md): Use this endpoint to permanently delete a transaction rule based on its unique GUID. #### Statements - [Aggregate Statements](https://docs.mx.com/api-reference/platform-api/v20111101/reference/statements/aggregate-statements.md): Use this endpoint to fetch the statements associated with a particular member. - [Fetch statements](https://docs.mx.com/api-reference/platform-api/v20111101/reference/statements/fetch-statements.md): Use this endpoint to fetch the statements associated with a particular member. - [List statements by member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/statements/list-statements-by-member.md): Use this endpoint to get an array of available statements. - [Read statement by member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/statements/read-statement-by-member.md): Use this endpoint to read a JSON representation of the statement. - [Download statement pdf](https://docs.mx.com/api-reference/platform-api/v20111101/reference/statements/download-statement-pdf.md): Use this endpoint to download a specified statement PDF. #### Merchants - [Read merchant location](https://docs.mx.com/api-reference/platform-api/v20111101/reference/merchants/read-merchant-location.md): This endpoint returns the specified `merchant_location` resource. The `merchant_location_guid` can be found on `transaction` objects. - [List merchants](https://docs.mx.com/api-reference/platform-api/v20111101/reference/merchants/list-merchants.md): This endpoint returns a paginated list of all the merchants in the MX system. - [Read merchant](https://docs.mx.com/api-reference/platform-api/v20111101/reference/merchants/read-merchant.md): Returns information about a particular merchant, such as a logo, name, and website. #### Categories - [List default categories](https://docs.mx.com/api-reference/platform-api/v20111101/reference/categories/list-default-categories.md): 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… - [Read a default category](https://docs.mx.com/api-reference/platform-api/v20111101/reference/categories/read-a-default-category.md): Use this endpoint to read the attributes of a default category. - [List categories](https://docs.mx.com/api-reference/platform-api/v20111101/reference/categories/list-categories.md): Use this endpoint to list all categories associated with a `user`, including both default and custom categories. - [Create category](https://docs.mx.com/api-reference/platform-api/v20111101/reference/categories/create-category.md): Use this endpoint to create a new custom category for a specific `user`. - [List default categories by user](https://docs.mx.com/api-reference/platform-api/v20111101/reference/categories/list-default-categories-by-user.md): 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… - [Delete category](https://docs.mx.com/api-reference/platform-api/v20111101/reference/categories/delete-category.md): 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`. - [Read a custom category](https://docs.mx.com/api-reference/platform-api/v20111101/reference/categories/read-a-custom-category.md): Use this endpoint to read the attributes of either a default category or a custom category. - [Update category](https://docs.mx.com/api-reference/platform-api/v20111101/reference/categories/update-category.md): Use this endpoint to update the attributes of a custom category according to its unique GUID. #### Insights - [List insights by account](https://docs.mx.com/api-reference/platform-api/v20111101/reference/insights/list-insights-by-account.md): Use this endpoint to list all insights associated with an account GUID. - [List all insights for a user](https://docs.mx.com/api-reference/platform-api/v20111101/reference/insights/list-all-insights-for-a-user.md): Use this endpoint to list all the insights associated with the user. - [Read insight](https://docs.mx.com/api-reference/platform-api/v20111101/reference/insights/read-insight.md): Use this endpoint to read the attributes of an insight according to its unique GUID. - [Update insight](https://docs.mx.com/api-reference/platform-api/v20111101/reference/insights/update-insight.md): Use this endpoint to update the attributes of an insight according to its unique GUID. - [List all accounts associated with an insight](https://docs.mx.com/api-reference/platform-api/v20111101/reference/insights/list-all-accounts-associated-with-an-insight.md): Use this endpoint to list all the accounts associated with the insight. - [List all categories associated with an insight](https://docs.mx.com/api-reference/platform-api/v20111101/reference/insights/list-all-categories-associated-with-an-insight.md): Use this endpoint to list all the categories associated with the insight. - [List all merchants associated with an insight](https://docs.mx.com/api-reference/platform-api/v20111101/reference/insights/list-all-merchants-associated-with-an-insight.md): Use this endpoint to list all the merchants associated with the insight. - [List all scheduled payments associated with an insight](https://docs.mx.com/api-reference/platform-api/v20111101/reference/insights/list-all-scheduled-payments-associated-with-an-insight.md): Use this endpoint to list all the scheduled payments associated with the insight. - [List all transactions associated with an insight](https://docs.mx.com/api-reference/platform-api/v20111101/reference/insights/list-all-transactions-associated-with-an-insight.md): Use this endpoint to list all the transactions associated with the insight. - [List insights by transaction](https://docs.mx.com/api-reference/platform-api/v20111101/reference/insights/list-insights-by-transaction.md): Use this endpoint to list all insights associated with a transaction GUID. #### Investment Holdings - [List holdings by account](https://docs.mx.com/api-reference/platform-api/v20111101/reference/investment-holdings/list-holdings-by-account.md): This endpoint lists all holdings associated with the particular account defined. - [List holdings by user](https://docs.mx.com/api-reference/platform-api/v20111101/reference/investment-holdings/list-holdings-by-user.md): This endpoint lists all holdings associated with the user across all accounts. - [Read holding](https://docs.mx.com/api-reference/platform-api/v20111101/reference/investment-holdings/read-holding.md): Use this endpoint to read the attributes of a specific `holding`. - [Deactivate user from Investment Holdings](https://docs.mx.com/api-reference/platform-api/v20111101/reference/investment-holdings/deactivate-user-from-investment-holdings.md): This endpoint deactivates the specific user from the `/investment_holdings` product. To reactivate a user, use any of the current `/investment_holding` endpoints. - [List holdings by member](https://docs.mx.com/api-reference/platform-api/v20111101/reference/investment-holdings/list-holdings-by-member.md): This endpoint lists all holdings associated with the specified member. #### Spending Plans - [Create spending plan](https://docs.mx.com/api-reference/platform-api/v20111101/reference/spending-plan/create-spending-plan.md): This endpoint creates a new `spending_plan` for the user. - [List spending plans](https://docs.mx.com/api-reference/platform-api/v20111101/reference/spending-plan/list-spending-plans.md): Use this endpoint to list all the spending plans associated with the user. - [Delete spending plan](https://docs.mx.com/api-reference/platform-api/v20111101/reference/spending-plan/delete-spending-plan.md): Use this endpoint to delete a user's `spending_plan`. - [Read a spending plan for a user](https://docs.mx.com/api-reference/platform-api/v20111101/reference/spending-plan/read-a-spending-plan-for-a-user.md): Use this endpoint to read the attributes of a specific spending plan according to its unique GUID. - [List spending plan iterations](https://docs.mx.com/api-reference/platform-api/v20111101/reference/spending-plan/list-spending-plan-iterations.md): Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`. - [Read current spending plan iteration](https://docs.mx.com/api-reference/platform-api/v20111101/reference/spending-plan/read-current-spending-plan-iteration.md): Use this endpoint to read the attributes of the current spending plan `iteration`. - [Create spending plan iteration item](https://docs.mx.com/api-reference/platform-api/v20111101/reference/spending-plan/create-spending-plan-iteration-item.md): This endpoint creates a new `spending_plan_iteration_item`. - [List spending plan iteration items](https://docs.mx.com/api-reference/platform-api/v20111101/reference/spending-plan/list-spending-plan-iteration-items.md): Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`. - [Delete spending plan iteration item](https://docs.mx.com/api-reference/platform-api/v20111101/reference/spending-plan/delete-spending-plan-iteration-item.md): Use this endpoint to delete a spending plan `iteration_item`. - [Read a spending plan iteration item](https://docs.mx.com/api-reference/platform-api/v20111101/reference/spending-plan/read-a-spending-plan-iteration-item.md): Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID. - [Update a spending plan iteration item](https://docs.mx.com/api-reference/platform-api/v20111101/reference/spending-plan/update-a-spending-plan-iteration-item.md): Use this endpoint to update an existing `spending_plan_iteration_item`. - [Read a spending plan iteration](https://docs.mx.com/api-reference/platform-api/v20111101/reference/spending-plan/read-a-spending-plan-iteration.md): Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`. - [List spending plan accounts](https://docs.mx.com/api-reference/platform-api/v20111101/reference/spending-plan/list-spending-plan-accounts.md): Use this endpoint to list all the spending plan accounts associated with the spending plan. - [Delete spending plan account](https://docs.mx.com/api-reference/platform-api/v20111101/reference/spending-plan/delete-spending-plan-account.md): Use this endpoint to delete a `spending_plan_account`. - [Read spending plan account](https://docs.mx.com/api-reference/platform-api/v20111101/reference/spending-plan/read-spending-plan-account.md): Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID. #### Goals - [Create a goal](https://docs.mx.com/api-reference/platform-api/v20111101/reference/goals/create-a-goal.md): Create a goal. This endpoint accepts the optional `MX-Skip-Webhook` header and `skip_webhook` parameter. - [List goals](https://docs.mx.com/api-reference/platform-api/v20111101/reference/goals/list-goals.md): List all goals a user can set. - [Reposition goals](https://docs.mx.com/api-reference/platform-api/v20111101/reference/goals/reposition-goals.md): This endpoint repositions goal priority levels. If one goal is set to a lower priority, then any other goals need to be adjusted accordingly. - [Delete a goal](https://docs.mx.com/api-reference/platform-api/v20111101/reference/goals/delete-a-goal.md): Delete a goal. - [Read a goal](https://docs.mx.com/api-reference/platform-api/v20111101/reference/goals/read-a-goal.md): Read a specific goal. - [Update a goal](https://docs.mx.com/api-reference/platform-api/v20111101/reference/goals/update-a-goal.md): This endpoint updates a specific goal. #### Budgets - [Create a budget](https://docs.mx.com/api-reference/platform-api/v20111101/reference/budgets/create-a-budget.md): 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 cat… - [List all budgets](https://docs.mx.com/api-reference/platform-api/v20111101/reference/budgets/list-all-budgets.md): List all budgets - [Auto-generate budgets](https://docs.mx.com/api-reference/platform-api/v20111101/reference/budgets/auto-generate-budgets.md): 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… - [Read a specific budget](https://docs.mx.com/api-reference/platform-api/v20111101/reference/budgets/read-a-specific-budget.md): Read a specific budget. - [Update a specific budget](https://docs.mx.com/api-reference/platform-api/v20111101/reference/budgets/update-a-specific-budget.md): Update a specific budget. - [Delete a budget](https://docs.mx.com/api-reference/platform-api/v20111101/reference/budgets/delete-a-budget.md): Delete a budget. #### Monthly Cash Flow Profile - [Read monthly cash flow profile](https://docs.mx.com/api-reference/platform-api/v20111101/reference/monthly-cash-flow-profile/read-monthly-cash-flow-profile.md): Read monthly cash flow profile. - [Update monthly cash flow profile](https://docs.mx.com/api-reference/platform-api/v20111101/reference/monthly-cash-flow-profile/update-monthly-cash-flow-profile.md): Use this endpoint to update the attributes of a `monthly_cash_flow_profile`. #### Notifications - [Create a notification](https://docs.mx.com/api-reference/platform-api/v20111101/reference/notifications/create-a-notification.md): 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. - [List notifications](https://docs.mx.com/api-reference/platform-api/v20111101/reference/notifications/list-notifications.md): All notifications for the user can be listed, including notifications created by MX for other channels besides `PUSH`. - [Read notifications](https://docs.mx.com/api-reference/platform-api/v20111101/reference/notifications/read-notifications.md): Can pull up any notification associated with the user, including notifications created by MX for other channels besides `PUSH`. #### Taggings - [List taggings](https://docs.mx.com/api-reference/platform-api/v20111101/reference/taggings/list-taggings.md): Use this endpoint to retrieve a list of all the taggings associated with a specific user. - [Create tagging](https://docs.mx.com/api-reference/platform-api/v20111101/reference/taggings/create-tagging.md): Use this endpoint to create a new association between a tag and a particular transaction, according to their unique GUIDs. - [Delete tagging](https://docs.mx.com/api-reference/platform-api/v20111101/reference/taggings/delete-tagging.md): 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. - [Read tagging](https://docs.mx.com/api-reference/platform-api/v20111101/reference/taggings/read-tagging.md): Use this endpoint to read the attributes of a `tagging` according to its unique GUID. - [Update tagging](https://docs.mx.com/api-reference/platform-api/v20111101/reference/taggings/update-tagging.md): Use this endpoint to update a tagging. #### Tags - [List tags](https://docs.mx.com/api-reference/platform-api/v20111101/reference/tags/list-tags.md): Use this endpoint to list all tags associated with the specified `user`. Each user includes the `Business` tag by default. - [Create tag](https://docs.mx.com/api-reference/platform-api/v20111101/reference/tags/create-tag.md): Use this endpoint to create a new custom tag. - [Delete tag](https://docs.mx.com/api-reference/platform-api/v20111101/reference/tags/delete-tag.md): 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`. - [Read tag](https://docs.mx.com/api-reference/platform-api/v20111101/reference/tags/read-tag.md): Use this endpoint to read the attributes of a particular tag according to its unique GUID. - [Update tag](https://docs.mx.com/api-reference/platform-api/v20111101/reference/tags/update-tag.md): Use this endpoint to update the name of a specific tag according to its unique GUID. #### Processor Token - [Request an account number (Processors Only)](https://docs.mx.com/api-reference/platform-api/v20111101/reference/processor-token/request-an-account-number-processors-only.md): Get account information such as routing number and account number, scoped to your access token. - [Check Real Time Account Balance (Processors Only)](https://docs.mx.com/api-reference/platform-api/v20111101/reference/processor-token/check-real-time-account-balance-processors-only.md): Check the real-time account balance using your access token. - [Get account owner information (Processors Only)](https://docs.mx.com/api-reference/platform-api/v20111101/reference/processor-token/get-account-owner-information-processors-only.md): Get account owner information (Processors Only) - [Request an authorization code](https://docs.mx.com/api-reference/platform-api/v20111101/reference/processor-token/request-an-authorization-code.md): 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 memb… - [Read the account balance (Processors Only)](https://docs.mx.com/api-reference/platform-api/v20111101/reference/processor-token/read-the-account-balance-processors-only.md): Read the account balance (Processors Only) - [(Deprecated) Request an authorization code](https://docs.mx.com/api-reference/platform-api/v20111101/reference/processor-token/deprecated-request-an-authorization-code.md): (This endpoint is deprecated. Clients should use `/authorization_code`.) Clients use this endpoint to request an authorization_code according to a user, member, and account specified in the request body. Clients then pass this code to processors. Processor access is scoped only to the user/member/ac… - [View a List of Tokens](https://docs.mx.com/api-reference/platform-api/v20111101/reference/processor-token/view-a-list-of-tokens.md): View a list of tokens that exist for a user, member, or account. #### Rewards - [Read a Credit Card Product](https://docs.mx.com/api-reference/platform-api/v20111101/reference/rewards/read-a-credit-card-product.md): This endpoint returns the specified `credit_card_product` according to the unique GUID. - [Aggregate Rewards](https://docs.mx.com/api-reference/platform-api/v20111101/reference/rewards/aggregate-rewards.md): 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. - [Fetch Rewards](https://docs.mx.com/api-reference/platform-api/v20111101/reference/rewards/fetch-rewards.md): 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. - [List Rewards](https://docs.mx.com/api-reference/platform-api/v20111101/reference/rewards/list-rewards.md): Use this endpoint to list all the `rewards` associated with a specified `member`. Member guids are defined by MX. - [Read Reward](https://docs.mx.com/api-reference/platform-api/v20111101/reference/rewards/read-reward.md): Use this endpoint to read a specific `reward` based on its unique GUID. Member and Rewards guids are defined by MX. #### Verifiable Credentials - [Get Transactions Data](https://docs.mx.com/api-reference/platform-api/v20111101/reference/verifiable-credentials/get-transactions-data.md): Get an MX-issued verifiable credential of a user's transaction data. - [Get Accounts Data](https://docs.mx.com/api-reference/platform-api/v20111101/reference/verifiable-credentials/get-accounts-data.md): Get an MX-issued verifiable credential of a user's accounts data. - [Get Identity Data](https://docs.mx.com/api-reference/platform-api/v20111101/reference/verifiable-credentials/get-identity-data.md): Get an MX-issued verifiable credential of a user's identity data. #### ACH Returns - [List ACH Returns](https://docs.mx.com/api-reference/platform-api/v20111101/reference/ach-return/list-ach-returns.md): The features documented here are in a beta state, and this documentation is considered draft material subject to frequent change. - [Create ACH Return](https://docs.mx.com/api-reference/platform-api/v20111101/reference/ach-return/create-ach-return.md): The features documented here are in a beta state, and this documentation is considered draft material subject to frequent change. - [Read ACH Return](https://docs.mx.com/api-reference/platform-api/v20111101/reference/ach-return/read-ach-return.md): The features documented here are in a beta state, and this documentation is considered draft material subject to frequent change. ## OpenAPI Specs - [v20111101](/openapi/platform-api/v20111101.yaml)