{ "opencollection": "1.0.0", "info": { "name": "MX Platform accounts managed data [deprecated] API", "version": "20111101" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "managed data [deprecated]", "type": "folder" }, "items": [ { "info": { "name": "List managed institutions", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/managed_institutions", "headers": [ { "name": "Accept-Version", "value": "" } ], "params": [ { "name": "page", "value": "1", "type": "query", "description": "Results are paginated. Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead." } ] }, "docs": "This endpoint returns a list of institutions which can be used to create partner-managed members.\n:::warning Deprecated\nThis endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration)\n:::\n" }, { "info": { "name": "List managed members", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_guid/managed_members", "headers": [ { "name": "Accept-Version", "value": "" } ], "params": [ { "name": "page", "value": "1", "type": "query", "description": "Results are paginated. Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "docs": "This endpoint returns a list of all the partner-managed members associated with the specified `user`.\n:::warning Deprecated\nThis endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).\n:::\n" }, { "info": { "name": "Create managed member", "type": "http" }, "http": { "method": "POST", "url": "https://int-api.mx.com/users/:user_guid/managed_members", "headers": [ { "name": "Accept-Version", "value": "" } ], "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique identifier for a `user`, beginning with the prefix `USR-`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new partner-managed `member`.\n:::warning Deprecated\nThis endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).\n:::\n" }, { "info": { "name": "Read managed member", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_guid/managed_members/:member_guid", "headers": [ { "name": "Accept-Version", "value": "" } ], "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 identifier for a `user`, beginning with the prefix `USR-`." } ] }, "docs": "This endpoint returns the attributes of the specified partner-managed`member`.\n:::warning Deprecated\nThis endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).\n:::\n" }, { "info": { "name": "Update managed member", "type": "http" }, "http": { "method": "PUT", "url": "https://int-api.mx.com/users/:user_guid/managed_members/:member_guid", "headers": [ { "name": "Accept-Version", "value": "" } ], "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 identifier for a `user`, beginning with the prefix `USR-`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the attributes of the specified partner_managed `member`.\n:::warning Deprecated\nThis endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).\n:::\n" }, { "info": { "name": "Delete managed member", "type": "http" }, "http": { "method": "DELETE", "url": "https://int-api.mx.com/users/:user_guid/managed_members/:member_guid", "headers": [ { "name": "Accept-Version", "value": "" }, { "name": "Accept", "value": "" } ], "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 identifier for a `user`, beginning with the prefix `USR-`." } ] }, "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.\n:::warning Deprecated\nThis endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).\n:::\n" }, { "info": { "name": "List managed accounts", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_guid/managed_members/:member_guid/accounts", "headers": [ { "name": "Accept-Version", "value": "" } ], "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": "Results are paginated. Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "docs": "Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-managed member.\n:::warning Deprecated\nThis endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).\n:::\n" }, { "info": { "name": "Create managed account", "type": "http" }, "http": { "method": "POST", "url": "https://int-api.mx.com/users/:user_guid/managed_members/:member_guid/accounts", "headers": [ { "name": "Accept-Version", "value": "" } ], "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 identifier for a `user`, beginning with the prefix `USR-`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a partner-managed account.\n:::warning Deprecated\nThis endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).\n:::\n" }, { "info": { "name": "Read managed account", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid", "headers": [ { "name": "Accept-Version", "value": "" } ], "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 identifier for a `user`, beginning with the prefix `USR-`." } ] }, "docs": "Use this endpoint to read the attributes of a partner-managed account according to its unique guid.\n:::warning Deprecated\nThis endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).\n:::\n" }, { "info": { "name": "Update managed account", "type": "http" }, "http": { "method": "PUT", "url": "https://int-api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid", "headers": [ { "name": "Accept-Version", "value": "" } ], "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 identifier for a `user`, beginning with the prefix `USR-`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the attributes of a partner-managed account according to its unique GUID.\n:::warning Deprecated \nThis endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).\n:::\n" }, { "info": { "name": "Delete managed account", "type": "http" }, "http": { "method": "DELETE", "url": "https://int-api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid", "headers": [ { "name": "Accept-Version", "value": "" } ], "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 identifier for a `user`, beginning with the prefix `USR-`." } ] }, "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`.\n:::warning Deprecated\nThis endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).\n:::\n" }, { "info": { "name": "List managed transactions", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions", "headers": [ { "name": "Accept-Version", "value": "" } ], "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": "Results are paginated. Specify current page." }, { "name": "from_date", "value": "2024-02-01", "type": "query", "description": "Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided." }, { "name": "to_date", "value": "2024-08-28", "type": "query", "description": "Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "docs": "This endpoint returns a list of all the partner-managed transactions associated with the specified `account`, scoped through a `user` and a `member`.\n:::warning Deprecated\nThis endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).\n:::\n" }, { "info": { "name": "Create managed transaction", "type": "http" }, "http": { "method": "POST", "url": "https://int-api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions", "headers": [ { "name": "Accept-Version", "value": "" } ], "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 identifier for a `user`, beginning with the prefix `USR-`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new partner-managed `transaction`.\n:::warning Deprecated\nThis endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).\n:::\n" }, { "info": { "name": "Read managed transaction", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions/:transaction_guid", "headers": [ { "name": "Accept-Version", "value": "" } ], "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 identifier for a `user`, beginning with the prefix `USR-`." } ] }, "docs": "Requests to this endpoint will return the attributes of the specified partner-managed `transaction`.\n:::warning Deprecated\nThis endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).\n:::\n" }, { "info": { "name": "Update managed transaction", "type": "http" }, "http": { "method": "PUT", "url": "https://int-api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions/:transaction_guid", "headers": [ { "name": "Accept-Version", "value": "" } ], "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 identifier for a `user`, beginning with the prefix `USR-`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the attributes of the specified partner_managed `transaction`.\n:::warning Deprecated\nThis endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).\n:::\n" }, { "info": { "name": "Delete managed transaction", "type": "http" }, "http": { "method": "DELETE", "url": "https://int-api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions/:transaction_guid", "headers": [ { "name": "Accept-Version", "value": "" } ], "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 identifier for a `user`, beginning with the prefix `USR-`." } ] }, "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.\n:::warning Deprecated\nThis endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).\n:::\n" } ] } ], "bundled": true }