{ "opencollection": "1.0.0", "info": { "name": "MX Platform accounts API", "version": "20111101" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "accounts", "type": "folder" }, "items": [ { "info": { "name": "List accounts", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_guid/accounts", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Results are paginated. Specify current page." }, { "name": "member_is_managed_by_user", "value": "true", "type": "query", "description": "List only accounts whose member is managed by the user." }, { "name": "is_manual", "value": "true", "type": "query", "description": "List only accounts that were manually created." }, { "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-`." }, { "name": "use_case", "value": "MONEY_MOVEMENT", "type": "query", "description": "The use case associated with the member. Valid values are `PFM` and `MONEY_MOVEMENT`. For example, you can append either `?use_case=PFM` or `?use_case=MONEY_MOVEMENT`." } ] }, "docs": "This endpoint returns a list of all the accounts associated with the specified `user`.\n\n:::warning\nThis request will not return the full account number. It may return the last four digits of the account number if that information has been provided during aggregation. If you need the full account number, please refer to [List account numbers by member](/api-reference/platform-api/reference/list-account-numbers-by-member/) or [List account numbers by account](/api-reference/platform-api/reference/" }, { "info": { "name": "Create manual account", "type": "http" }, "http": { "method": "POST", "url": "https://int-api.mx.com/users/:user_guid/accounts", "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": "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://int-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 identifier for a `user`, beginning with the prefix `USR-`." } ] }, "docs": "This endpoint returns the specified `account` resource." }, { "info": { "name": "Delete manual account", "type": "http" }, "http": { "method": "DELETE", "url": "https://int-api.mx.com/users/:user_guid/accounts/:account_guid", "headers": [ { "name": "Accept", "value": "" } ], "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 identifier for a `user`, beginning with the prefix `USR-`." } ] }, "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://int-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": "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 account numbers associated with the specified `account`." }, { "info": { "name": "List account numbers by member", "type": "http" }, "http": { "method": "GET", "url": "https://int-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": "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 account numbers associated with the specified `member`." }, { "info": { "name": "List account owners by member", "type": "http" }, "http": { "method": "GET", "url": "https://int-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": "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 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://int-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": "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-`." }, { "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://int-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 identifier for a `user`, beginning with the prefix `USR-`." } ] }, "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://int-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 identifier for a `user`, beginning with the prefix `USR-`." } ], "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": "List accounts", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_identifier/accounts", "headers": [ { "name": "Accept-Version", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "page", "value": "1", "type": "query", "description": "Results are paginated. Specify current page." }, { "name": "member_is_managed_by_user", "value": "true", "type": "query", "description": "List only accounts whose member is managed by the user." }, { "name": "is_manual", "value": "true", "type": "query", "description": "List only accounts that were manually created." }, { "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_identifier", "value": "", "type": "path", "description": "Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "name": "use_case", "value": "", "type": "query", "description": "The use case associated with the member. Valid values are `PFM` and/or `MONEY_MOVEMENT`." } ] }, "docs": "This endpoint returns a list of all the accounts associated with the specified `user`.\n:::warning Account Numbers\nThis request will not return the full account number. It may return the last four digits of the account number if that information has been provided during aggregation. If you need the full account number, please refer to [List account numbers by member](https://docs.mx.com/api-reference/platform-api/reference/list-account-numbers-by-member/), [List account numbers by account](https:" }, { "info": { "name": "Create manual account", "type": "http" }, "http": { "method": "POST", "url": "https://int-api.mx.com/users/:user_identifier/accounts", "headers": [ { "name": "Accept-Version", "value": "" } ], "params": [ { "name": "user_identifier", "value": "", "type": "path", "description": "Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ], "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.\n:::warning\nYou must use the user `guid` when setting `user_identifier` in the path.\n:::\n" }, { "info": { "name": "List account numbers by account", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_identifier/accounts/:account_identifier/account_numbers", "headers": [ { "name": "Accept-Version", "value": "" } ], "params": [ { "name": "account_identifier", "value": "", "type": "path", "description": "Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "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_identifier", "value": "", "type": "path", "description": "Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "docs": "This endpoint returns a list of account numbers associated with the specified `account`." }, { "info": { "name": "Merge accounts", "type": "http" }, "http": { "method": "POST", "url": "https://int-api.mx.com/users/:user_guid/accounts/merge", "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": "Merge two or more financial accounts that an end user has identified as duplicates. \nProvide at least two account GUIDs belonging to the same user. \n:::danger\n\nThe response will return a single consolidated account. Any other accounts you provided that were not included in the response will be deleted.\nThis is a destructive action and can't be undone.\n\n:::\n" }, { "info": { "name": "List account owners by member", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_identifier/members/:member_identifier/account_owners", "headers": [ { "name": "Accept-Version", "value": "" } ], "params": [ { "name": "member_identifier", "value": "", "type": "path", "description": "Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "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_identifier", "value": "", "type": "path", "description": "Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "docs": "This endpoint returns an array with information about every account associated with a particular member." }, { "info": { "name": "List member accounts", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_identifier/members/:member_identifier/accounts", "headers": [ { "name": "Accept-Version", "value": "" } ], "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": "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_identifier", "value": "", "type": "path", "description": "Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "name": "member_identifier", "value": "", "type": "path", "description": "Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "docs": "This endpoint returns a list of all the accounts associated with the specified `member`." }, { "info": { "name": "Read member account", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_identifier/members/:member_identifier/accounts/:account_identifier", "headers": [ { "name": "Accept-Version", "value": "" } ], "params": [ { "name": "account_identifier", "value": "", "type": "path", "description": "Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "name": "member_identifier", "value": "", "type": "path", "description": "Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "name": "user_identifier", "value": "", "type": "path", "description": "Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "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://int-api.mx.com/users/:user_identifier/members/:member_identifier/accounts/:account_identifier", "headers": [ { "name": "Accept-Version", "value": "" } ], "params": [ { "name": "account_identifier", "value": "", "type": "path", "description": "Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "name": "member_identifier", "value": "", "type": "path", "description": "Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "name": "user_identifier", "value": "", "type": "path", "description": "Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ], "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`." } ] } ], "bundled": true }