{ "opencollection": "1.0.0", "info": { "name": "MX Platform Users API", "version": "0.1.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "List users", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "id", "value": "u-12324-abdc", "type": "query", "description": "The user `id` to search for." }, { "name": "email", "value": "example@example.com", "type": "query", "description": "The user `email` to search for." }, { "name": "is_disabled", "value": "true", "type": "query", "description": "Search for users that are diabled." } ] }, "docs": "Use this endpoint to list every user you've created in the MX Platform API." }, { "info": { "name": "Create user", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users", "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new user. The API will respond with the newly-created user object if successful. 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 users data until they are no longer disabled." }, { "info": { "name": "Read user", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to read the attributes of a specific user." }, { "info": { "name": "Update user", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the attributes of the specified user." }, { "info": { "name": "Delete user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object." }, { "info": { "name": "List accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/accounts", "params": [ { "name": "member_is_managed_by_user", "value": "true", "type": "query", "description": "List only accounts whose member is managed by the user." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "is_manual", "value": "true", "type": "query", "description": "List only accounts that were manually created." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint returns a list of all the accounts associated with the specified `user`." }, { "info": { "name": "Create manual account", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/accounts", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Read account", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/accounts/:account_guid", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint returns the specified `account` resource." }, { "info": { "name": "Delete manual account", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/accounts/:account_guid", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of `204 No Content`." }, { "info": { "name": "List account numbers by account", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/accounts/:account_guid/account_numbers", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint returns a list of account numbers associated with the specified `account`." }, { "info": { "name": "List holdings by account", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/accounts/:account_guid/holdings", "params": [ { "name": "account_guid", "value": "ACT-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for the `account`." }, { "name": "from_date", "value": "2015-09-20", "type": "query", "description": "Filter holdings from this date." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "to_date", "value": "2019-10-20", "type": "query", "description": "Filter holdings to this date." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for the `user`." } ] }, "docs": "This endpoint returns all holdings associated with the specified `account`." }, { "info": { "name": "List insights by account", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/accounts/:account_guid/insights", "params": [ { "name": "account_guid", "value": "ACT-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for the `account`." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for the `user`." } ] }, "docs": "Use this endpoint to list all insights associated with a specified account GUID." }, { "info": { "name": "List transactions by account", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/accounts/:account_guid/transactions", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "from_date", "value": "2015-09-20", "type": "query", "description": "Filter transactions from this date." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "to_date", "value": "2019-10-20", "type": "query", "description": "Filter transactions to this date." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint returns a list of the last 90 days of transactions associated with the specified account." }, { "info": { "name": "Create manual transaction", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/accounts/:account_guid/transactions", "params": [ { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for the user." }, { "name": "account_guid", "value": "", "type": "path", "description": "The unique identifier for the account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Auto-generate budgets", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/budgets/generate", "params": [ { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for the user. Defined by MX." } ] }, "docs": "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" }, { "info": { "name": "List all budgets", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/budgets", "params": [ { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for the user. Defined by MX." } ] }, "docs": "List all budgets" }, { "info": { "name": "Create a budget", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/budgets", "params": [ { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for the user. Defined by MX." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Read a specific budget", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/budgets/:budget_guid", "params": [ { "name": "budget_guid", "value": "", "type": "path", "description": "The unique identifier for the budget. Defined by MX." }, { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for the budget. Defined by MX." } ] }, "docs": "Read a specific budget." }, { "info": { "name": "Update a specific budget", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/budgets/:budget_guid", "params": [ { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for the budget. Defined by MX." }, { "name": "budget_guid", "value": "", "type": "path", "description": "The unique identifier for the budget. Defined by MX." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific budget." }, { "info": { "name": "Delete a budget", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/budgets/:budget_guid", "params": [ { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for the budget. Defined by MX." }, { "name": "budget_guid", "value": "", "type": "path", "description": "The unique identifier for the budget. Defined by MX." } ] }, "docs": "Delete a budget." }, { "info": { "name": "List categories", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/categories", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to list all categories associated with a `user`, including both default and custom categories." }, { "info": { "name": "Create category", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/categories", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new custom category for a specific `user`." }, { "info": { "name": "List default categories by user", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/categories/default", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "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." }, { "info": { "name": "Read a custom category", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/categories/:category_guid", "params": [ { "name": "category_guid", "value": "CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874", "type": "path", "description": "The unique id for a `category`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to read the attributes of either a default category or a custom category." }, { "info": { "name": "Update category", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/categories/:category_guid", "params": [ { "name": "category_guid", "value": "CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874", "type": "path", "description": "The unique id for a `category`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the attributes of a custom category according to its unique GUID." }, { "info": { "name": "Delete category", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/categories/:category_guid", "params": [ { "name": "category_guid", "value": "CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874", "type": "path", "description": "The unique id for a `category`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "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`." }, { "info": { "name": "Request connect widget url", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/connect_widget_url", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint will return a URL for an embeddable version of MX Connect." }, { "info": { "name": "List goals", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/goals", "params": [ { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for the user." }, { "name": "page", "value": "null", "type": "query", "description": "Results are returned in paginated sets, this is the page of the results you would like to view. Defaults to page 1 if no page is specified." }, { "name": "records_per_age", "value": "null", "type": "query", "description": "The supported range is from 10 to 1000. If the records_per_page parameter is not specified or is outside this range, a default of 25 records per page will be used." } ] }, "docs": "List all goals a user can set." }, { "info": { "name": "Create a goal", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/goals", "params": [ { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a goal. This endpoint accepts the optional `MX-Skip-Webhook` header and `skip_webhook` parameter." }, { "info": { "name": "Read a goal", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/goals/:goal_guid", "params": [ { "name": "goal_guid", "value": "", "type": "path", "description": "The unique identifier for a goal. Defined by MX." }, { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for a user." } ] }, "docs": "Read a specific goal." }, { "info": { "name": "Update a goal", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/goals/:goal_guid", "params": [ { "name": "goal_guid", "value": "", "type": "path", "description": "The unique identifier for a goal. Defined by MX." }, { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for a user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates a specific goal." }, { "info": { "name": "Delete a goal", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/goals/:goal_guid", "params": [ { "name": "goal_guid", "value": "", "type": "path", "description": "The unique identifier for a goal. Defined by MX." }, { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for a user." } ] }, "docs": "Delete a goal." }, { "info": { "name": "Reposition goals", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/goals/reposition", "params": [ { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint repositions goal priority levels. If one goal is set to a lower priority, then any other goals need to be adjusted accordingly." }, { "info": { "name": "List holdings", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/holdings", "params": [ { "name": "from_date", "value": "2015-09-20", "type": "query", "description": "Filter holdings from this date." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "to_date", "value": "2019-10-20", "type": "query", "description": "Filter holdings to this date." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint returns all holdings associated with the specified `user` across all accounts and members." }, { "info": { "name": "Read holding", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/holdings/:holding_guid", "params": [ { "name": "holding_guid", "value": "HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2", "type": "path", "description": "The unique id for a `holding`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to read the attributes of a specific `holding`." }, { "info": { "name": "List all insights for a user.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/insights", "params": [ { "name": "user_guid", "value": "USR-1234-abcd", "type": "path", "description": "The unique identifier for the user. Defined by MX." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." } ] }, "docs": "Use this endpoint to list all the insights associated with the user." }, { "info": { "name": "List all categories associated with an insight.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/insights/:insight_guid/categories", "params": [ { "name": "user_guid", "value": "USR-1234-abcd", "type": "path", "description": "The unique identifier for the user. Defined by MX." }, { "name": "insight_guid", "value": "BET-1234-abcd", "type": "path", "description": "The unique identifier for the insight. Defined by MX." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." } ] }, "docs": "Use this endpoint to list all the categories associated with the insight." }, { "info": { "name": "List all accounts associated with an insight.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/insights/:insight_guid/accounts", "params": [ { "name": "user_guid", "value": "USR-1234-abcd", "type": "path", "description": "The unique identifier for the user. Defined by MX." }, { "name": "insight_guid", "value": "BET-1234-abcd", "type": "path", "description": "The unique identifier for the insight. Defined by MX." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." } ] }, "docs": "Use this endpoint to list all the accounts associated with the insight." }, { "info": { "name": "List all merchants associated with an insight.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/insights/:insight_guid/merchants", "params": [ { "name": "user_guid", "value": "USR-1234-abcd", "type": "path", "description": "The unique identifier for the user. Defined by MX." }, { "name": "insight_guid", "value": "BET-1234-abcd", "type": "path", "description": "The unique identifier for the insight. Defined by MX." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." } ] }, "docs": "Use this endpoint to list all the merchants associated with the insight." }, { "info": { "name": "List all scheduled payments associated with an insight", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/insights/:insight_guid/scheduled_payments", "params": [ { "name": "user_guid", "value": "USR-1234-abcd", "type": "path", "description": "The unique identifier for the user. Defined by MX." }, { "name": "insight_guid", "value": "BET-1234-abcd", "type": "path", "description": "The unique identifier for the insight. Defined by MX." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." } ] }, "docs": "Use this endpoint to list all the scheduled payments associated with the insight." }, { "info": { "name": "List all transactions associated with an insight.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/insights/:insight_guid/transactions", "params": [ { "name": "user_guid", "value": "USR-1234-abcd", "type": "path", "description": "The unique identifier for the user. Defined by MX." }, { "name": "insight_guid", "value": "BET-1234-abcd", "type": "path", "description": "The unique identifier for the insight. Defined by MX." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." } ] }, "docs": "Use this endpoint to list all the transactions associated with the insight." }, { "info": { "name": "Read a specific insight.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/insights:insight_guid", "params": [ { "name": "user_guid", "value": "USR-1234-abcd", "type": "path", "description": "The unique identifier for the user. Defined by MX." }, { "name": "insight_guid", "value": "BET-1234-abcd", "type": "path", "description": "The unique identifier for the insight. Defined by MX." } ] }, "docs": "Use this endpoint to read the attributes of a specific insight according to its unique GUID." }, { "info": { "name": "Update insight", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/insights:insight_guid", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique identifier for the user. Defined by MX." }, { "name": "insight_guid", "value": "BET-1234-abcd", "type": "path", "description": "The unique identifier for the insight. Defined by MX." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the attributes of a particular insight according to its unique GUID." }, { "info": { "name": "List managed members", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/managed_members", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint returns a list of all the partner-managed members associated with the specified `user`." }, { "info": { "name": "Create managed member", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/managed_members", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new partner-managed `member`." }, { "info": { "name": "Read managed member", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint returns the attributes of the specified partner-managed `member`." }, { "info": { "name": "Update managed member", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the attributes of the specified partner_managed `member`." }, { "info": { "name": "Delete managed member", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to delete the specified partner-managed `member`. The endpoint will respond with a status of `204 No Content` without a resource." }, { "info": { "name": "List managed accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid/accounts", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-manage member." }, { "info": { "name": "Create managed account", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid/accounts", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a partner-managed account." }, { "info": { "name": "Read managed account", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to read the attributes of a partner-managed account according to its unique guid." }, { "info": { "name": "Update managed account", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the attributes of a partner-managed account according to its unique GUID." }, { "info": { "name": "Delete managed account", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "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`." }, { "info": { "name": "List managed transactions", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint returns a list of all the partner-managed transactions associated with the specified `account`, scoped through a `user` and a `member`." }, { "info": { "name": "Create managed transaction", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new partner-managed `transaction`." }, { "info": { "name": "Read managed transaction", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions/:transaction_guid", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "transaction_guid", "value": "TRN-810828b0-5210-4878-9bd3-f4ce514f90c4", "type": "path", "description": "The unique id for a `transaction`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Requests to this endpoint will return the attributes of the specified partner-managed `transaction`." }, { "info": { "name": "Update managed transaction", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions/:transaction_guid", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "transaction_guid", "value": "TRN-810828b0-5210-4878-9bd3-f4ce514f90c4", "type": "path", "description": "The unique id for a `transaction`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the attributes of the specified partner_managed `transaction`." }, { "info": { "name": "Delete managed transaction", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions/:transaction_guid", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "transaction_guid", "value": "TRN-810828b0-5210-4878-9bd3-f4ce514f90c4", "type": "path", "description": "The unique id for a `transaction`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to delete the specified partner-managed `transaction`. The endpoint will respond with a status of `204 No Content` without a resource." }, { "info": { "name": "List members", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint returns an array which contains information on every member associated with a specific user." }, { "info": { "name": "Create member", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/members", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 provided by the user. You can find out which credential type is required with the `/institutions/{institution_code}/credentials` endpoint. If successful, the MX Platform API will respond with the newly-cr" }, { "info": { "name": "Read member", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to read the attributes of a specific member." }, { "info": { "name": "Update member", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/members/:member_guid", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete member", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/members/:member_guid", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Accessing this endpoint will permanently delete a member." }, { "info": { "name": "List account numbers by member", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/account_numbers", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint returns a list of account numbers associated with the specified `member`." }, { "info": { "name": "List account owners by member", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/account_owners", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint returns an array with information about every account associated with a particular member." }, { "info": { "name": "List accounts by member", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/accounts", "params": [ { "name": "member_is_managed_by_user", "value": "true", "type": "query", "description": "List only accounts whose member is managed by the user." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." } ] }, "docs": "This endpoint returns a list of all the accounts associated with the specified `member`." }, { "info": { "name": "Read account by member", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/accounts/:account_guid", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint allows you to read the attributes of an `account` resource." }, { "info": { "name": "Update account by member", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/accounts/:account_guid", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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`." }, { "info": { "name": "Aggregate member", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/aggregate", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "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." }, { "info": { "name": "List member challenges", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/challenges", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "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." }, { "info": { "name": "Check balances", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/check_balance", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data." }, { "info": { "name": "List member credentials", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/credentials", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint returns an array which contains information on every non-MFA credential associated with a specific member." }, { "info": { "name": "Extend history", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/extend_history", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique identifier for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique identifier for a `user`." } ] }, "docs": "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." }, { "info": { "name": "Fetch Rewards", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/fetch_rewards", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." }, { "name": "member_guid", "value": "MBR-fa7537f3-48aa-a683-a02a-b18345562f54", "type": "path", "description": "The unique identifier for the member. Defined by MX." } ] }, "docs": "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." }, { "info": { "name": "Fetch statements", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/fetch_statements", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to fetch the statements associated with a particular member." }, { "info": { "name": "Fetch Tax Documents", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/fetch_tax_documents", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to fetch (aggregate) the tax documents associated with the specified member. This request **does not** return the latest tax documents. It just starts the document aggregation process and returns the initial state of the process. You must interact with the newly aggregated data using the other document endpoints in this reference. This request may also trigger multi-factor authentication which requires end-user input and a specific process for answering authentication challenge" }, { "info": { "name": "List holdings by member", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/holdings", "params": [ { "name": "from_date", "value": "2015-09-20", "type": "query", "description": "Filter holdings from this date." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "to_date", "value": "2019-10-20", "type": "query", "description": "Filter holdings to this date." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint returns all holdings associated with the specified `member` across all accounts." }, { "info": { "name": "Identify member", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/identify", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "The identify endpoint begins an identification process for an already-existing member." }, { "info": { "name": "Request oauth window uri", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/oauth_window_uri", "params": [ { "name": "client_redirect_url", "value": "https://mx.com", "type": "query", "description": "A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with `referral_source=APP`." }, { "name": "enable_app2app", "value": "false", "type": "query", "description": "This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to `true`. This setting is not persistent." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "referral_source", "value": "APP", "type": "query", "description": "Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`." }, { "name": "skip_aggregation", "value": "false", "type": "query", "description": "Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page." }, { "name": "ui_message_webview_url_scheme", "value": "mx", "type": "query", "description": "A scheme for routing the user back to the application state they were previously in. Only available with `referral_source=APP`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint will generate an `oauth_window_uri` for the specified `member`." }, { "info": { "name": "Resume aggregation", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/resume", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication." }, { "info": { "name": "List Rewards", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/rewards", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." }, { "name": "member_guid", "value": "MBR-fa7537f3-48aa-a683-a02a-b18345562f54", "type": "path", "description": "The unique identifier for the member. Defined by MX." } ] }, "docs": "Use this endpoint to list all the `rewards` associated with a specified `member`." }, { "info": { "name": "Read Reward", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/rewards/:reward_guid", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." }, { "name": "member_guid", "value": "MBR-fa7537f3-48aa-a683-a02a-b18345562f54", "type": "path", "description": "The unique identifier for the member. Defined by MX." }, { "name": "reward_guid", "value": "RWD-fa7537f3-48aa-a683-a02a-b324322f54", "type": "path", "description": "The unique identifier for the rewards. Defined by MX." } ] }, "docs": "Use this endpoint to read a specific `reward` based on its unique GUID.." }, { "info": { "name": "List statements by member", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/statements", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to get an array of available statements." }, { "info": { "name": "Read statement by member", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/statements/:statement_guid", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "statement_guid", "value": "STA-737a344b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for a `statement`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to read a JSON representation of the statement." }, { "info": { "name": "Download statement pdf", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/statements/:statement_guid.pdf", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "statement_guid", "value": "STA-737a344b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for a `statement`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to download a specified statement PDF." }, { "info": { "name": "Read member status", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/status", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "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 information on the current status of a members connection to a financial institution and the state of its aggregation - the connection_status field. These are intended to replace and expand upon the informati" }, { "info": { "name": "List Tax Documents", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/tax_documents", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to get a paginated list of tax documents." }, { "info": { "name": "Read a Tax Document", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/tax_documents/:tax_document_guid", "params": [ { "name": "tax_document_guid", "value": "TAX-987dfds1b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `tax_document`." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to read the attributes of the specified tax document." }, { "info": { "name": "Download a Tax Document PDF", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/tax_documents/:tax_document_guid.pdf", "params": [ { "name": "tax_document_guid", "value": "TAX-987dfds1b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `tax_document`." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to download a PDF version of the specified tax document. The endpoint URL is the base URL appended with the uri of the tax_document." }, { "info": { "name": "List transactions by member", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/transactions", "params": [ { "name": "from_date", "value": "2015-09-20", "type": "query", "description": "Filter transactions from this date." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "to_date", "value": "2019-10-20", "type": "query", "description": "Filter transactions to this date." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Requests to this endpoint return a list of transactions associated with the specified `member`, accross all accounts associated with that `member`." }, { "info": { "name": "Verify member", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/verify", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "The verify endpoint begins a verification process for a member." }, { "info": { "name": "List all microdeposits for a user", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/micro_deposits", "params": [ { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for the user. Defined by MX." } ] }, "docs": "Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID." }, { "info": { "name": "Create a microdeposit", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/micro_deposits", "params": [ { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for the user. Defined by MX." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a microdeposit. The response will include the new microdeposit record with a status of INITIATED." }, { "info": { "name": "Read a microdeposit for a user", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/micro_deposits/:micro_deposit_guid", "params": [ { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for the user. Defined by MX." }, { "name": "micro_deposit_guid", "value": "", "type": "path", "description": "The unique identifier for the microdeposit. Defined by MX." } ] }, "docs": "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 microdeposit endpoint." }, { "info": { "name": "Delete a microdeposit", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/micro_deposits/:micro_deposit_guid", "params": [ { "name": "micro_deposit_guid", "value": "MIC-09ba578e-8448-4f7f-89e1-b62ff2517edb", "type": "path", "description": "The unique identifier for the microdeposit. Defined by MX." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to delete the specified microdeposit." }, { "info": { "name": "Read monthly cash flow profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/monthly_cash_flow_profile", "params": [ { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for the user." } ] }, "docs": "Read monthly cash flow profile" }, { "info": { "name": "Update monthly cash flow profile", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/monthly_cash_flow_profile", "params": [ { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the attributes of a `monthly_cash_flow_profile`." }, { "info": { "name": "List spending plan iteration items", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." }, { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." } ] }, "docs": "Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`." }, { "info": { "name": "Create spending plan iteration item", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items", "params": [ { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates a new `spending_plan_iteration_item`." }, { "info": { "name": "List spending plans", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/spending_plans", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to list all the spending plans associated with the user." }, { "info": { "name": "Create spending plan", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/spending_plans", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint creates a new `spending_plan` for the user." }, { "info": { "name": "Read spending plan account", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/spending_plan_accounts/:spending_plan_account_guid", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." }, { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." }, { "name": "spending_plan_account_guid", "value": "ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c", "type": "path", "description": "The unique ID for the specified account." } ] }, "docs": "Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID." }, { "info": { "name": "Delete spending plan account", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/spending_plan_accounts/:spending_plan_account_guid", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique ID for a `user`." }, { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." }, { "name": "spending_plan_account_guid", "value": "ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c", "type": "path", "description": "The unique ID for the specified account." } ] }, "docs": "Use this endpoint to delete a `spending_plan_account`." }, { "info": { "name": "Read a spending plan iteration item", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items/:iteration_item_guid", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." }, { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." }, { "name": "iteration_item_guid", "value": "SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3", "type": "path", "description": "The unique ID for the `iteration_item`." } ] }, "docs": "Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID." }, { "info": { "name": "Update a spending plan iteration item", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items/:iteration_item_guid", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." }, { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." }, { "name": "iteration_item_guid", "value": "SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3", "type": "path", "description": "The unique ID for the `iteration_item`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update an existing `spending_plan_iteration_item`." }, { "info": { "name": "Delete spending plan iteration item", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items/:iteration_item_guid", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique ID for a `user`." }, { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." }, { "name": "iteration_item_guid", "value": "SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3", "type": "path", "description": "The unique ID for the `iteration_item`." } ] }, "docs": "Use this endpoint to delete a spending plan `iteration_item`." }, { "info": { "name": "Read a spending plan for a user", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." }, { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." } ] }, "docs": "Use this endpoint to read the attributes of a specific spending plan according to its unique GUID." }, { "info": { "name": "Delete spending plan", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique ID for a `user`." }, { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." } ] }, "docs": "Use this endpoint to delete a user's `spending_plan`." }, { "info": { "name": "List spending plan accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/spending_plan_accounts", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." }, { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." } ] }, "docs": "Use this endpoint to list all the spending plan accounts associated with the spending plan." }, { "info": { "name": "List spending plan iterations", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/iterations", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." }, { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." } ] }, "docs": "Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`." }, { "info": { "name": "Read a spending plan iteration", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/iterations/:iteration_number", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." }, { "name": "spending_plan_guid", "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262", "type": "path", "description": "The unique ID for the `spending_plan`." }, { "name": "iteration_number", "value": "1", "type": "path", "description": "The current iteration number for the spending plan `iteration``." } ] }, "docs": "Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`." }, { "info": { "name": "List taggings", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/taggings", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to retrieve a list of all the taggings associated with a specific user." }, { "info": { "name": "Create tagging", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/taggings", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new association between a tag and a particular transaction, according to their unique GUIDs." }, { "info": { "name": "Read tagging", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/taggings/:tagging_guid", "params": [ { "name": "tagging_guid", "value": "TGN-007f5486-17e1-45fc-8b87-8f03984430fe", "type": "path", "description": "The unique id for a `tagging`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to read the attributes of a `tagging` according to its unique GUID." }, { "info": { "name": "Update tagging", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/taggings/:tagging_guid", "params": [ { "name": "tagging_guid", "value": "TGN-007f5486-17e1-45fc-8b87-8f03984430fe", "type": "path", "description": "The unique id for a `tagging`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update a tagging." }, { "info": { "name": "Delete tagging", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/taggings/:tagging_guid", "params": [ { "name": "tagging_guid", "value": "TGN-007f5486-17e1-45fc-8b87-8f03984430fe", "type": "path", "description": "The unique id for a `tagging`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "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." }, { "info": { "name": "List tags", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/tags", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to list all tags associated with the specified `user`. Each user includes the `Business` tag by default." }, { "info": { "name": "Create tag", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/tags", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new custom tag." }, { "info": { "name": "Read tag", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/tags/:tag_guid", "params": [ { "name": "tag_guid", "value": "TAG-aef36e72-6294-4c38-844d-e573e80aed52", "type": "path", "description": "The unique id for a `tag`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to read the attributes of a particular tag according to its unique GUID." }, { "info": { "name": "Update tag", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/tags/:tag_guid", "params": [ { "name": "tag_guid", "value": "TAG-aef36e72-6294-4c38-844d-e573e80aed52", "type": "path", "description": "The unique id for a `tag`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the name of a specific tag according to its unique GUID." }, { "info": { "name": "Delete tag", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/tags/:tag_guid", "params": [ { "name": "tag_guid", "value": "TAG-aef36e72-6294-4c38-844d-e573e80aed52", "type": "path", "description": "The unique id for a `tag`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "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`." }, { "info": { "name": "List transactions by tag", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/tags/:tag_guid/transactions", "params": [ { "name": "from_date", "value": "2015-09-20", "type": "query", "description": "Filter transactions from this date." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "tag_guid", "value": "TAG-aef36e72-6294-4c38-844d-e573e80aed52", "type": "path", "description": "The unique id for a `tag`." }, { "name": "to_date", "value": "2019-10-20", "type": "query", "description": "Filter transactions to this date." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to get a list of all transactions associated with a particular tag according to the tags unique GUID. In other words, a list of all transactions that have been assigned to a particular tag using the create a tagging endpoint." }, { "info": { "name": "List transaction rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/transaction_rules", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to read the attributes of all existing transaction rules belonging to the user." }, { "info": { "name": "Create transaction rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/transaction_rules", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new transaction rule. The newly-created `transaction_rule` object will be returned if successful." }, { "info": { "name": "Read transaction rule", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/transaction_rules/:transaction_rule_guid", "params": [ { "name": "transaction_rule_guid", "value": "TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3", "type": "path", "description": "The unique id for a `transaction_rule`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to read the attributes of an existing transaction rule based on the rules unique GUID." }, { "info": { "name": "Update transaction_rule", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/transaction_rules/:transaction_rule_guid", "params": [ { "name": "transaction_rule_guid", "value": "TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3", "type": "path", "description": "The unique id for a `transaction_rule`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete transaction rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/transaction_rules/:transaction_rule_guid", "params": [ { "name": "transaction_rule_guid", "value": "TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3", "type": "path", "description": "The unique id for a `transaction_rule`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to permanently delete a transaction rule based on its unique GUID." }, { "info": { "name": "List transactions", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/transactions", "params": [ { "name": "from_date", "value": "2015-09-20", "type": "query", "description": "Filter transactions from this date." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "to_date", "value": "2019-10-20", "type": "query", "description": "Filter transactions to this date." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`." }, { "info": { "name": "Read transaction", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/transactions/:transaction_guid", "params": [ { "name": "transaction_guid", "value": "TRN-810828b0-5210-4878-9bd3-f4ce514f90c4", "type": "path", "description": "The unique id for a `transaction`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Requests to this endpoint will return the attributes of the specified `transaction`." }, { "info": { "name": "Update transaction", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/transactions/:transaction_guid", "params": [ { "name": "transaction_guid", "value": "TRN-810828b0-5210-4878-9bd3-f4ce514f90c4", "type": "path", "description": "The unique id for a `transaction`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the `description` of a specific transaction according to its unique GUID." }, { "info": { "name": "Create split transactions", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/transactions/:transaction_guid/split", "params": [ { "name": "user_guid", "value": "", "type": "path", "description": "The unique identifier for the user. Defined by MX." }, { "name": "transaction_guid", "value": "", "type": "path", "description": "The unique identifier for the transaction. Defined by MX." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 tran" }, { "info": { "name": "Delete split transactions", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/transactions/:transaction_guid/split", "params": [ { "name": "transaction_guid", "value": "TRN-810828b0-5210-4878-9bd3-f4ce514f90c4", "type": "path", "description": "The unique id for a `transaction`." }, { "name": "user_guid", "value": "USR-85628b0-5210-4878-9bd3-f4ce154f90c4", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "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." }, { "info": { "name": "Request widget url", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/users/:user_guid/widget_urls", "headers": [ { "name": "Accept-Language", "value": "en-US" } ], "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint allows partners to get a URL by passing the `widget_type` in the request body, as well as configuring it in several different ways. In the case of Connect, that means setting the `widget_type` to `connect_widget`. Partners may also pass an optional `Accept-Language` header as well as a number of configuration options. Note that this is a `POST` request." } ] } ], "bundled": true }