{ "item": [ { "id": "a1f6e957-f675-49e4-9185-4a781e9bb4e8", "name": "authorization", "description": { "content": "", "type": "text/plain" }, "item": [], "event": [] }, { "id": "4efc7d81-a116-43f2-8b4d-b843538d24a3", "name": "accounts", "description": { "content": "The Accounts endpoints represent a user's checking, savings, mortgage, 401(k), or other types of accounts held by a financial institution.\n\nAn account belongs to a `member`, which represents the user's overall relationship with a particular financial institution. A checking account may be just one part of a larger relationship that could also include a car loan and a savings account.\n\nAccounts—and the transactions associated with them—are updated every 24 hours, unless the associated `user` is disabled.\n\nYou can also create manual accounts. Since a manual account has no credentials tied to the member, the account will never aggregate or include data from a data feed. All manual accounts are automatically created under the Manual Institution member.\n", "type": "text/plain" }, "item": [ { "id": "9832a081-ae57-4903-8468-b45792f3bf99", "name": "List accounts", "request": { "name": "List accounts", "description": { "content": "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](/api-reference/platform-api/reference/list-account-numbers-by-member/) or [List account numbers by account](/api-reference/platform-api/reference/list-account-numbers-by-account/).\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "member_is_managed_by_user", "value": "", "description": "List only accounts whose member is managed by the user." }, { "disabled": false, "key": "is_manual", "value": "", "description": "List only accounts that were manually created." }, { "disabled": false, "key": "records_per_page", "value": "", "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." }, { "disabled": false, "key": "use_case", "value": "", "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`." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "8809d052-aae4-4654-92b3-0b31840b7375", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "member_is_managed_by_user", "value": "true" }, { "key": "is_manual", "value": "true" }, { "key": "records_per_page", "value": "10" }, { "key": "use_case", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "(Required) Specifies the media type expected in the response.", "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accounts\": [\n {\n \"account_number\": \"3331261\",\n \"account_ownership\": \"INDIVIDUAL\",\n \"annuity_policy_to_date\": \"2025-12-31\",\n \"annuity_provider\": \"Metlife\",\n \"annuity_term_year\": 30,\n \"apr\": 1,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"available_credit\": 4000,\n \"balance\": 1000,\n \"cash_balance\": 2500,\n \"cash_surrender_value\": 1000,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"day_payment_is_due\": 14,\n \"death_benefit\": 1000,\n \"federal_insurance_status\": \"INSURED\",\n \"guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"id\": \"1040434698\",\n \"imported_at\": \"2015-10-13T17:57:37.000Z\",\n \"interest_rate\": 3.25,\n \"institution_code\": \"3af3685e-05d9-7060-359f-008d0755e993\",\n \"insured_name\": \"Tommy Shelby\",\n \"is_closed\": false,\n \"is_hidden\": false,\n \"is_manual\": false,\n \"last_payment\": 100,\n \"last_payment_at\": \"2023-07-25T17:14:46Z\",\n \"loan_amount\": 1000,\n \"margin_balance\": 1000,\n \"matures_on\": \"2015-10-13T17:57:37.000Z\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_id\": \"member123\",\n \"member_is_managed_by_user\": false,\n \"metadata\": \"some metadata\",\n \"minimum_balance\": 100,\n \"minimum_payment\": 10,\n \"name\": \"Test account 2\",\n \"nickname\": \"My Checking\",\n \"original_balance\": 10,\n \"pay_out_amount\": 10,\n \"payment_due_at\": \"2015-10-13T17:57:37.000Z\",\n \"payoff_balance\": 10,\n \"premium_amount\": 1,\n \"property_type\": \"VEHICLE\",\n \"routing_number\": \"68899990000000\",\n \"started_on\": \"2025-10-13T17:57:37.000Z\",\n \"statement_balance\": 1000.5,\n \"subtype\": \"MONEY_MARKET\",\n \"today_ugl_amount\": 1000.5,\n \"today_ugl_percentage\": 6.9,\n \"total_account_value\": 1,\n \"total_account_value_ugl\": 1,\n \"type\": \"CHECKING\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n },\n {\n \"account_number\": \"3331261\",\n \"account_ownership\": \"INDIVIDUAL\",\n \"annuity_policy_to_date\": \"2025-12-31\",\n \"annuity_provider\": \"Metlife\",\n \"annuity_term_year\": 30,\n \"apr\": 1,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"available_credit\": 4000,\n \"balance\": 1000,\n \"cash_balance\": 2500,\n \"cash_surrender_value\": 1000,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"day_payment_is_due\": 14,\n \"death_benefit\": 1000,\n \"federal_insurance_status\": \"INSURED\",\n \"guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"id\": \"1040434698\",\n \"imported_at\": \"2015-10-13T17:57:37.000Z\",\n \"interest_rate\": 3.25,\n \"institution_code\": \"3af3685e-05d9-7060-359f-008d0755e993\",\n \"insured_name\": \"Tommy Shelby\",\n \"is_closed\": false,\n \"is_hidden\": false,\n \"is_manual\": false,\n \"last_payment\": 100,\n \"last_payment_at\": \"2023-07-25T17:14:46Z\",\n \"loan_amount\": 1000,\n \"margin_balance\": 1000,\n \"matures_on\": \"2015-10-13T17:57:37.000Z\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_id\": \"member123\",\n \"member_is_managed_by_user\": false,\n \"metadata\": \"some metadata\",\n \"minimum_balance\": 100,\n \"minimum_payment\": 10,\n \"name\": \"Test account 2\",\n \"nickname\": \"My Checking\",\n \"original_balance\": 10,\n \"pay_out_amount\": 10,\n \"payment_due_at\": \"2015-10-13T17:57:37.000Z\",\n \"payoff_balance\": 10,\n \"premium_amount\": 1,\n \"property_type\": \"VEHICLE\",\n \"routing_number\": \"68899990000000\",\n \"started_on\": \"2025-10-13T17:57:37.000Z\",\n \"statement_balance\": 1000.5,\n \"subtype\": \"MONEY_MARKET\",\n \"today_ugl_amount\": 1000.5,\n \"today_ugl_percentage\": 6.9,\n \"total_account_value\": 1,\n \"total_account_value_ugl\": 1,\n \"type\": \"CHECKING\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "679c86cf-b378-42f3-bfc5-47a037425ee0", "name": "Create manual account", "request": { "name": "Create manual account", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"name\": \"\",\n \"account_type\": \"\",\n \"account_subtype\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"death_benefit\": \"\",\n \"interest_rate\": \"\",\n \"is_business\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"loan_amount\": \"\",\n \"metadata\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"property_type\": \"\",\n \"skip_webhook\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8ad0108f-e24d-4a19-84a4-47a49242acd4", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"name\": \"Test account 2\",\n \"account_type\": \"CHECKING\",\n \"account_subtype\": \"CHECKING\",\n \"apr\": 1,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"balance\": 1000,\n \"cash_surrender_value\": 1000,\n \"credit_limit\": 100,\n \"currency_code\": \"USD\",\n \"death_benefit\": 1000,\n \"interest_rate\": 3.25,\n \"is_business\": false,\n \"is_closed\": false,\n \"is_hidden\": false,\n \"loan_amount\": 1000,\n \"metadata\": \"some metadata\",\n \"nickname\": \"Swiss Account\",\n \"original_balance\": 10,\n \"property_type\": \"VEHICLE\",\n \"skip_webhook\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account\": {\n \"account_number\": \"3331261\",\n \"account_ownership\": \"INDIVIDUAL\",\n \"annuity_policy_to_date\": \"2025-12-31\",\n \"annuity_provider\": \"Metlife\",\n \"annuity_term_year\": 30,\n \"apr\": 1,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"available_credit\": 4000,\n \"balance\": 1000,\n \"cash_balance\": 2500,\n \"cash_surrender_value\": 1000,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"day_payment_is_due\": 14,\n \"death_benefit\": 1000,\n \"federal_insurance_status\": \"INSURED\",\n \"guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"id\": \"1040434698\",\n \"imported_at\": \"2015-10-13T17:57:37.000Z\",\n \"interest_rate\": 3.25,\n \"institution_code\": \"3af3685e-05d9-7060-359f-008d0755e993\",\n \"insured_name\": \"Tommy Shelby\",\n \"is_closed\": false,\n \"is_hidden\": false,\n \"is_manual\": false,\n \"last_payment\": 100,\n \"last_payment_at\": \"2023-07-25T17:14:46Z\",\n \"loan_amount\": 1000,\n \"margin_balance\": 1000,\n \"matures_on\": \"2015-10-13T17:57:37.000Z\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_id\": \"member123\",\n \"member_is_managed_by_user\": false,\n \"metadata\": \"some metadata\",\n \"minimum_balance\": 100,\n \"minimum_payment\": 10,\n \"name\": \"Test account 2\",\n \"nickname\": \"My Checking\",\n \"original_balance\": 10,\n \"pay_out_amount\": 10,\n \"payment_due_at\": \"2015-10-13T17:57:37.000Z\",\n \"payoff_balance\": 10,\n \"premium_amount\": 1,\n \"property_type\": \"VEHICLE\",\n \"routing_number\": \"68899990000000\",\n \"started_on\": \"2025-10-13T17:57:37.000Z\",\n \"statement_balance\": 1000.5,\n \"subtype\": \"MONEY_MARKET\",\n \"today_ugl_amount\": 1000.5,\n \"today_ugl_percentage\": 6.9,\n \"total_account_value\": 1,\n \"total_account_value_ugl\": 1,\n \"type\": \"CHECKING\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a0b6a888-e2e1-48cf-9ab5-d557a8587b12", "name": "Read account", "request": { "name": "Read account", "description": { "content": "This endpoint returns the specified `account` resource.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "accounts", ":account_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ab654792-8a45-4736-86a4-4dcb1d10de3c", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "accounts", ":account_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account\": {\n \"account_number\": \"3331261\",\n \"account_ownership\": \"INDIVIDUAL\",\n \"annuity_policy_to_date\": \"2025-12-31\",\n \"annuity_provider\": \"Metlife\",\n \"annuity_term_year\": 30,\n \"apr\": 1,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"available_credit\": 4000,\n \"balance\": 1000,\n \"cash_balance\": 2500,\n \"cash_surrender_value\": 1000,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"day_payment_is_due\": 14,\n \"death_benefit\": 1000,\n \"federal_insurance_status\": \"INSURED\",\n \"guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"id\": \"1040434698\",\n \"imported_at\": \"2015-10-13T17:57:37.000Z\",\n \"interest_rate\": 3.25,\n \"institution_code\": \"3af3685e-05d9-7060-359f-008d0755e993\",\n \"insured_name\": \"Tommy Shelby\",\n \"is_closed\": false,\n \"is_hidden\": false,\n \"is_manual\": false,\n \"last_payment\": 100,\n \"last_payment_at\": \"2023-07-25T17:14:46Z\",\n \"loan_amount\": 1000,\n \"margin_balance\": 1000,\n \"matures_on\": \"2015-10-13T17:57:37.000Z\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_id\": \"member123\",\n \"member_is_managed_by_user\": false,\n \"metadata\": \"some metadata\",\n \"minimum_balance\": 100,\n \"minimum_payment\": 10,\n \"name\": \"Test account 2\",\n \"nickname\": \"My Checking\",\n \"original_balance\": 10,\n \"pay_out_amount\": 10,\n \"payment_due_at\": \"2015-10-13T17:57:37.000Z\",\n \"payoff_balance\": 10,\n \"premium_amount\": 1,\n \"property_type\": \"VEHICLE\",\n \"routing_number\": \"68899990000000\",\n \"started_on\": \"2025-10-13T17:57:37.000Z\",\n \"statement_balance\": 1000.5,\n \"subtype\": \"MONEY_MARKET\",\n \"today_ugl_amount\": 1000.5,\n \"today_ugl_percentage\": 6.9,\n \"total_account_value\": 1,\n \"total_account_value_ugl\": 1,\n \"type\": \"CHECKING\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "40f31302-2dab-477e-af5d-c7b38ff7dc14", "name": "Delete manual account", "request": { "name": "Delete manual account", "description": { "content": "This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of `204 No Content`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "accounts", ":account_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "cbeef521-2389-4f31-9740-0fec0eeceae2", "name": "No content.", "originalRequest": { "url": { "path": [ "users", ":user_guid", "accounts", ":account_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "(Required) Specifies the media type expected in the response.", "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "ce997409-2f48-4387-9c6e-4e6317d44103", "name": "List account numbers by account", "request": { "name": "List account numbers by account", "description": { "content": "This endpoint returns a list of account numbers associated with the specified `account`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "accounts", ":account_identifier", "account_numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_identifier", "description": "(Required) Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0216693f-69b3-4638-8a62-93f155f6cb8d", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "accounts", ":account_identifier", "account_numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_identifier", "description": "(Required) Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account_numbers\": [\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_number\": \"3331261\",\n \"guid\": \"ACN-8899832e-e5b4-42cd-aa25-bbf1dc889a8f\",\n \"institution_number\": \"123\",\n \"loan_guarantor\": \"U.S. DEPARTMENT OF EDUCATION (123456)\",\n \"loan_reference_number\": \"123456789012345\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"passed_validation\": true,\n \"routing_number\": \"68899990000000\",\n \"sequence_number\": \"1-01\",\n \"transit_number\": \"12345\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n },\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_number\": \"3331261\",\n \"guid\": \"ACN-8899832e-e5b4-42cd-aa25-bbf1dc889a8f\",\n \"institution_number\": \"123\",\n \"loan_guarantor\": \"U.S. DEPARTMENT OF EDUCATION (123456)\",\n \"loan_reference_number\": \"123456789012345\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"passed_validation\": true,\n \"routing_number\": \"68899990000000\",\n \"sequence_number\": \"1-01\",\n \"transit_number\": \"12345\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "de0e5d60-c001-4c69-b399-0deeaf3eb0f1", "name": "Block an account", "request": { "name": "Block an account", "description": { "content": "This endpoint is used to delete existing data and block new data from being stored on the specified account. This may be necessary to comply with certain rules, regulations, or standards. This endpoint also:\n- Immediately and permanently deletes most data from the account object. Certain information is retained that is necessary for MX to prevent the account from being re-added.\n- Prevents MX from creating or storing any additional data associated with the account, for example transactions, holdings, statements, and so on.\n- Immediately and permanently deletes all data associated with the account, for example transactions, holdings, statements, etc.\nThis action is scoped to the member the account belongs to. This means that if the real world account is connected or reconnected via another member, the block will have no effect on that account.\nThis action cannot be taken on accounts where `is_manual` is `true`.\nObjects deleted as a result of blocking an account will issue a webhook for that object with the action set to deleted. For example, account deleted, transaction deleted, and so on. There is no special webhook or action for blocking.\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "accounts", ":account_guid", "block" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "auth": null }, "response": [ { "id": "09f9586a-409e-41bf-bded-ec4d891e0a8f", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "accounts", ":account_guid", "block" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "a663734e-a848-4a63-a81b-c6d35453e23a", "name": "Merge accounts", "request": { "name": "Merge accounts", "description": { "content": "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", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "accounts", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"account_guids\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2023f727-f338-414f-80fa-26bece9ec173", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "accounts", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"account_guids\": [\n \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"ACT-e1b1e9e7-9436-4720-a1b5-f02373433bd4\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account\": {\n \"account_number\": \"3331261\",\n \"account_ownership\": \"INDIVIDUAL\",\n \"annuity_policy_to_date\": \"2025-12-31\",\n \"annuity_provider\": \"Metlife\",\n \"annuity_term_year\": 30,\n \"apr\": 1,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"available_credit\": 4000,\n \"balance\": 1000,\n \"cash_balance\": 2500,\n \"cash_surrender_value\": 1000,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"day_payment_is_due\": 14,\n \"death_benefit\": 1000,\n \"federal_insurance_status\": \"INSURED\",\n \"guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"id\": \"1040434698\",\n \"imported_at\": \"2015-10-13T17:57:37.000Z\",\n \"interest_rate\": 3.25,\n \"institution_code\": \"3af3685e-05d9-7060-359f-008d0755e993\",\n \"insured_name\": \"Tommy Shelby\",\n \"is_closed\": false,\n \"is_hidden\": false,\n \"is_manual\": false,\n \"last_payment\": 100,\n \"last_payment_at\": \"2023-07-25T17:14:46Z\",\n \"loan_amount\": 1000,\n \"margin_balance\": 1000,\n \"matures_on\": \"2015-10-13T17:57:37.000Z\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_id\": \"member123\",\n \"member_is_managed_by_user\": false,\n \"metadata\": \"some metadata\",\n \"minimum_balance\": 100,\n \"minimum_payment\": 10,\n \"name\": \"Test account 2\",\n \"nickname\": \"My Checking\",\n \"original_balance\": 10,\n \"pay_out_amount\": 10,\n \"payment_due_at\": \"2015-10-13T17:57:37.000Z\",\n \"payoff_balance\": 10,\n \"premium_amount\": 1,\n \"property_type\": \"VEHICLE\",\n \"routing_number\": \"68899990000000\",\n \"started_on\": \"2025-10-13T17:57:37.000Z\",\n \"statement_balance\": 1000.5,\n \"subtype\": \"MONEY_MARKET\",\n \"today_ugl_amount\": 1000.5,\n \"today_ugl_percentage\": 6.9,\n \"total_account_value\": 1,\n \"total_account_value_ugl\": 1,\n \"type\": \"CHECKING\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d2f07dd0-d63c-4525-ad7e-2ee6d582fa70", "name": "List account balances by month", "request": { "name": "List account balances by month", "description": { "content": "Use this endpoint to list all monthly account balances associated with an account GUID. Setting `from_date` returns account balances starting from the set month. Setting `to_date` returns account balances ending with the set month.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "accounts", ":account_guid", "monthly_account_balances" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "from_date", "value": "", "description": "(Required) Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided." }, { "disabled": false, "key": "to_date", "value": "", "description": "(Required) 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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e6ffce74-9f7c-406d-ba7d-2f4b30a132b4", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "accounts", ":account_guid", "monthly_account_balances" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from_date", "value": "2024-02-01" }, { "key": "to_date", "value": "2024-08-28" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"monthly_account_balances\": [\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"balance\": 1000,\n \"month\": 1,\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"year\": 2023\n },\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"balance\": 1000,\n \"month\": 1,\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"year\": 2023\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "b038cbf3-37c8-4f1f-91e2-1901b8a015d2", "name": "List account numbers by member", "request": { "name": "List account numbers by member", "description": { "content": "This endpoint returns a list of account numbers associated with the specified `member`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "members", ":member_guid", "account_numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d7caac0e-c838-45fd-b6c4-4c62eff5482c", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "members", ":member_guid", "account_numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account_numbers\": [\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_number\": \"3331261\",\n \"guid\": \"ACN-8899832e-e5b4-42cd-aa25-bbf1dc889a8f\",\n \"institution_number\": \"123\",\n \"loan_guarantor\": \"U.S. DEPARTMENT OF EDUCATION (123456)\",\n \"loan_reference_number\": \"123456789012345\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"passed_validation\": true,\n \"routing_number\": \"68899990000000\",\n \"sequence_number\": \"1-01\",\n \"transit_number\": \"12345\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n },\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_number\": \"3331261\",\n \"guid\": \"ACN-8899832e-e5b4-42cd-aa25-bbf1dc889a8f\",\n \"institution_number\": \"123\",\n \"loan_guarantor\": \"U.S. DEPARTMENT OF EDUCATION (123456)\",\n \"loan_reference_number\": \"123456789012345\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"passed_validation\": true,\n \"routing_number\": \"68899990000000\",\n \"sequence_number\": \"1-01\",\n \"transit_number\": \"12345\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "021b0cb2-15e1-4822-8881-d462f61fa68a", "name": "List account owners by member", "request": { "name": "List account owners by member", "description": { "content": "This endpoint returns an array with information about every account associated with a particular member.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "account_owners" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2755f37f-aaf7-42dd-a73a-0d3842f4a6c9", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "account_owners" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account_owners\": [\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"address\": \"3541 Adrian Street\",\n \"city\": \"Middlesex\",\n \"country\": \"US\",\n \"email\": \"example@example.com\",\n \"first_name\": \"Josh\",\n \"guid\": \"ACO-63dc7714-6fc0-4aa2-a069-c06cdccd1af9\",\n \"last_name\": \"Smith\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"owner_name\": \"Josh Smith\",\n \"phone\": \"555-555-5555\",\n \"postal_code\": \"00000-0000\",\n \"state\": \"VA\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n },\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"address\": \"3541 Adrian Street\",\n \"city\": \"Middlesex\",\n \"country\": \"US\",\n \"email\": \"example@example.com\",\n \"first_name\": \"Josh\",\n \"guid\": \"ACO-63dc7714-6fc0-4aa2-a069-c06cdccd1af9\",\n \"last_name\": \"Smith\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"owner_name\": \"Josh Smith\",\n \"phone\": \"555-555-5555\",\n \"postal_code\": \"00000-0000\",\n \"state\": \"VA\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "7a02f4bc-5389-49f8-8bd7-b33025ae2583", "name": "List member accounts", "request": { "name": "List member accounts", "description": { "content": "This endpoint returns a list of all the accounts associated with the specified `member`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "member_is_managed_by_user", "value": "", "description": "List only accounts whose member is managed by the user." }, { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "025aa31e-b958-420a-85cb-ff6cd83dc8f7", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "member_is_managed_by_user", "value": "true" }, { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accounts\": [\n {\n \"account_number\": \"3331261\",\n \"account_ownership\": \"INDIVIDUAL\",\n \"annuity_policy_to_date\": \"2025-12-31\",\n \"annuity_provider\": \"Metlife\",\n \"annuity_term_year\": 30,\n \"apr\": 1,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"available_credit\": 4000,\n \"balance\": 1000,\n \"cash_balance\": 2500,\n \"cash_surrender_value\": 1000,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"day_payment_is_due\": 14,\n \"death_benefit\": 1000,\n \"federal_insurance_status\": \"INSURED\",\n \"guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"id\": \"1040434698\",\n \"imported_at\": \"2015-10-13T17:57:37.000Z\",\n \"interest_rate\": 3.25,\n \"institution_code\": \"3af3685e-05d9-7060-359f-008d0755e993\",\n \"insured_name\": \"Tommy Shelby\",\n \"is_closed\": false,\n \"is_hidden\": false,\n \"is_manual\": false,\n \"last_payment\": 100,\n \"last_payment_at\": \"2023-07-25T17:14:46Z\",\n \"loan_amount\": 1000,\n \"margin_balance\": 1000,\n \"matures_on\": \"2015-10-13T17:57:37.000Z\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_id\": \"member123\",\n \"member_is_managed_by_user\": false,\n \"metadata\": \"some metadata\",\n \"minimum_balance\": 100,\n \"minimum_payment\": 10,\n \"name\": \"Test account 2\",\n \"nickname\": \"My Checking\",\n \"original_balance\": 10,\n \"pay_out_amount\": 10,\n \"payment_due_at\": \"2015-10-13T17:57:37.000Z\",\n \"payoff_balance\": 10,\n \"premium_amount\": 1,\n \"property_type\": \"VEHICLE\",\n \"routing_number\": \"68899990000000\",\n \"started_on\": \"2025-10-13T17:57:37.000Z\",\n \"statement_balance\": 1000.5,\n \"subtype\": \"MONEY_MARKET\",\n \"today_ugl_amount\": 1000.5,\n \"today_ugl_percentage\": 6.9,\n \"total_account_value\": 1,\n \"total_account_value_ugl\": 1,\n \"type\": \"CHECKING\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n },\n {\n \"account_number\": \"3331261\",\n \"account_ownership\": \"INDIVIDUAL\",\n \"annuity_policy_to_date\": \"2025-12-31\",\n \"annuity_provider\": \"Metlife\",\n \"annuity_term_year\": 30,\n \"apr\": 1,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"available_credit\": 4000,\n \"balance\": 1000,\n \"cash_balance\": 2500,\n \"cash_surrender_value\": 1000,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"day_payment_is_due\": 14,\n \"death_benefit\": 1000,\n \"federal_insurance_status\": \"INSURED\",\n \"guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"id\": \"1040434698\",\n \"imported_at\": \"2015-10-13T17:57:37.000Z\",\n \"interest_rate\": 3.25,\n \"institution_code\": \"3af3685e-05d9-7060-359f-008d0755e993\",\n \"insured_name\": \"Tommy Shelby\",\n \"is_closed\": false,\n \"is_hidden\": false,\n \"is_manual\": false,\n \"last_payment\": 100,\n \"last_payment_at\": \"2023-07-25T17:14:46Z\",\n \"loan_amount\": 1000,\n \"margin_balance\": 1000,\n \"matures_on\": \"2015-10-13T17:57:37.000Z\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_id\": \"member123\",\n \"member_is_managed_by_user\": false,\n \"metadata\": \"some metadata\",\n \"minimum_balance\": 100,\n \"minimum_payment\": 10,\n \"name\": \"Test account 2\",\n \"nickname\": \"My Checking\",\n \"original_balance\": 10,\n \"pay_out_amount\": 10,\n \"payment_due_at\": \"2015-10-13T17:57:37.000Z\",\n \"payoff_balance\": 10,\n \"premium_amount\": 1,\n \"property_type\": \"VEHICLE\",\n \"routing_number\": \"68899990000000\",\n \"started_on\": \"2025-10-13T17:57:37.000Z\",\n \"statement_balance\": 1000.5,\n \"subtype\": \"MONEY_MARKET\",\n \"today_ugl_amount\": 1000.5,\n \"today_ugl_percentage\": 6.9,\n \"total_account_value\": 1,\n \"total_account_value_ugl\": 1,\n \"type\": \"CHECKING\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "ace34aa2-5ae3-4ccd-b989-5c7eb3995c5b", "name": "Read member account", "request": { "name": "Read member account", "description": { "content": "This endpoint allows you to read the attributes of an `account` resource.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_identifier", "description": "(Required) Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6b252f74-f18b-4fe2-9f29-54574e6fe14a", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_identifier", "description": "(Required) Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account\": {\n \"account_number\": \"3331261\",\n \"account_ownership\": \"INDIVIDUAL\",\n \"annuity_policy_to_date\": \"2025-12-31\",\n \"annuity_provider\": \"Metlife\",\n \"annuity_term_year\": 30,\n \"apr\": 1,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"available_credit\": 4000,\n \"balance\": 1000,\n \"cash_balance\": 2500,\n \"cash_surrender_value\": 1000,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"day_payment_is_due\": 14,\n \"death_benefit\": 1000,\n \"federal_insurance_status\": \"INSURED\",\n \"guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"id\": \"1040434698\",\n \"imported_at\": \"2015-10-13T17:57:37.000Z\",\n \"interest_rate\": 3.25,\n \"institution_code\": \"3af3685e-05d9-7060-359f-008d0755e993\",\n \"insured_name\": \"Tommy Shelby\",\n \"is_closed\": false,\n \"is_hidden\": false,\n \"is_manual\": false,\n \"last_payment\": 100,\n \"last_payment_at\": \"2023-07-25T17:14:46Z\",\n \"loan_amount\": 1000,\n \"margin_balance\": 1000,\n \"matures_on\": \"2015-10-13T17:57:37.000Z\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_id\": \"member123\",\n \"member_is_managed_by_user\": false,\n \"metadata\": \"some metadata\",\n \"minimum_balance\": 100,\n \"minimum_payment\": 10,\n \"name\": \"Test account 2\",\n \"nickname\": \"My Checking\",\n \"original_balance\": 10,\n \"pay_out_amount\": 10,\n \"payment_due_at\": \"2015-10-13T17:57:37.000Z\",\n \"payoff_balance\": 10,\n \"premium_amount\": 1,\n \"property_type\": \"VEHICLE\",\n \"routing_number\": \"68899990000000\",\n \"started_on\": \"2025-10-13T17:57:37.000Z\",\n \"statement_balance\": 1000.5,\n \"subtype\": \"MONEY_MARKET\",\n \"today_ugl_amount\": 1000.5,\n \"today_ugl_percentage\": 6.9,\n \"total_account_value\": 1,\n \"total_account_value_ugl\": 1,\n \"type\": \"CHECKING\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "bcd98f7c-a735-4887-9638-b0fbcec8a115", "name": "Update account by member", "request": { "name": "Update account by member", "description": { "content": "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`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_identifier", "description": "(Required) Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"account_subtype\": \"\",\n \"account_type\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"death_benefit\": \"\",\n \"interest_rate\": \"\",\n \"is_business\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"loan_amount\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"property_type\": \"\",\n \"skip_webhook\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2f16bab0-9333-497f-82cf-c124efc62c44", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_identifier", "description": "(Required) Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"account_subtype\": \"PERSONAL\",\n \"account_type\": \"CHECKING\",\n \"apr\": 5.25,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"balance\": 1000,\n \"cash_surrender_value\": 1000,\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"death_benefit\": 1000,\n \"interest_rate\": 1,\n \"is_business\": false,\n \"is_closed\": false,\n \"is_hidden\": false,\n \"loan_amount\": 1000,\n \"metadata\": \"some metadata\",\n \"name\": \"Test account 2\",\n \"nickname\": \"Swiss Account\",\n \"original_balance\": 10,\n \"property_type\": \"VEHICLE\",\n \"skip_webhook\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account\": {\n \"account_number\": \"3331261\",\n \"account_ownership\": \"INDIVIDUAL\",\n \"annuity_policy_to_date\": \"2025-12-31\",\n \"annuity_provider\": \"Metlife\",\n \"annuity_term_year\": 30,\n \"apr\": 1,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"available_credit\": 4000,\n \"balance\": 1000,\n \"cash_balance\": 2500,\n \"cash_surrender_value\": 1000,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"day_payment_is_due\": 14,\n \"death_benefit\": 1000,\n \"federal_insurance_status\": \"INSURED\",\n \"guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"id\": \"1040434698\",\n \"imported_at\": \"2015-10-13T17:57:37.000Z\",\n \"interest_rate\": 3.25,\n \"institution_code\": \"3af3685e-05d9-7060-359f-008d0755e993\",\n \"insured_name\": \"Tommy Shelby\",\n \"is_closed\": false,\n \"is_hidden\": false,\n \"is_manual\": false,\n \"last_payment\": 100,\n \"last_payment_at\": \"2023-07-25T17:14:46Z\",\n \"loan_amount\": 1000,\n \"margin_balance\": 1000,\n \"matures_on\": \"2015-10-13T17:57:37.000Z\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_id\": \"member123\",\n \"member_is_managed_by_user\": false,\n \"metadata\": \"some metadata\",\n \"minimum_balance\": 100,\n \"minimum_payment\": 10,\n \"name\": \"Test account 2\",\n \"nickname\": \"My Checking\",\n \"original_balance\": 10,\n \"pay_out_amount\": 10,\n \"payment_due_at\": \"2015-10-13T17:57:37.000Z\",\n \"payoff_balance\": 10,\n \"premium_amount\": 1,\n \"property_type\": \"VEHICLE\",\n \"routing_number\": \"68899990000000\",\n \"started_on\": \"2025-10-13T17:57:37.000Z\",\n \"statement_balance\": 1000.5,\n \"subtype\": \"MONEY_MARKET\",\n \"today_ugl_amount\": 1000.5,\n \"today_ugl_percentage\": 6.9,\n \"total_account_value\": 1,\n \"total_account_value_ugl\": 1,\n \"type\": \"CHECKING\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4e83f496-928f-4764-9839-d0439a09e60b", "name": "ach return", "description": { "content": "The features documented here are in a beta state, and this documentation is considered draft material subject to frequent change.\n\nUsing our Platform API, you can securely submit ACH Returns to reduce your ACH return rates and automate your ACH return process.\n\nYou can query the status and outcomes of your submitted ACH returns to track progress and access resolution details.\n", "type": "text/plain" }, "item": [ { "id": "26e1362d-95b2-4a1d-88d5-ec2260344d33", "name": "Read ACH Return", "request": { "name": "Read ACH Return", "description": { "content": ":::warning\nThe features documented here are in a beta state, and this documentation is considered draft material subject to frequent change.\n:::\nUse this endpoint to get an ACH return by its `guid` or `id`.\n", "type": "text/plain" }, "url": { "path": [ "ach_returns", ":ach_return_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ach_return_guid", "description": "(Required) The unique identifier (`guid`) for the ACH return. Defined by MX." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "25f744a4-00b8-40b5-b06c-c223f21feded", "name": "OK", "originalRequest": { "url": { "path": [ "ach_returns", ":ach_return_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ach_return_guid", "description": "(Required) The unique identifier (`guid`) for the ACH return. Defined by MX." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ach_return\": {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_number_last_four\": \"1234\",\n \"account_type\": \"CHECKING\",\n \"ach_initiated_at\": \"2025-02-13T18:08:00+00:00\",\n \"client_guid\": \"CLT-abcd-1234\",\n \"corrected_account_number\": null,\n \"corrected_routing_number\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"ACH-d74cb14f-fd0a-449f-991b-e0362a63d9c6\",\n \"id\": \"client_ach_return_id_1234\",\n \"institution_guid\": \"INS-34r4f44b-cfge-0f6e-3484-21f47e45tfv7\",\n \"investigation_notes\": null,\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"processing_errors\": null,\n \"resolution_code\": null,\n \"resolution_detail\": null,\n \"resolved_status_at\": null,\n \"return_code\": \"R01\",\n \"return_notes\": null,\n \"return_account_number\": null,\n \"return_routing_number\": null,\n \"return_status\": \"SUBMITTED\",\n \"returned_at\": \"2025-02-13T18:09:00+00:00\",\n \"sec_code\": \"PPD\",\n \"started_processing_at\": null,\n \"submitted_at\": null,\n \"transaction_amount\": 225.84,\n \"updated_at\": \"null\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "bcd125eb-e125-4da3-99a4-1bd7c137cfa8", "name": "List ACH Returns", "request": { "name": "List ACH Returns", "description": { "content": ":::warning\nThe features documented here are in a beta state, and this documentation is considered draft material subject to frequent change.\n:::\nUse this endpoint to get all ACH returns.\n", "type": "text/plain" }, "url": { "path": [ "ach_returns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "institution_guid", "value": "", "description": "The identifier for the institution associated with the ACH return. Defined by MX." }, { "disabled": false, "key": "returned_at", "value": "", "description": "The date and time when the return was reported by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp." }, { "disabled": false, "key": "resolved_status_at", "value": "", "description": "The date and time when the return was resolved by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp" }, { "disabled": false, "key": "return_code", "value": "", "description": "The associated ACH return code and notice of change code. See [Return Codes](/api-reference/platform-api/reference/ach-return-fields/#return-codes) for a complete list." }, { "disabled": false, "key": "return_status", "value": "", "description": "The status of the return. See [Return Statuses](/api-reference/platform-api/reference/ach-return-fields/#return-status) for a complete list." }, { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6c47b569-31d8-4bdf-ac47-d07025d7ffd1", "name": "OK", "originalRequest": { "url": { "path": [ "ach_returns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "institution_guid", "value": "" }, { "key": "returned_at", "value": "2025-02-13T18:09:00+00:00" }, { "key": "resolved_status_at", "value": "2025-02-13T18:09:00+00:00" }, { "key": "return_code", "value": "" }, { "key": "return_status", "value": "SUBMITTED" }, { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ach_returns\": [\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_number_last_four\": \"1234\",\n \"account_type\": \"CHECKING\",\n \"ach_initiated_at\": \"2025-02-13T18:08:00+00:00\",\n \"client_guid\": \"CLT-abcd-1234\",\n \"corrected_account_number\": null,\n \"corrected_routing_number\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"ACH-d74cb14f-fd0a-449f-991b-e0362a63d9c6\",\n \"id\": \"client_ach_return_id_1234\",\n \"institution_guid\": \"INS-34r4f44b-cfge-0f6e-3484-21f47e45tfv7\",\n \"investigation_notes\": null,\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"processing_errors\": null,\n \"resolution_code\": null,\n \"resolution_detail\": null,\n \"resolved_status_at\": null,\n \"return_code\": \"R01\",\n \"return_notes\": null,\n \"return_account_number\": null,\n \"return_routing_number\": null,\n \"return_status\": \"SUBMITTED\",\n \"returned_at\": \"2025-02-13T18:09:00+00:00\",\n \"sec_code\": \"PPD\",\n \"started_processing_at\": null,\n \"submitted_at\": null,\n \"transaction_amount\": 225.84,\n \"updated_at\": \"null\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n },\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_number_last_four\": \"1234\",\n \"account_type\": \"CHECKING\",\n \"ach_initiated_at\": \"2025-02-13T18:08:00+00:00\",\n \"client_guid\": \"CLT-abcd-1234\",\n \"corrected_account_number\": null,\n \"corrected_routing_number\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"ACH-d74cb14f-fd0a-449f-991b-e0362a63d9c6\",\n \"id\": \"client_ach_return_id_1234\",\n \"institution_guid\": \"INS-34r4f44b-cfge-0f6e-3484-21f47e45tfv7\",\n \"investigation_notes\": null,\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"processing_errors\": null,\n \"resolution_code\": null,\n \"resolution_detail\": null,\n \"resolved_status_at\": null,\n \"return_code\": \"R01\",\n \"return_notes\": null,\n \"return_account_number\": null,\n \"return_routing_number\": null,\n \"return_status\": \"SUBMITTED\",\n \"returned_at\": \"2025-02-13T18:09:00+00:00\",\n \"sec_code\": \"PPD\",\n \"started_processing_at\": null,\n \"submitted_at\": null,\n \"transaction_amount\": 225.84,\n \"updated_at\": \"null\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "90d4baf1-96cc-4da0-8eb5-6ff87e2097d1", "name": "Create ACH Return", "request": { "name": "Create ACH Return", "description": { "content": ":::warning\nThe features documented here are in a beta state, and this documentation is considered draft material subject to frequent change.\n:::\n\nUse this endpoint to create an ACH return in our system.\n", "type": "text/plain" }, "url": { "path": [ "ach_returns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ach_return\": {\n \"member_guid\": \"\",\n \"account_guid\": \"\",\n \"id\": \"\",\n \"user_guid\": \"\",\n \"return_code\": \"\",\n \"account_number_last_four\": \"\",\n \"ach_initiated_at\": \"\",\n \"corrected_account_number\": \"\",\n \"corrected_routing_number\": \"\",\n \"return_account_number\": \"\",\n \"return_notes\": \"\",\n \"return_routing_number\": \"\",\n \"returned_at\": \"\",\n \"sec_code\": \"\",\n \"transaction_amount\": \"\",\n \"transaction_amount_range\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "19c73f3f-eb94-49f8-8793-0e1960d4d6c2", "name": "OK", "originalRequest": { "url": { "path": [ "ach_returns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ach_return\": {\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"id\": \"client_ach_id_1234\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"return_code\": \"R01\",\n \"account_number_last_four\": \"1234\",\n \"ach_initiated_at\": \"2025-02-13T18:08:00+00:00\",\n \"corrected_account_number\": null,\n \"corrected_routing_number\": null,\n \"return_account_number\": \"null\",\n \"return_notes\": \"null\",\n \"return_routing_number\": \"null\",\n \"returned_at\": \"2025-02-13T18:09:00+00:00\",\n \"sec_code\": \"PPD\",\n \"transaction_amount\": 225.84,\n \"transaction_amount_range\": 0\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ach_return\": {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_number_last_four\": \"1234\",\n \"account_type\": \"CHECKING\",\n \"ach_initiated_at\": \"2025-02-13T18:08:00+00:00\",\n \"client_guid\": \"CLT-abcd-1234\",\n \"corrected_account_number\": null,\n \"corrected_routing_number\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"ACH-d74cb14f-fd0a-449f-991b-e0362a63d9c6\",\n \"id\": \"client_ach_return_id_1234\",\n \"institution_guid\": \"INS-34r4f44b-cfge-0f6e-3484-21f47e45tfv7\",\n \"investigation_notes\": null,\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"processing_errors\": null,\n \"resolution_code\": null,\n \"resolution_detail\": null,\n \"resolved_status_at\": null,\n \"return_code\": \"R01\",\n \"return_notes\": null,\n \"return_account_number\": null,\n \"return_routing_number\": null,\n \"return_status\": \"SUBMITTED\",\n \"returned_at\": \"2025-02-13T18:09:00+00:00\",\n \"sec_code\": \"PPD\",\n \"started_processing_at\": null,\n \"submitted_at\": null,\n \"transaction_amount\": 225.84,\n \"updated_at\": \"null\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ac32dd80-7e51-4252-ab10-50000d5daf50", "name": "budgets", "description": { "content": "Use these endpoints to create and manage budgets for your end users.\n\nYou can create a budget for a specific category or autogenerate a budget for several categories based on existing transactions.\n\nEach budget has a `category_guid`, relating to one of the [categories](docs.mx.com/api-reference/platform-api/reference/categories#default-categories-and-subcategories).\n", "type": "text/plain" }, "item": [ { "id": "59c26afa-58b3-43c8-8d13-84fb0636e0f5", "name": "Auto-generate budgets", "request": { "name": "Auto-generate budgets", "description": { "content": "This endpoint will automatically create budgets for several categories based on existing transactions; these budgets are returned as an array. Specifically, budgets will only be generated if the `user` has at least one `transaction` in a given category during each of the two previous calendar months. For example, if the request is made on March 6, and there is at least one \"Bills & Utilities\" `transaction` in both January and February, a budget will be generated for \"Bills & Utilities.\" If there are two \"Bills & Utilities\" transactions in February but none in January, no budget will be generated for that category. If budgets already exist for particular categories, new budgets will be generated and returned based on the available transactions. If one or more budgets remain unchanged, they will nevertheless be returned in the response. If no transaction data for the `user` meet the above criteria, a `422 Unprocessable Entity` error will be returned with status code 4221 along with the message, `There aren't enough transactions to automatically create any budgets`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "budgets", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "188faca5-cae4-4187-b6e7-741d57648d9c", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "budgets", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"budget\": {\n \"amount\": 153,\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"BGT-6ca0e3ef-c65e-4655-8b5a-275a3c19c21d\",\n \"is_exceeded\": true,\n \"is_off_track\": true,\n \"metadata\": \"some metadata\",\n \"name\": \"Food & Dining\",\n \"off_track_percentage\": -37138611.04117941,\n \"parent_guid\": \"amet Duis Lorem dolor dolor\",\n \"percent_spent\": 1276.34,\n \"projected_spending\": 3562.4,\n \"revision\": 561,\n \"transaction_total\": {},\n \"updated_at\": {},\n \"user_guid\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "0af3a3ef-1916-4b50-b6d3-d46b23c899e0", "name": "Create a budget", "request": { "name": "Create a budget", "description": { "content": "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.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "budgets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"budget\": {\n \"category_guid\": \"\",\n \"parent_guid\": \"\",\n \"amount\": \"\",\n \"metadata\": \"\",\n \"skip_webhook\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "37040dc8-92b0-4342-8936-c994508ee715", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "budgets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"budget\": {\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"parent_guid\": \"BGT-6be44a91-e105-f68a-4770-8c7c0a5c9778\",\n \"amount\": 1000,\n \"metadata\": \"Additional information\",\n \"skip_webhook\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"budget\": {\n \"amount\": 153,\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"BGT-6ca0e3ef-c65e-4655-8b5a-275a3c19c21d\",\n \"is_exceeded\": true,\n \"is_off_track\": true,\n \"metadata\": \"some metadata\",\n \"name\": \"Food & Dining\",\n \"off_track_percentage\": -37138611.04117941,\n \"parent_guid\": \"amet Duis Lorem dolor dolor\",\n \"percent_spent\": 1276.34,\n \"projected_spending\": 3562.4,\n \"revision\": 561,\n \"transaction_total\": {},\n \"updated_at\": {},\n \"user_guid\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b7508ef-7ad2-4e12-beb3-1deca1b44c34", "name": "List all budgets", "request": { "name": "List all budgets", "description": { "content": "List all budgets", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "budgets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "78cbee0e-10f8-4445-80bf-593e0e9ba3d6", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "budgets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"budget\": {\n \"amount\": 153,\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"BGT-6ca0e3ef-c65e-4655-8b5a-275a3c19c21d\",\n \"is_exceeded\": true,\n \"is_off_track\": true,\n \"metadata\": \"some metadata\",\n \"name\": \"Food & Dining\",\n \"off_track_percentage\": -37138611.04117941,\n \"parent_guid\": \"amet Duis Lorem dolor dolor\",\n \"percent_spent\": 1276.34,\n \"projected_spending\": 3562.4,\n \"revision\": 561,\n \"transaction_total\": {},\n \"updated_at\": {},\n \"user_guid\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "db063d10-1be0-4cf4-9b6e-d79a48585688", "name": "Read a specific budget", "request": { "name": "Read a specific budget", "description": { "content": "Read a specific budget.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "budgets", ":budget_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "budget_guid", "description": "(Required) The unique identifier for the budget. Defined by MX." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "4d885696-c56e-419d-ae18-c6a1f410a319", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "budgets", ":budget_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "budget_guid", "description": "(Required) The unique identifier for the budget. Defined by MX." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"budget\": {\n \"amount\": 153,\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"BGT-6ca0e3ef-c65e-4655-8b5a-275a3c19c21d\",\n \"is_exceeded\": true,\n \"is_off_track\": true,\n \"metadata\": \"some metadata\",\n \"name\": \"Food & Dining\",\n \"off_track_percentage\": -37138611.04117941,\n \"parent_guid\": \"amet Duis Lorem dolor dolor\",\n \"percent_spent\": 1276.34,\n \"projected_spending\": 3562.4,\n \"revision\": 561,\n \"transaction_total\": {},\n \"updated_at\": {},\n \"user_guid\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "e6364113-2258-421f-b706-9e409060169e", "name": "Update a specific budget", "request": { "name": "Update a specific budget", "description": { "content": "Update a specific budget.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "budgets", ":budget_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "budget_guid", "description": "(Required) The unique identifier for the budget. Defined by MX." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"budget\": {\n \"amount\": \"\",\n \"metadata\": \"\",\n \"skip_webhook\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "002197c8-549b-4ed4-b1de-01a5a9592659", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "budgets", ":budget_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "budget_guid", "description": "(Required) The unique identifier for the budget. Defined by MX." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"budget\": {\n \"amount\": 1000,\n \"metadata\": \"Additional information\",\n \"skip_webhook\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"budget\": {\n \"amount\": 153,\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"BGT-6ca0e3ef-c65e-4655-8b5a-275a3c19c21d\",\n \"is_exceeded\": true,\n \"is_off_track\": true,\n \"metadata\": \"some metadata\",\n \"name\": \"Food & Dining\",\n \"off_track_percentage\": -37138611.04117941,\n \"parent_guid\": \"amet Duis Lorem dolor dolor\",\n \"percent_spent\": 1276.34,\n \"projected_spending\": 3562.4,\n \"revision\": 561,\n \"transaction_total\": {},\n \"updated_at\": {},\n \"user_guid\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "585f52ed-f4f7-450b-9fb1-7c6e7b566ef0", "name": "Delete a budget", "request": { "name": "Delete a budget", "description": { "content": "Delete a budget.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "budgets", ":budget_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "budget_guid", "description": "(Required) The unique identifier for the budget. Defined by MX." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "1b2cd7eb-66db-4e0c-84fd-ac6b69797880", "name": "No content", "originalRequest": { "url": { "path": [ "users", ":user_guid", "budgets", ":budget_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "budget_guid", "description": "(Required) The unique identifier for the budget. Defined by MX." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] } ], "event": [] }, { "id": "3945a8d7-e293-44ca-b639-3c7475e1cc4d", "name": "categories", "description": { "content": "A `transaction` can have its `category` set to one of MX’s default categories or a custom category for a specific `user`. \n\nSee [Default Categories and Subcategories](docs.mx.com/api-reference/platform-api/reference/categories#default-categories-and-subcategories) for a complete list.\n", "type": "text/plain" }, "item": [ { "id": "c4dd47e6-dec0-4132-b181-75eba27550d8", "name": "List default categories", "request": { "name": "List default categories", "description": { "content": "Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.", "type": "text/plain" }, "url": { "path": [ "categories", "default" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead." } ], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6ec68909-a8b1-4a24-91ce-3a604956551f", "name": "OK", "originalRequest": { "url": { "path": [ "categories", "default" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"categories\": [\n {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"is_default\": true,\n \"is_income\": false,\n \"metadata\": \"some metadata\",\n \"name\": \"Auto Insurance\",\n \"parent_guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\"\n },\n {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"is_default\": true,\n \"is_income\": false,\n \"metadata\": \"some metadata\",\n \"name\": \"Auto Insurance\",\n \"parent_guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "66d3a9ad-fd66-4999-82f0-55c978d29ba1", "name": "Read a default category", "request": { "name": "Read a default category", "description": { "content": "Use this endpoint to read the attributes of a default category.", "type": "text/plain" }, "url": { "path": [ "categories", ":category_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "category_guid", "description": "(Required) The unique id for a `category`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e083d2c0-c023-4043-b6e2-aade53e3d340", "name": "OK", "originalRequest": { "url": { "path": [ "categories", ":category_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "category_guid", "description": "(Required) The unique id for a `category`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"category\": {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"is_default\": true,\n \"is_income\": false,\n \"metadata\": \"some metadata\",\n \"name\": \"Auto Insurance\",\n \"parent_guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "fa96d3de-961b-44b3-ae94-ec6e307ccbf7", "name": "List category totals by account", "request": { "name": "List category totals by account", "description": { "content": "Returns a list of categories that have transactions dated within the provided date range, and the total of all transactions that belong to each category.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "accounts", ":account_guid", "date_range_category_totals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "from_date", "value": "", "description": "(Required) Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided." }, { "disabled": false, "key": "to_date", "value": "", "description": "(Required) 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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "233c1125-c7f0-477e-a69d-c6572bf1d35f", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "accounts", ":account_guid", "date_range_category_totals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from_date", "value": "2024-02-01" }, { "key": "to_date", "value": "2024-08-28" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"date_range_category_totals\": [\n {\n \"category_guid\": \"CAT-bf9f3294-4c40-1677-d269-54fbc189faf3\",\n \"end_date\": 1466056800,\n \"start_date\": 1459490400,\n \"total\": 155.72,\n \"user_guid\": \"USR-d8843e3e-7153-ce05-db54-fb3241c15d94\"\n },\n {\n \"category_guid\": \"CAT-bf9f3294-4c40-1677-d269-54fbc189faf3\",\n \"end_date\": 1466056800,\n \"start_date\": 1459490400,\n \"total\": 155.72,\n \"user_guid\": \"USR-d8843e3e-7153-ce05-db54-fb3241c15d94\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "a7bb204d-4f4c-437c-a98a-f3cec7bcf273", "name": "List category totals by user", "request": { "name": "List category totals by user", "description": { "content": "Returns a list of categories that have transactions dated within the provided date range, and the total of all transactions that belong to each category.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "date_range_category_totals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "from_date", "value": "", "description": "(Required) Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided." }, { "disabled": false, "key": "to_date", "value": "", "description": "(Required) 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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b6c8e625-eb26-4fbe-9701-585bf7ae0ebf", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "date_range_category_totals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from_date", "value": "2024-02-01" }, { "key": "to_date", "value": "2024-08-28" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"date_range_category_totals\": [\n {\n \"category_guid\": \"CAT-bf9f3294-4c40-1677-d269-54fbc189faf3\",\n \"end_date\": 1466056800,\n \"start_date\": 1459490400,\n \"total\": 155.72,\n \"user_guid\": \"USR-d8843e3e-7153-ce05-db54-fb3241c15d94\"\n },\n {\n \"category_guid\": \"CAT-bf9f3294-4c40-1677-d269-54fbc189faf3\",\n \"end_date\": 1466056800,\n \"start_date\": 1459490400,\n \"total\": 155.72,\n \"user_guid\": \"USR-d8843e3e-7153-ce05-db54-fb3241c15d94\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "3ea5215d-e0b6-423e-8a1e-263192920b0b", "name": "List categories", "request": { "name": "List categories", "description": { "content": "Use this endpoint to list all categories associated with a `user`, including both default and custom categories.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "50e9a01f-16e1-4f22-97ad-06080ee6dbe9", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"categories\": [\n {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"is_default\": true,\n \"is_income\": false,\n \"metadata\": \"some metadata\",\n \"name\": \"Auto Insurance\",\n \"parent_guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\"\n },\n {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"is_default\": true,\n \"is_income\": false,\n \"metadata\": \"some metadata\",\n \"name\": \"Auto Insurance\",\n \"parent_guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "d1f3bb2d-07b7-4fec-88ae-34a5878c21c7", "name": "Create category", "request": { "name": "Create category", "description": { "content": "Use this endpoint to create a new custom category for a specific `user`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"category\": {\n \"name\": \"\",\n \"parent_guid\": \"\",\n \"metadata\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1be1162e-4659-448b-9d23-d554cee753e3", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category\": {\n \"name\": \"Online Shopping\",\n \"parent_guid\": \"CAT-aad51b46-d6f7-3da5-fd6e-492328b3023f\",\n \"metadata\": \"some metadata\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"category\": {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"is_default\": true,\n \"is_income\": false,\n \"metadata\": \"some metadata\",\n \"name\": \"Auto Insurance\",\n \"parent_guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "caba4726-97aa-4f64-bbee-c7a86a555b61", "name": "List default categories by user", "request": { "name": "List default categories by user", "description": { "content": "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.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "categories", "default" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "517b2a17-441c-4dea-be9a-5d68a37294d6", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "categories", "default" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"categories\": [\n {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"is_default\": true,\n \"is_income\": false,\n \"metadata\": \"some metadata\",\n \"name\": \"Auto Insurance\",\n \"parent_guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\"\n },\n {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"is_default\": true,\n \"is_income\": false,\n \"metadata\": \"some metadata\",\n \"name\": \"Auto Insurance\",\n \"parent_guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "d54e388c-652a-47eb-8df2-31c1f547eb3d", "name": "Delete category", "request": { "name": "Delete category", "description": { "content": "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`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "categories", ":category_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "category_guid", "description": "(Required) The unique id for a `category`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "17432d2c-de5d-4896-994e-80321ec5aeb4", "name": "No Content", "originalRequest": { "url": { "path": [ "users", ":user_guid", "categories", ":category_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "category_guid", "description": "(Required) The unique id for a `category`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "a93167ed-0d5c-4bbb-b135-9cbea75a722f", "name": "Read a custom category", "request": { "name": "Read a custom category", "description": { "content": "Use this endpoint to read the attributes of either a default category or a custom category.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "categories", ":category_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "category_guid", "description": "(Required) The unique id for a `category`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ed8de951-7ddf-4ccb-99ba-842f2ce3acde", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "categories", ":category_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "category_guid", "description": "(Required) The unique id for a `category`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"category\": {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"is_default\": true,\n \"is_income\": false,\n \"metadata\": \"some metadata\",\n \"name\": \"Auto Insurance\",\n \"parent_guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "c8509ba5-7bf9-41c2-90e8-2f6331bddf0a", "name": "Update category", "request": { "name": "Update category", "description": { "content": "Use this endpoint to update the attributes of a custom category according to its unique GUID.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "categories", ":category_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "category_guid", "description": "(Required) The unique id for a `category`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"category\": {\n \"metadata\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "281be292-549c-4e0c-816e-c152f021e390", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "categories", ":category_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "category_guid", "description": "(Required) The unique id for a `category`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": {\n \"metadata\": \"some metadata\",\n \"name\": \"Web shopping\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"category\": {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"is_default\": true,\n \"is_income\": false,\n \"metadata\": \"some metadata\",\n \"name\": \"Auto Insurance\",\n \"parent_guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "24c5b5b4-9765-4603-843a-e83ddbf72220", "name": "deprecated", "description": { "content": "", "type": "text/plain" }, "item": [], "event": [] }, { "id": "c78e0732-a5f9-41e5-a746-df83879f30fa", "name": "goals", "description": { "content": "Use these endpoints to create and manage goals for a `user`. You can also reposition goals to adjust their priority levels.\n\nEvery goal has a track type and a meta type.\n\nThe [track type](docs.mx.com/api-reference/platform-api/reference/goals/#goal-track-type) is the overall classification of the goal (debt, savings, retirement, or emergency fund) while the [meta type](docs.mx.com/api-reference/platform-api/reference/goals/#goal-meta-type) is the specific classification (like college, house, vacation, and so on).\n", "type": "text/plain" }, "item": [ { "id": "9841aac1-de30-423e-868f-11330b25d8c3", "name": "Create a goal", "request": { "name": "Create a goal", "description": { "content": "Create a goal. This endpoint accepts the optional `MX-Skip-Webhook` header and `skip_webhook` parameter.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "goals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"goal\": {\n \"account_guid\": \"\",\n \"amount\": \"\",\n \"goal_type_name\": \"\",\n \"meta_type_name\": \"\",\n \"name\": \"\",\n \"completed_at\": \"\",\n \"has_been_spent\": \"\",\n \"is_complete\": \"\",\n \"metadata\": \"\",\n \"position\": \"\",\n \"targeted_to_complete_at\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f9cda61c-6b19-41d2-bfde-e96fb327a8f1", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "goals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"goal\": {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"amount\": 4500,\n \"goal_type_name\": \"SAVE_AMOUNT\",\n \"meta_type_name\": \"VACATION\",\n \"name\": \"Save for Europe\",\n \"completed_at\": \"2025-08-15T10:30:00+00:00\",\n \"has_been_spent\": false,\n \"is_complete\": false,\n \"metadata\": \"Additional information\",\n \"position\": 3,\n \"targeted_to_complete_at\": \"2026-12-08 00:00:00.000000\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"goal\": {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"amount\": 4500,\n \"completed_at\": \"2025-08-15T10:30:00+00:00\",\n \"current_amount\": 1500,\n \"goal_type_name\": \"SAVE_AMOUNT\",\n \"guid\": \"GOL-f223463-4355-48d0-rce7-fe2rb345617c\",\n \"has_been_spent\": false,\n \"is_complete\": false,\n \"metadata\": \"Additional information\",\n \"meta_type_name\": \"VACATION\",\n \"name\": \"Save for Europe\",\n \"position\": 3,\n \"projected_to_complete_at\": \"2022-06-14T16:03:53-00:00\",\n \"targeted_to_complete_at\": \"2026-12-08 00:00:00.000000\",\n \"track_type_name\": \"SAVINGS_TRACK\",\n \"user_guid\": \"USR-11141024-90b3-1bce-cac9-c06ced52ab4c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6ef66f5-1c30-402b-89d9-6a7b3594eb7a", "name": "List goals", "request": { "name": "List goals", "description": { "content": "List all goals a user can set.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "goals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "02630635-f3bf-4b0e-b85d-d9f94ed829c0", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "goals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "(Required) Specifies the media type expected in the response.", "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"goals\": [\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"amount\": 4500,\n \"current_amount\": 1500,\n \"guid\": \"GOL-524ca5db-a2d5-44f3-b048-16de16059024\",\n \"goal_type_name\": \"SAVE_AMOUNT\",\n \"meta_type_name\": \"VACATION\",\n \"name\": \"Save for Europe\",\n \"completed_at\": \"2025-08-15T10:30:00+00:00\",\n \"has_been_spent\": false,\n \"is_complete\": false,\n \"metadata\": \"Additional information\",\n \"position\": 3,\n \"projected_to_complete_at\": \"2022-06-14T16:03:53-00:00\",\n \"targeted_to_complete_at\": \"2026-12-08 00:00:00.000000\",\n \"track_type_name\": \"SAVINGS_TRACK\",\n \"user_guid\": \"USR-11141024-90b3-1bce-cac9-c06ced52ab4c\"\n },\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"amount\": 4500,\n \"current_amount\": 1500,\n \"guid\": \"GOL-524ca5db-a2d5-44f3-b048-16de16059024\",\n \"goal_type_name\": \"SAVE_AMOUNT\",\n \"meta_type_name\": \"VACATION\",\n \"name\": \"Save for Europe\",\n \"completed_at\": \"2025-08-15T10:30:00+00:00\",\n \"has_been_spent\": false,\n \"is_complete\": false,\n \"metadata\": \"Additional information\",\n \"position\": 3,\n \"projected_to_complete_at\": \"2022-06-14T16:03:53-00:00\",\n \"targeted_to_complete_at\": \"2026-12-08 00:00:00.000000\",\n \"track_type_name\": \"SAVINGS_TRACK\",\n \"user_guid\": \"USR-11141024-90b3-1bce-cac9-c06ced52ab4c\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "b8c45b33-3ed6-4237-9d96-d561f3fc8ca1", "name": "Delete a goal", "request": { "name": "Delete a goal", "description": { "content": "Delete a goal.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "goals", ":goal_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "goal_guid", "description": "(Required) The unique identifier for a goal. Defined by MX." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "4d95e494-4840-41ab-bf0a-a74cd89d3476", "name": "No content", "originalRequest": { "url": { "path": [ "users", ":user_guid", "goals", ":goal_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "goal_guid", "description": "(Required) The unique identifier for a goal. Defined by MX." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "(Required) Specifies the media type expected in the response.", "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "6bc41f95-4dbe-4fab-b28e-044dca188163", "name": "Read a goal", "request": { "name": "Read a goal", "description": { "content": "Read a specific goal.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "goals", ":goal_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "goal_guid", "description": "(Required) The unique identifier for a goal. Defined by MX." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "08bbde8e-710d-4097-8e53-38448b85ef90", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "goals", ":goal_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "goal_guid", "description": "(Required) The unique identifier for a goal. Defined by MX." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"goal\": {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"amount\": 4500,\n \"completed_at\": \"2025-08-15T10:30:00+00:00\",\n \"current_amount\": 1500,\n \"goal_type_name\": \"SAVE_AMOUNT\",\n \"guid\": \"GOL-f223463-4355-48d0-rce7-fe2rb345617c\",\n \"has_been_spent\": false,\n \"is_complete\": false,\n \"metadata\": \"Additional information\",\n \"meta_type_name\": \"VACATION\",\n \"name\": \"Save for Europe\",\n \"position\": 3,\n \"projected_to_complete_at\": \"2022-06-14T16:03:53-00:00\",\n \"targeted_to_complete_at\": \"2026-12-08 00:00:00.000000\",\n \"track_type_name\": \"SAVINGS_TRACK\",\n \"user_guid\": \"USR-11141024-90b3-1bce-cac9-c06ced52ab4c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "8a9ac064-b3fa-4d96-ad85-3fd807facd3f", "name": "Update a goal", "request": { "name": "Update a goal", "description": { "content": "This endpoint updates a specific goal.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "goals", ":goal_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "goal_guid", "description": "(Required) The unique identifier for a goal. Defined by MX." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"goal\": {\n \"account_guid\": \"\",\n \"amount\": \"\",\n \"goal_type_name\": \"\",\n \"meta_type_name\": \"\",\n \"name\": \"\",\n \"completed_at\": \"\",\n \"has_been_spent\": \"\",\n \"is_complete\": \"\",\n \"metadata\": \"\",\n \"position\": \"\",\n \"targeted_to_complete_at\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e22c9a3c-8132-4a33-9568-b21cf5a1de51", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "goals", ":goal_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "goal_guid", "description": "(Required) The unique identifier for a goal. Defined by MX." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"goal\": {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"amount\": 4500,\n \"goal_type_name\": \"SAVE_AMOUNT\",\n \"meta_type_name\": \"VACATION\",\n \"name\": \"Save for Europe\",\n \"completed_at\": \"2025-08-15T10:30:00+00:00\",\n \"has_been_spent\": false,\n \"is_complete\": false,\n \"metadata\": \"Additional information\",\n \"position\": 3,\n \"targeted_to_complete_at\": \"2026-12-08 00:00:00.000000\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"goal\": {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"amount\": 4500,\n \"completed_at\": \"2025-08-15T10:30:00+00:00\",\n \"current_amount\": 1500,\n \"goal_type_name\": \"SAVE_AMOUNT\",\n \"guid\": \"GOL-f223463-4355-48d0-rce7-fe2rb345617c\",\n \"has_been_spent\": false,\n \"is_complete\": false,\n \"metadata\": \"Additional information\",\n \"meta_type_name\": \"VACATION\",\n \"name\": \"Save for Europe\",\n \"position\": 3,\n \"projected_to_complete_at\": \"2022-06-14T16:03:53-00:00\",\n \"targeted_to_complete_at\": \"2026-12-08 00:00:00.000000\",\n \"track_type_name\": \"SAVINGS_TRACK\",\n \"user_guid\": \"USR-11141024-90b3-1bce-cac9-c06ced52ab4c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "775b2a4a-1e27-4793-9e26-7806b8bc077c", "name": "Reposition goals", "request": { "name": "Reposition goals", "description": { "content": "This endpoint repositions goal priority levels. If one goal is set to a lower priority, then any other goals need to be adjusted accordingly.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "goals", "reposition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"goals\": [\n {\n \"guid\": \"\",\n \"position\": \"\"\n },\n {\n \"guid\": \"\",\n \"position\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3e12af92-7064-44b0-ba3f-522f47d7f70f", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "goals", "reposition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"goals\": [\n {\n \"guid\": \"GOL-97665947-235c-b213-ca25-8cf0174774f5\",\n \"position\": 1\n },\n {\n \"guid\": \"GOL-97665947-235c-b213-ca25-8cf0174774f5\",\n \"position\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"goals\": [\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"amount\": 4500,\n \"current_amount\": 1500,\n \"guid\": \"GOL-524ca5db-a2d5-44f3-b048-16de16059024\",\n \"goal_type_name\": \"SAVE_AMOUNT\",\n \"meta_type_name\": \"VACATION\",\n \"name\": \"Save for Europe\",\n \"completed_at\": \"2025-08-15T10:30:00+00:00\",\n \"has_been_spent\": false,\n \"is_complete\": false,\n \"metadata\": \"Additional information\",\n \"position\": 3,\n \"projected_to_complete_at\": \"2022-06-14T16:03:53-00:00\",\n \"targeted_to_complete_at\": \"2026-12-08 00:00:00.000000\",\n \"track_type_name\": \"SAVINGS_TRACK\",\n \"user_guid\": \"USR-11141024-90b3-1bce-cac9-c06ced52ab4c\"\n },\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"amount\": 4500,\n \"current_amount\": 1500,\n \"guid\": \"GOL-524ca5db-a2d5-44f3-b048-16de16059024\",\n \"goal_type_name\": \"SAVE_AMOUNT\",\n \"meta_type_name\": \"VACATION\",\n \"name\": \"Save for Europe\",\n \"completed_at\": \"2025-08-15T10:30:00+00:00\",\n \"has_been_spent\": false,\n \"is_complete\": false,\n \"metadata\": \"Additional information\",\n \"position\": 3,\n \"projected_to_complete_at\": \"2022-06-14T16:03:53-00:00\",\n \"targeted_to_complete_at\": \"2026-12-08 00:00:00.000000\",\n \"track_type_name\": \"SAVINGS_TRACK\",\n \"user_guid\": \"USR-11141024-90b3-1bce-cac9-c06ced52ab4c\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3dcfdf15-c668-41ec-a06b-34009d81dd49", "name": "insights", "description": { "content": "Use these endpoints to build customizable user experiences in UIs powered by our Financial Insights data.\n\nWith Financial Insights, your users will receive personalized insights based on their transaction history.\n\nWant to learn more about the product? See [Financial Insights](docs.mx.com/products/experience/insights).\n\nLooking for a guide to use these endpoints? See [Build Your Own Insights UI](docs.mx.com/products/experience/insights/integration-guides/insights-api-guide).\n", "type": "text/plain" }, "item": [ { "id": "5f6ae927-af06-405f-8f42-6b58a857ce9d", "name": "List insights by account", "request": { "name": "List insights by account", "description": { "content": "Use this endpoint to list all insights associated with an account GUID.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "accounts", ":account_guid", "insights" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "00db915f-068a-4629-91fa-6f6c835f7111", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "accounts", ":account_guid", "insights" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"insights\": [\n {\n \"active_at\": \"2022-01-07T12:00:00Z\",\n \"client_guid\": \"CLT-abcd-1234\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"cta_clicked_at\": \"2022-01-13T18:13:51Z\",\n \"description\": \"Gold's Gym charged you $36.71 more this month than normal. Did you upgrade your service?\",\n \"guid\": \"BET-abcd-1234\",\n \"has_associated_accounts\": false,\n \"has_associated_categories\": false,\n \"has_associated_merchants\": false,\n \"has_associated_scheduled_payments\": false,\n \"has_associated_transactions\": true,\n \"has_been_displayed\": true,\n \"is_dismissed\": false,\n \"micro_call_to_action\": \"Learn more\",\n \"micro_description\": \"Netflix charged you $5.00 more this month than normal.\",\n \"micro_title\": \"Price Increase\",\n \"template\": \"SubscriptionPriceIncrease\",\n \"title\": \"Price increase\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n },\n {\n \"active_at\": \"2022-01-07T12:00:00Z\",\n \"client_guid\": \"CLT-abcd-1234\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"cta_clicked_at\": \"2022-01-13T18:13:51Z\",\n \"description\": \"Gold's Gym charged you $36.71 more this month than normal. Did you upgrade your service?\",\n \"guid\": \"BET-abcd-1234\",\n \"has_associated_accounts\": false,\n \"has_associated_categories\": false,\n \"has_associated_merchants\": false,\n \"has_associated_scheduled_payments\": false,\n \"has_associated_transactions\": true,\n \"has_been_displayed\": true,\n \"is_dismissed\": false,\n \"micro_call_to_action\": \"Learn more\",\n \"micro_description\": \"Netflix charged you $5.00 more this month than normal.\",\n \"micro_title\": \"Price Increase\",\n \"template\": \"SubscriptionPriceIncrease\",\n \"title\": \"Price increase\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "eab6c12c-5739-4796-87a7-bea87ff3f11a", "name": "List all insights for a user", "request": { "name": "List all insights for a user", "description": { "content": "Use this endpoint to list all the insights associated with the user.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "insights" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1b009b6f-e466-4e96-a4c5-10870b5b407c", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "insights" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"insights\": [\n {\n \"active_at\": \"2022-01-07T12:00:00Z\",\n \"client_guid\": \"CLT-abcd-1234\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"cta_clicked_at\": \"2022-01-13T18:13:51Z\",\n \"description\": \"Gold's Gym charged you $36.71 more this month than normal. Did you upgrade your service?\",\n \"guid\": \"BET-abcd-1234\",\n \"has_associated_accounts\": false,\n \"has_associated_categories\": false,\n \"has_associated_merchants\": false,\n \"has_associated_scheduled_payments\": false,\n \"has_associated_transactions\": true,\n \"has_been_displayed\": true,\n \"is_dismissed\": false,\n \"micro_call_to_action\": \"Learn more\",\n \"micro_description\": \"Netflix charged you $5.00 more this month than normal.\",\n \"micro_title\": \"Price Increase\",\n \"template\": \"SubscriptionPriceIncrease\",\n \"title\": \"Price increase\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n },\n {\n \"active_at\": \"2022-01-07T12:00:00Z\",\n \"client_guid\": \"CLT-abcd-1234\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"cta_clicked_at\": \"2022-01-13T18:13:51Z\",\n \"description\": \"Gold's Gym charged you $36.71 more this month than normal. Did you upgrade your service?\",\n \"guid\": \"BET-abcd-1234\",\n \"has_associated_accounts\": false,\n \"has_associated_categories\": false,\n \"has_associated_merchants\": false,\n \"has_associated_scheduled_payments\": false,\n \"has_associated_transactions\": true,\n \"has_been_displayed\": true,\n \"is_dismissed\": false,\n \"micro_call_to_action\": \"Learn more\",\n \"micro_description\": \"Netflix charged you $5.00 more this month than normal.\",\n \"micro_title\": \"Price Increase\",\n \"template\": \"SubscriptionPriceIncrease\",\n \"title\": \"Price increase\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "6ca9e9be-0e71-491c-b40e-551efc5ddeef", "name": "List all categories associated with an insight", "request": { "name": "List all categories associated with an insight", "description": { "content": "Use this endpoint to list all the categories associated with the insight.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "insights", ":insight_guid", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "insight_guid", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f0b7602e-b8bd-4b12-8d52-e18e2c741c4c", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "insights", ":insight_guid", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "insight_guid", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"categories\": [\n {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"is_default\": true,\n \"is_income\": false,\n \"metadata\": \"some metadata\",\n \"name\": \"Auto Insurance\",\n \"parent_guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\"\n },\n {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"is_default\": true,\n \"is_income\": false,\n \"metadata\": \"some metadata\",\n \"name\": \"Auto Insurance\",\n \"parent_guid\": \"CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "7403e652-6b0a-49c9-80ee-f4936b368329", "name": "List all accounts associated with an insight", "request": { "name": "List all accounts associated with an insight", "description": { "content": "Use this endpoint to list all the accounts associated with the insight.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "insights", ":insight_guid", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "insight_guid", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0d90faeb-387b-41e0-9f28-ab5ae9629a0a", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "insights", ":insight_guid", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "insight_guid", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accounts\": [\n {\n \"account_number\": \"3331261\",\n \"account_ownership\": \"INDIVIDUAL\",\n \"annuity_policy_to_date\": \"2025-12-31\",\n \"annuity_provider\": \"Metlife\",\n \"annuity_term_year\": 30,\n \"apr\": 1,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"available_credit\": 4000,\n \"balance\": 1000,\n \"cash_balance\": 2500,\n \"cash_surrender_value\": 1000,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"day_payment_is_due\": 14,\n \"death_benefit\": 1000,\n \"federal_insurance_status\": \"INSURED\",\n \"guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"id\": \"1040434698\",\n \"imported_at\": \"2015-10-13T17:57:37.000Z\",\n \"interest_rate\": 3.25,\n \"institution_code\": \"3af3685e-05d9-7060-359f-008d0755e993\",\n \"insured_name\": \"Tommy Shelby\",\n \"is_closed\": false,\n \"is_hidden\": false,\n \"is_manual\": false,\n \"last_payment\": 100,\n \"last_payment_at\": \"2023-07-25T17:14:46Z\",\n \"loan_amount\": 1000,\n \"margin_balance\": 1000,\n \"matures_on\": \"2015-10-13T17:57:37.000Z\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_id\": \"member123\",\n \"member_is_managed_by_user\": false,\n \"metadata\": \"some metadata\",\n \"minimum_balance\": 100,\n \"minimum_payment\": 10,\n \"name\": \"Test account 2\",\n \"nickname\": \"My Checking\",\n \"original_balance\": 10,\n \"pay_out_amount\": 10,\n \"payment_due_at\": \"2015-10-13T17:57:37.000Z\",\n \"payoff_balance\": 10,\n \"premium_amount\": 1,\n \"property_type\": \"VEHICLE\",\n \"routing_number\": \"68899990000000\",\n \"started_on\": \"2025-10-13T17:57:37.000Z\",\n \"statement_balance\": 1000.5,\n \"subtype\": \"MONEY_MARKET\",\n \"today_ugl_amount\": 1000.5,\n \"today_ugl_percentage\": 6.9,\n \"total_account_value\": 1,\n \"total_account_value_ugl\": 1,\n \"type\": \"CHECKING\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n },\n {\n \"account_number\": \"3331261\",\n \"account_ownership\": \"INDIVIDUAL\",\n \"annuity_policy_to_date\": \"2025-12-31\",\n \"annuity_provider\": \"Metlife\",\n \"annuity_term_year\": 30,\n \"apr\": 1,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"available_credit\": 4000,\n \"balance\": 1000,\n \"cash_balance\": 2500,\n \"cash_surrender_value\": 1000,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"day_payment_is_due\": 14,\n \"death_benefit\": 1000,\n \"federal_insurance_status\": \"INSURED\",\n \"guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"id\": \"1040434698\",\n \"imported_at\": \"2015-10-13T17:57:37.000Z\",\n \"interest_rate\": 3.25,\n \"institution_code\": \"3af3685e-05d9-7060-359f-008d0755e993\",\n \"insured_name\": \"Tommy Shelby\",\n \"is_closed\": false,\n \"is_hidden\": false,\n \"is_manual\": false,\n \"last_payment\": 100,\n \"last_payment_at\": \"2023-07-25T17:14:46Z\",\n \"loan_amount\": 1000,\n \"margin_balance\": 1000,\n \"matures_on\": \"2015-10-13T17:57:37.000Z\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_id\": \"member123\",\n \"member_is_managed_by_user\": false,\n \"metadata\": \"some metadata\",\n \"minimum_balance\": 100,\n \"minimum_payment\": 10,\n \"name\": \"Test account 2\",\n \"nickname\": \"My Checking\",\n \"original_balance\": 10,\n \"pay_out_amount\": 10,\n \"payment_due_at\": \"2015-10-13T17:57:37.000Z\",\n \"payoff_balance\": 10,\n \"premium_amount\": 1,\n \"property_type\": \"VEHICLE\",\n \"routing_number\": \"68899990000000\",\n \"started_on\": \"2025-10-13T17:57:37.000Z\",\n \"statement_balance\": 1000.5,\n \"subtype\": \"MONEY_MARKET\",\n \"today_ugl_amount\": 1000.5,\n \"today_ugl_percentage\": 6.9,\n \"total_account_value\": 1,\n \"total_account_value_ugl\": 1,\n \"type\": \"CHECKING\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "5ca26c6a-039a-4f40-a8a7-06dd1e1ff19f", "name": "List all merchants associated with an insight", "request": { "name": "List all merchants associated with an insight", "description": { "content": "Use this endpoint to list all the merchants associated with the insight.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "insights", ":insight_guid", "merchants" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "insight_guid", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "52f99571-5167-4293-96f2-1158b905f526", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "insights", ":insight_guid", "merchants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "insight_guid", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"merchants\": [\n {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b\",\n \"logo_url\": \"https://s3.amazonaws.com/MD_Assets/merchant_logos/comcast.png\",\n \"name\": \"Comcast\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"website_url\": \"https://www.example.com\"\n },\n {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b\",\n \"logo_url\": \"https://s3.amazonaws.com/MD_Assets/merchant_logos/comcast.png\",\n \"name\": \"Comcast\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"website_url\": \"https://www.example.com\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "685bd5b9-4f99-4605-a8b1-8b4c58b632b9", "name": "List all scheduled payments associated with an insight", "request": { "name": "List all scheduled payments associated with an insight", "description": { "content": "Use this endpoint to list all the scheduled payments associated with the insight.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "insights", ":insight_guid", "scheduled_payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "insight_guid", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1dad53ae-7a85-4375-bd6f-0a4ebaaec81e", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "insights", ":insight_guid", "scheduled_payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "insight_guid", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"scheduled_payments\": [\n {\n \"amount\": 61.11,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"description\": \"Netflix\",\n \"guid\": \"SPA-c76e4a85-b2c4-4335-82b7-8f8b8f28c35a\",\n \"is_completed\": false,\n \"is_recurring\": true,\n \"merchant_guid\": \"MCH-b8a2624c-2176-59ec-c150-37854bc38aa8\",\n \"occurs_on\": \"2022-01-15\",\n \"recurrence_day\": 15,\n \"recurrence_type\": \"EVERY_MONTH\",\n \"transaction_type\": \"DEBIT\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n },\n {\n \"amount\": 61.11,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"description\": \"Netflix\",\n \"guid\": \"SPA-c76e4a85-b2c4-4335-82b7-8f8b8f28c35a\",\n \"is_completed\": false,\n \"is_recurring\": true,\n \"merchant_guid\": \"MCH-b8a2624c-2176-59ec-c150-37854bc38aa8\",\n \"occurs_on\": \"2022-01-15\",\n \"recurrence_day\": 15,\n \"recurrence_type\": \"EVERY_MONTH\",\n \"transaction_type\": \"DEBIT\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "d47b6f1f-b962-4879-bb30-06950fd1dce4", "name": "List all transactions associated with an insight", "request": { "name": "List all transactions associated with an insight", "description": { "content": "Use this endpoint to list all the transactions associated with the insight.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "insights", ":insight_guid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "insight_guid", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "66b1c6fb-9bcf-4353-8592-50262f3296c9", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "insights", ":insight_guid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "insight_guid", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transactions\": [\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_id\": \"account123\",\n \"amount\": 61.11,\n \"category\": \"Paycheck\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"check_number_string\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"currency_code\": \"USD\",\n \"date\": \"2024-12-20\",\n \"description\": \"MX Technologies Payroll\",\n \"extended_transaction_type\": null,\n \"guid\": \"TRN-429ad9fe-a1d2-4559-8590-885b2603f0e1\",\n \"id\": \"1734681600000-178fa8095c154a55b9172f977b4c5f9a-0\",\n \"is_bill_pay\": false,\n \"is_direct_deposit\": false,\n \"is_expense\": false,\n \"is_fee\": false,\n \"is_income\": true,\n \"is_international\": false,\n \"is_manual\": false,\n \"is_overdraft_fee\": false,\n \"is_payroll_advance\": false,\n \"is_recurring\": null,\n \"is_subscription\": false,\n \"latitude\": null,\n \"localized_description\": \"This is a localized_description\",\n \"localized_memo\": \"This is a localized_memo\",\n \"longitude\": null,\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_is_managed_by_user\": true,\n \"memo\": \"Transactions\",\n \"merchant_category_code\": null,\n \"merchant_guid\": \"MCH-8cc3b01a-1c52-47d4-970d-30f8ee5566f1\",\n \"merchant_location_guid\": null,\n \"metadata\": \"some metadata\",\n \"original_description\": \"MX TECHNOLOGIES PAYMENT\",\n \"posted_at\": \"2024-12-20T12:00:00Z\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"Income\",\n \"transacted_at\": \"2024-12-20T12:00:00Z\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n },\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_id\": \"account123\",\n \"amount\": 61.11,\n \"category\": \"Paycheck\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"check_number_string\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"currency_code\": \"USD\",\n \"date\": \"2024-12-20\",\n \"description\": \"MX Technologies Payroll\",\n \"extended_transaction_type\": null,\n \"guid\": \"TRN-429ad9fe-a1d2-4559-8590-885b2603f0e1\",\n \"id\": \"1734681600000-178fa8095c154a55b9172f977b4c5f9a-0\",\n \"is_bill_pay\": false,\n \"is_direct_deposit\": false,\n \"is_expense\": false,\n \"is_fee\": false,\n \"is_income\": true,\n \"is_international\": false,\n \"is_manual\": false,\n \"is_overdraft_fee\": false,\n \"is_payroll_advance\": false,\n \"is_recurring\": null,\n \"is_subscription\": false,\n \"latitude\": null,\n \"localized_description\": \"This is a localized_description\",\n \"localized_memo\": \"This is a localized_memo\",\n \"longitude\": null,\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_is_managed_by_user\": true,\n \"memo\": \"Transactions\",\n \"merchant_category_code\": null,\n \"merchant_guid\": \"MCH-8cc3b01a-1c52-47d4-970d-30f8ee5566f1\",\n \"merchant_location_guid\": null,\n \"metadata\": \"some metadata\",\n \"original_description\": \"MX TECHNOLOGIES PAYMENT\",\n \"posted_at\": \"2024-12-20T12:00:00Z\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"Income\",\n \"transacted_at\": \"2024-12-20T12:00:00Z\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "ed001404-0a42-42e2-bad6-d2d07020cfee", "name": "Read insight", "request": { "name": "Read insight", "description": { "content": "Use this endpoint to read the attributes of an insight according to its unique GUID.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "insights", ":insight_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "insight_guid", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f0f97ada-012b-435b-b36c-f8aff1723cdb", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "insights", ":insight_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "insight_guid", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"insight\": {\n \"active_at\": \"2022-01-07T12:00:00Z\",\n \"client_guid\": \"CLT-abcd-1234\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"cta_clicked_at\": \"2022-01-13T18:13:51Z\",\n \"description\": \"Gold's Gym charged you $36.71 more this month than normal. Did you upgrade your service?\",\n \"guid\": \"BET-abcd-1234\",\n \"has_associated_accounts\": false,\n \"has_associated_categories\": false,\n \"has_associated_merchants\": false,\n \"has_associated_scheduled_payments\": false,\n \"has_associated_transactions\": true,\n \"has_been_displayed\": true,\n \"is_dismissed\": false,\n \"micro_call_to_action\": \"Learn more\",\n \"micro_description\": \"Netflix charged you $5.00 more this month than normal.\",\n \"micro_title\": \"Price Increase\",\n \"template\": \"SubscriptionPriceIncrease\",\n \"title\": \"Price increase\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "bb510f01-a6c8-450c-a929-bbf971bd46d8", "name": "Update insight", "request": { "name": "Update insight", "description": { "content": "Use this endpoint to update the attributes of an insight according to its unique GUID.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "insights", ":insight_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "insight_guid", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"insight\": {\n \"has_been_displayed\": \"\",\n \"is_dismissed\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1117d5e4-e2d0-4a7b-b0fd-18cc327cf384", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "insights", ":insight_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "insight_guid", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"insight\": {\n \"has_been_displayed\": false,\n \"is_dismissed\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"active_at\": \"2022-01-07T12:00:00Z\",\n \"client_guid\": \"CLT-abcd-1234\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"cta_clicked_at\": \"2022-01-13T18:13:51Z\",\n \"description\": \"Gold's Gym charged you $36.71 more this month than normal. Did you upgrade your service?\",\n \"guid\": \"BET-abcd-1234\",\n \"has_associated_accounts\": false,\n \"has_associated_categories\": false,\n \"has_associated_merchants\": false,\n \"has_associated_scheduled_payments\": false,\n \"has_associated_transactions\": true,\n \"has_been_displayed\": true,\n \"is_dismissed\": false,\n \"micro_call_to_action\": \"Learn more\",\n \"micro_description\": \"Netflix charged you $5.00 more this month than normal.\",\n \"micro_title\": \"Price Increase\",\n \"template\": \"SubscriptionPriceIncrease\",\n \"title\": \"Price increase\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb56bd72-ae92-4748-87cb-997fff3e58f9", "name": "List insights by transaction", "request": { "name": "List insights by transaction", "description": { "content": "Use this endpoint to list all insights associated with a transaction GUID.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "transactions", ":transaction_guid", "insights" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "22ac23fb-089a-497b-bcfb-a5beb45613e7", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "transactions", ":transaction_guid", "insights" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"insights\": [\n {\n \"active_at\": \"2022-01-07T12:00:00Z\",\n \"client_guid\": \"CLT-abcd-1234\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"cta_clicked_at\": \"2022-01-13T18:13:51Z\",\n \"description\": \"Gold's Gym charged you $36.71 more this month than normal. Did you upgrade your service?\",\n \"guid\": \"BET-abcd-1234\",\n \"has_associated_accounts\": false,\n \"has_associated_categories\": false,\n \"has_associated_merchants\": false,\n \"has_associated_scheduled_payments\": false,\n \"has_associated_transactions\": true,\n \"has_been_displayed\": true,\n \"is_dismissed\": false,\n \"micro_call_to_action\": \"Learn more\",\n \"micro_description\": \"Netflix charged you $5.00 more this month than normal.\",\n \"micro_title\": \"Price Increase\",\n \"template\": \"SubscriptionPriceIncrease\",\n \"title\": \"Price increase\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n },\n {\n \"active_at\": \"2022-01-07T12:00:00Z\",\n \"client_guid\": \"CLT-abcd-1234\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"cta_clicked_at\": \"2022-01-13T18:13:51Z\",\n \"description\": \"Gold's Gym charged you $36.71 more this month than normal. Did you upgrade your service?\",\n \"guid\": \"BET-abcd-1234\",\n \"has_associated_accounts\": false,\n \"has_associated_categories\": false,\n \"has_associated_merchants\": false,\n \"has_associated_scheduled_payments\": false,\n \"has_associated_transactions\": true,\n \"has_been_displayed\": true,\n \"is_dismissed\": false,\n \"micro_call_to_action\": \"Learn more\",\n \"micro_description\": \"Netflix charged you $5.00 more this month than normal.\",\n \"micro_title\": \"Price Increase\",\n \"template\": \"SubscriptionPriceIncrease\",\n \"title\": \"Price increase\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] } ], "event": [] }, { "id": "88aeeaa2-9830-415f-b1f0-bb0f8d814078", "name": "institutions", "description": { "content": "Institutions represent a financial institution.\n\nA single real-world financial institution may have several `institution` objects on the MX platform.\n\nFor example, the mortgage division of a financial institution might use a separate system than its everyday banking division, which is different from its credit card division.\n\nFor more info, see [Institutions Overview](docs.mx.com/api-reference/reference/institutions).\n", "type": "text/plain" }, "item": [ { "id": "cb1dd444-e3d2-4a96-95dc-437d92f7eae6", "name": "List institutions", "request": { "name": "List institutions", "description": { "content": "Lists financial institutions available through the MX platform. This endpoint has been updated in `v20250224` to enhance search and filtering capabilities based on the products supported by each institution.", "type": "text/plain" }, "url": { "path": [ "institutions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "name", "value": "", "description": "This will list only institutions in which the appended string appears." }, { "disabled": false, "key": "iso_country_code", "value": "", "description": "An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico)." }, { "disabled": false, "key": "iso_country_code", "value": "", "description": "An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico)." }, { "disabled": false, "key": "include_blocked_institutions", "value": "false", "description": "When set to `true`, returns all institutions regardless of their operational status. When `false` or omitted, only returns institutions that are currently operational." }, { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." }, { "disabled": false, "key": "supported_products[]", "value": "", "description": "Filters institutions that support specific products. Values may include account_verification, identity_verification, transactions, transaction_history, statements, investments.\n\nFor example, institutions that support account_verification and statements, `?supported_products[]=account_verification&supported_products[]=statements`." }, { "disabled": false, "key": "supported_products[]", "value": "", "description": "Filters institutions that support specific products. Values may include account_verification, identity_verification, transactions, transaction_history, statements, investments.\n\nFor example, institutions that support account_verification and statements, `?supported_products[]=account_verification&supported_products[]=statements`." } ], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b14e393e-f16f-4243-81ad-c853df05756b", "name": "OK", "originalRequest": { "url": { "path": [ "institutions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "name", "value": "mxbank" }, { "key": "iso_country_code", "value": "US" }, { "key": "iso_country_code", "value": "CA" }, { "key": "include_blocked_institutions", "value": "true" }, { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" }, { "key": "supported_products[]", "value": "account_verification" }, { "key": "supported_products[]", "value": "statements" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"institutions\": [\n {\n \"client_status\": \"AVAILABLE\",\n \"code\": \"mxbank\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"forgot_password_url\": \"https://example.url.mxbank.com/forgot-password\",\n \"forgot_username_url\": \"https://example.url.mxbank.com/forgot-username\",\n \"guid\": \"INS-1572a04c-912b-59bf-5841-332c7dfafaef\",\n \"instructional_text\": \"Some instructional text for end users.\",\n \"instructional_text_steps\": [\n \"Step 1: Do this.\",\n \"Step 2: Do that.\"\n ],\n \"is_disabled_by_client\": false,\n \"is_hidden\": true,\n \"iso_country_code\": \"US\",\n \"medium_logo_url\": \"https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png\",\n \"name\": \"MX Bank\",\n \"small_logo_url\": \"https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png\",\n \"status\": \"OPERATIONAL\",\n \"supported_products\": {},\n \"supports_oauth\": true,\n \"supports_tax_document\": true,\n \"trouble_signing_in_url\": \"https://example.url.mxbank.com/login-trouble\",\n \"url\": \"https://www.mxbank.com\"\n },\n {\n \"client_status\": \"AVAILABLE\",\n \"code\": \"mxbank\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"forgot_password_url\": \"https://example.url.mxbank.com/forgot-password\",\n \"forgot_username_url\": \"https://example.url.mxbank.com/forgot-username\",\n \"guid\": \"INS-1572a04c-912b-59bf-5841-332c7dfafaef\",\n \"instructional_text\": \"Some instructional text for end users.\",\n \"instructional_text_steps\": [\n \"Step 1: Do this.\",\n \"Step 2: Do that.\"\n ],\n \"is_disabled_by_client\": false,\n \"is_hidden\": true,\n \"iso_country_code\": \"US\",\n \"medium_logo_url\": \"https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png\",\n \"name\": \"MX Bank\",\n \"small_logo_url\": \"https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png\",\n \"status\": \"OPERATIONAL\",\n \"supported_products\": {},\n \"supports_oauth\": true,\n \"supports_tax_document\": true,\n \"trouble_signing_in_url\": \"https://example.url.mxbank.com/login-trouble\",\n \"url\": \"https://www.mxbank.com\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "e264d402-16d3-4635-888b-6d7a1bce8510", "name": "List favorite institutions", "request": { "name": "List favorite institutions", "description": { "content": "This endpoint returns a paginated list containing institutions that have been set as favorites, sorted by popularity. Please contact MX to set a list of favorites.", "type": "text/plain" }, "url": { "path": [ "institutions", "favorites" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "iso_country_code", "value": "", "description": "An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico)." }, { "disabled": false, "key": "iso_country_code", "value": "", "description": "An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico)." }, { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "48171d64-67c2-4212-b813-aa60eee97519", "name": "OK", "originalRequest": { "url": { "path": [ "institutions", "favorites" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "iso_country_code", "value": "US" }, { "key": "iso_country_code", "value": "CA" }, { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"institutions\": [\n {\n \"client_status\": \"AVAILABLE\",\n \"code\": \"mxbank\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"forgot_password_url\": \"https://example.url.mxbank.com/forgot-password\",\n \"forgot_username_url\": \"https://example.url.mxbank.com/forgot-username\",\n \"guid\": \"INS-1572a04c-912b-59bf-5841-332c7dfafaef\",\n \"instructional_text\": \"Some instructional text for end users.\",\n \"instructional_text_steps\": [\n \"Step 1: Do this.\",\n \"Step 2: Do that.\"\n ],\n \"is_disabled_by_client\": false,\n \"is_hidden\": true,\n \"iso_country_code\": \"US\",\n \"medium_logo_url\": \"https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png\",\n \"name\": \"MX Bank\",\n \"small_logo_url\": \"https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png\",\n \"status\": \"OPERATIONAL\",\n \"supported_products\": {},\n \"supports_oauth\": true,\n \"supports_tax_document\": true,\n \"trouble_signing_in_url\": \"https://example.url.mxbank.com/login-trouble\",\n \"url\": \"https://www.mxbank.com\"\n },\n {\n \"client_status\": \"AVAILABLE\",\n \"code\": \"mxbank\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"forgot_password_url\": \"https://example.url.mxbank.com/forgot-password\",\n \"forgot_username_url\": \"https://example.url.mxbank.com/forgot-username\",\n \"guid\": \"INS-1572a04c-912b-59bf-5841-332c7dfafaef\",\n \"instructional_text\": \"Some instructional text for end users.\",\n \"instructional_text_steps\": [\n \"Step 1: Do this.\",\n \"Step 2: Do that.\"\n ],\n \"is_disabled_by_client\": false,\n \"is_hidden\": true,\n \"iso_country_code\": \"US\",\n \"medium_logo_url\": \"https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png\",\n \"name\": \"MX Bank\",\n \"small_logo_url\": \"https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png\",\n \"status\": \"OPERATIONAL\",\n \"supported_products\": {},\n \"supports_oauth\": true,\n \"supports_tax_document\": true,\n \"trouble_signing_in_url\": \"https://example.url.mxbank.com/login-trouble\",\n \"url\": \"https://www.mxbank.com\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "768cd817-ebe8-43f1-9aad-655414bafad9", "name": "Read institution", "request": { "name": "Read institution", "description": { "content": "This endpoint returns information about the institution specified by `institution_code`. The `v20250224` update enhances the granularity of the information provided about the services and products supported by the institution.", "type": "text/plain" }, "url": { "path": [ "institutions", ":institution_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "institution_code", "description": "(Required) A unique identifier for each institution, defined by MX." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2b716550-5160-416f-94a5-45040a4f2b44", "name": "OK", "originalRequest": { "url": { "path": [ "institutions", ":institution_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "institution_code", "description": "(Required) A unique identifier for each institution, defined by MX." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"institution\": {\n \"client_status\": \"AVAILABLE\",\n \"code\": \"mxbank\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"forgot_password_url\": \"https://example.url.mxbank.com/forgot-password\",\n \"forgot_username_url\": \"https://example.url.mxbank.com/forgot-username\",\n \"guid\": \"INS-1572a04c-912b-59bf-5841-332c7dfafaef\",\n \"instructional_text\": \"Some instructional text for end users.\",\n \"instructional_text_steps\": [\n \"Step 1: Do this.\",\n \"Step 2: Do that.\"\n ],\n \"is_disabled_by_client\": false,\n \"is_hidden\": true,\n \"iso_country_code\": \"US\",\n \"medium_logo_url\": \"https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png\",\n \"name\": \"MX Bank\",\n \"small_logo_url\": \"https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png\",\n \"status\": \"OPERATIONAL\",\n \"supported_products\": {},\n \"supports_oauth\": true,\n \"supports_tax_document\": true,\n \"trouble_signing_in_url\": \"https://example.url.mxbank.com/login-trouble\",\n \"url\": \"https://www.mxbank.com\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "85159545-07da-4024-b232-e6b2e435fbf3", "name": "List institution credentials", "request": { "name": "List institution credentials", "description": { "content": "Use this endpoint to see which credentials will be needed to create a member for a specific institution.\n\nPassing an invalid `institution_identifier` returns a `404`.\n", "type": "text/plain" }, "url": { "path": [ "institutions", ":institution_identifier", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "institution_identifier", "description": "(Required) The identifier for the institution. For this identifier, use either the `institution_code` or the institution `guid`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c78bc8ce-6fe9-438c-b21d-931605b382e2", "name": "OK", "originalRequest": { "url": { "path": [ "institutions", ":institution_identifier", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "institution_identifier", "description": "(Required) The identifier for the institution. For this identifier, use either the `institution_code` or the institution `guid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"credentials\": [\n {\n \"display_order\": 1,\n \"field_name\": \"LOGIN\",\n \"field_type\": \"TEXT\",\n \"guid\": \"CRD-1ec152cd-e628-e81a-e852-d1e7104624da\",\n \"label\": \"Username\",\n \"type\": \"TEXT\"\n },\n {\n \"display_order\": 1,\n \"field_name\": \"LOGIN\",\n \"field_type\": \"TEXT\",\n \"guid\": \"CRD-1ec152cd-e628-e81a-e852-d1e7104624da\",\n \"label\": \"Username\",\n \"type\": \"TEXT\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] } ], "event": [] }, { "id": "6b82a214-c39c-4ba2-9e62-72ef544c426b", "name": "investment holdings", "description": { "content": "Investment Data Enhancement lets you connect to an end user's financial institution and retrieve cleansed and enhanced investment data. By combining investment data with retail banking information, you get comprehensive insights into customer financial behaviors, risk tolerance, and investment strategies.\n\nYou can [read a user's holding](docs.mx.com/api-reference/platform-api/reference/read-holding), [list all their holdings](docs.mx.com/api-reference/platform-api/reference/list-holdings), or list their holdings by [account](docs.mx.com/api-reference/platform-api/reference/list-holdings-by-account) or [member](docs.mx.com/api-reference/platform-api/reference/list-holdings-by-member).\n\nYou can also [deactivate a user](docs.mx.com/api-reference/platform-api/reference/deactivate-user) from the Investment Data Enhancement. This is non-billable.\n", "type": "text/plain" }, "item": [ { "id": "d4647c5c-447f-4aa1-8420-e36dec957626", "name": "List holdings by member", "request": { "name": "List holdings by member", "description": { "content": "This endpoint lists all holdings associated with the specified member.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "members", ":member_guid", "investment_holdings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1d0e8a8b-bd89-4572-8d28-37e6cfb26b22", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "members", ":member_guid", "investment_holdings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"investment_holdings\": [\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"cost_basis\": 827,\n \"coupon_yield\": null,\n \"currency_code\": \"USD\",\n \"current_price\": 15,\n \"daily_change\": 2.5,\n \"description\": \"Guggenheim Defensive Equity ETF\",\n \"expiration\": null,\n \"face_value\": 1000,\n \"frequency\": \"ANNUALLY\",\n \"guid\": \"HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2\",\n \"market_value\": 989.5,\n \"maturity_date\": null,\n \"percentage_change\": 0.2,\n \"purchase_price\": 26.3,\n \"quantity\": \"5000.0\",\n \"rate\": null,\n \"strike_price\": null,\n \"symbol\": \"DEF\",\n \"term\": null,\n \"today_ugl_amount\": 200,\n \"today_ugl_percentage\": 0.27,\n \"total_ugl_amount\": 20000,\n \"total_ugl_percentage\": 26.67,\n \"unvested_quantity\": null,\n \"unvested_value\": null,\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"vested_quantity\": null,\n \"vested_value\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"current_price_as_of\": \"2023-11-06T00:00:00Z\",\n \"issue_date\": \"2015-08-15\",\n \"vesting_start_date\": null,\n \"vesting_end_date\": null,\n \"put_or_call\": null,\n \"holding_type\": \"MUTUAL_FUND\",\n \"term_unit\": null\n },\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"cost_basis\": 827,\n \"coupon_yield\": null,\n \"currency_code\": \"USD\",\n \"current_price\": 15,\n \"daily_change\": 2.5,\n \"description\": \"Guggenheim Defensive Equity ETF\",\n \"expiration\": null,\n \"face_value\": 1000,\n \"frequency\": \"ANNUALLY\",\n \"guid\": \"HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2\",\n \"market_value\": 989.5,\n \"maturity_date\": null,\n \"percentage_change\": 0.2,\n \"purchase_price\": 26.3,\n \"quantity\": \"5000.0\",\n \"rate\": null,\n \"strike_price\": null,\n \"symbol\": \"DEF\",\n \"term\": null,\n \"today_ugl_amount\": 200,\n \"today_ugl_percentage\": 0.27,\n \"total_ugl_amount\": 20000,\n \"total_ugl_percentage\": 26.67,\n \"unvested_quantity\": null,\n \"unvested_value\": null,\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"vested_quantity\": null,\n \"vested_value\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"current_price_as_of\": \"2023-11-06T00:00:00Z\",\n \"issue_date\": \"2015-08-15\",\n \"vesting_start_date\": null,\n \"vesting_end_date\": null,\n \"put_or_call\": null,\n \"holding_type\": \"MUTUAL_FUND\",\n \"term_unit\": null\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "3e655676-a73d-4ec8-9d97-b914ac20e74c", "name": "List holdings by user", "request": { "name": "List holdings by user", "description": { "content": "This endpoint lists all holdings associated with the user across all accounts.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "investment_holdings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0cd768c5-a47c-42e6-90e6-18660c781ed4", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "investment_holdings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"investment_holdings\": [\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"cost_basis\": 827,\n \"coupon_yield\": null,\n \"currency_code\": \"USD\",\n \"current_price\": 15,\n \"daily_change\": 2.5,\n \"description\": \"Guggenheim Defensive Equity ETF\",\n \"expiration\": null,\n \"face_value\": 1000,\n \"frequency\": \"ANNUALLY\",\n \"guid\": \"HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2\",\n \"market_value\": 989.5,\n \"maturity_date\": null,\n \"percentage_change\": 0.2,\n \"purchase_price\": 26.3,\n \"quantity\": \"5000.0\",\n \"rate\": null,\n \"strike_price\": null,\n \"symbol\": \"DEF\",\n \"term\": null,\n \"today_ugl_amount\": 200,\n \"today_ugl_percentage\": 0.27,\n \"total_ugl_amount\": 20000,\n \"total_ugl_percentage\": 26.67,\n \"unvested_quantity\": null,\n \"unvested_value\": null,\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"vested_quantity\": null,\n \"vested_value\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"current_price_as_of\": \"2023-11-06T00:00:00Z\",\n \"issue_date\": \"2015-08-15\",\n \"vesting_start_date\": null,\n \"vesting_end_date\": null,\n \"put_or_call\": null,\n \"holding_type\": \"MUTUAL_FUND\",\n \"term_unit\": null\n },\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"cost_basis\": 827,\n \"coupon_yield\": null,\n \"currency_code\": \"USD\",\n \"current_price\": 15,\n \"daily_change\": 2.5,\n \"description\": \"Guggenheim Defensive Equity ETF\",\n \"expiration\": null,\n \"face_value\": 1000,\n \"frequency\": \"ANNUALLY\",\n \"guid\": \"HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2\",\n \"market_value\": 989.5,\n \"maturity_date\": null,\n \"percentage_change\": 0.2,\n \"purchase_price\": 26.3,\n \"quantity\": \"5000.0\",\n \"rate\": null,\n \"strike_price\": null,\n \"symbol\": \"DEF\",\n \"term\": null,\n \"today_ugl_amount\": 200,\n \"today_ugl_percentage\": 0.27,\n \"total_ugl_amount\": 20000,\n \"total_ugl_percentage\": 26.67,\n \"unvested_quantity\": null,\n \"unvested_value\": null,\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"vested_quantity\": null,\n \"vested_value\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"current_price_as_of\": \"2023-11-06T00:00:00Z\",\n \"issue_date\": \"2015-08-15\",\n \"vesting_start_date\": null,\n \"vesting_end_date\": null,\n \"put_or_call\": null,\n \"holding_type\": \"MUTUAL_FUND\",\n \"term_unit\": null\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "647962a0-f061-4894-b60f-560eabc457ff", "name": "Read holding", "request": { "name": "Read holding", "description": { "content": "Use this endpoint to read the attributes of a specific `holding`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "investment_holdings", ":holding_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "holding_guid", "description": "(Required) The unique id for a `holding`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ae4f92b2-75d5-4629-9030-76f8c03e4108", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "investment_holdings", ":holding_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "holding_guid", "description": "(Required) The unique id for a `holding`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"investment_holding\": {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"cost_basis\": 827,\n \"coupon_yield\": null,\n \"currency_code\": \"USD\",\n \"current_price\": 15,\n \"daily_change\": 2.5,\n \"description\": \"Guggenheim Defensive Equity ETF\",\n \"expiration\": null,\n \"face_value\": 1000,\n \"frequency\": \"ANNUALLY\",\n \"guid\": \"HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2\",\n \"market_value\": 989.5,\n \"maturity_date\": null,\n \"percentage_change\": 0.2,\n \"purchase_price\": 26.3,\n \"quantity\": \"5000.0\",\n \"rate\": null,\n \"strike_price\": null,\n \"symbol\": \"DEF\",\n \"term\": null,\n \"today_ugl_amount\": 200,\n \"today_ugl_percentage\": 0.27,\n \"total_ugl_amount\": 20000,\n \"total_ugl_percentage\": 26.67,\n \"unvested_quantity\": null,\n \"unvested_value\": null,\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"vested_quantity\": null,\n \"vested_value\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"current_price_as_of\": \"2023-11-06T00:00:00Z\",\n \"issue_date\": \"2015-08-15\",\n \"vesting_start_date\": null,\n \"vesting_end_date\": null,\n \"put_or_call\": null,\n \"holding_type\": \"MUTUAL_FUND\",\n \"term_unit\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "4033d263-445d-454c-acae-5127e86536bb", "name": "List holdings by account", "request": { "name": "List holdings by account", "description": { "content": "This endpoint lists all holdings associated with the particular account defined.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "accounts", ":account_guid", "investment_holdings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d5c547ac-44d1-4cba-819f-f64cbdb23493", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "accounts", ":account_guid", "investment_holdings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"investment_holdings\": [\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"cost_basis\": 827,\n \"coupon_yield\": null,\n \"currency_code\": \"USD\",\n \"current_price\": 15,\n \"daily_change\": 2.5,\n \"description\": \"Guggenheim Defensive Equity ETF\",\n \"expiration\": null,\n \"face_value\": 1000,\n \"frequency\": \"ANNUALLY\",\n \"guid\": \"HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2\",\n \"market_value\": 989.5,\n \"maturity_date\": null,\n \"percentage_change\": 0.2,\n \"purchase_price\": 26.3,\n \"quantity\": \"5000.0\",\n \"rate\": null,\n \"strike_price\": null,\n \"symbol\": \"DEF\",\n \"term\": null,\n \"today_ugl_amount\": 200,\n \"today_ugl_percentage\": 0.27,\n \"total_ugl_amount\": 20000,\n \"total_ugl_percentage\": 26.67,\n \"unvested_quantity\": null,\n \"unvested_value\": null,\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"vested_quantity\": null,\n \"vested_value\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"current_price_as_of\": \"2023-11-06T00:00:00Z\",\n \"issue_date\": \"2015-08-15\",\n \"vesting_start_date\": null,\n \"vesting_end_date\": null,\n \"put_or_call\": null,\n \"holding_type\": \"MUTUAL_FUND\",\n \"term_unit\": null\n },\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"cost_basis\": 827,\n \"coupon_yield\": null,\n \"currency_code\": \"USD\",\n \"current_price\": 15,\n \"daily_change\": 2.5,\n \"description\": \"Guggenheim Defensive Equity ETF\",\n \"expiration\": null,\n \"face_value\": 1000,\n \"frequency\": \"ANNUALLY\",\n \"guid\": \"HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2\",\n \"market_value\": 989.5,\n \"maturity_date\": null,\n \"percentage_change\": 0.2,\n \"purchase_price\": 26.3,\n \"quantity\": \"5000.0\",\n \"rate\": null,\n \"strike_price\": null,\n \"symbol\": \"DEF\",\n \"term\": null,\n \"today_ugl_amount\": 200,\n \"today_ugl_percentage\": 0.27,\n \"total_ugl_amount\": 20000,\n \"total_ugl_percentage\": 26.67,\n \"unvested_quantity\": null,\n \"unvested_value\": null,\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"vested_quantity\": null,\n \"vested_value\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"current_price_as_of\": \"2023-11-06T00:00:00Z\",\n \"issue_date\": \"2015-08-15\",\n \"vesting_start_date\": null,\n \"vesting_end_date\": null,\n \"put_or_call\": null,\n \"holding_type\": \"MUTUAL_FUND\",\n \"term_unit\": null\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "1d88a211-5db3-4104-be2d-8644c35ec725", "name": "Deactivate user from Investment Holdings", "request": { "name": "Deactivate user from Investment Holdings", "description": { "content": "This endpoint deactivates the specific user from the `/investment_holdings` product. To reactivate a user, use any of the current `/investment_holding` endpoints.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "investment_holdings_deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "877085db-6568-466d-a666-10c6267cc318", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "investment_holdings_deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {},\n \"status\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] } ], "event": [] }, { "id": "ae5ebbb0-5ac0-48d0-90dc-a3a3ae610408", "name": "managed data", "description": { "content": "", "type": "text/plain" }, "item": [], "event": [] }, { "id": "d350edf5-bfd8-4de7-a6c1-8b53a20f90fd", "name": "members", "description": { "content": "Members represent the connection between an end user and a financial institution. This institution may represent your institution or another one from which MX is aggregating data.\n\nFor more info, see [Members Overview](docs.mx.com/api-reference/reference/members).\n", "type": "text/plain" }, "item": [ { "id": "667c93ff-95b0-43ae-840a-0fc0cfc328ea", "name": "List members", "request": { "name": "List members", "description": { "content": "This endpoint returns an array which contains information on every member associated with a specific user.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." }, { "disabled": false, "key": "use_case", "value": "", "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`." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1a8224ac-c8dc-4947-9c9f-a5658a5329b4", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" }, { "key": "use_case", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"members\": [\n {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n },\n {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "fa2d21f0-c35d-4b3d-a62e-555805676497", "name": "Create member", "request": { "name": "Create member", "description": { "content": "This endpoint allows you to create a new member using the required parameters `institution_code`, `credentials` (if creating a non-OAuth member), and `data_request.products`. When creating a non-OAuth member, include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the `/institutions/{institution_code}/credentials` endpoint.

\nOnce you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data. OAuth members will not begin aggregation until the user completes authorization; aggregation initiates automatically after the OAuth flow is completed.

\n**Response status codes:**
- `200` - Member created, no aggregation job initiated.
- `201` - Member created, but one or more products in `data_request` failed.
- `202` - Member created, aggregation requested. Does not indicate aggregation success or failure.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member/#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.", "key": "X-CALLBACK-PAYLOAD", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"client_redirect_url\": \"\",\n \"data_request\": {\n \"products\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"enable_app2app\": \"\",\n \"member\": {\n \"credentials\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"institution_code\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"id\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"skip_aggregation\": \"\",\n \"use_cases\": [\n \"\",\n \"\"\n ]\n },\n \"referral_source\": \"\",\n \"ui_message_webview_url_scheme\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0830beca-6a07-42c6-bc7b-3af63b4e3b2f", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member/#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.", "key": "X-CALLBACK-PAYLOAD", "value": "813e50bd-4a7e-4517-b6bb-9eef65a68cbd" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"client_redirect_url\": \"https://{yoursite.com}\",\n \"data_request\": {\n \"products\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"enable_app2app\": false,\n \"member\": {\n \"credentials\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"institution_code\": \"mxbank\",\n \"background_aggregation_is_disabled\": false,\n \"id\": \"unique_id\",\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"skip_aggregation\": false,\n \"use_cases\": [\n \"PFM\"\n ]\n },\n \"referral_source\": \"APP\",\n \"ui_message_webview_url_scheme\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9757b994-38ef-429f-8ff1-6ba8827b35e7", "name": "Created", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member/#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.", "key": "X-CALLBACK-PAYLOAD", "value": "813e50bd-4a7e-4517-b6bb-9eef65a68cbd" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"client_redirect_url\": \"https://{yoursite.com}\",\n \"data_request\": {\n \"products\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"enable_app2app\": false,\n \"member\": {\n \"credentials\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"institution_code\": \"mxbank\",\n \"background_aggregation_is_disabled\": false,\n \"id\": \"unique_id\",\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"skip_aggregation\": false,\n \"use_cases\": [\n \"PFM\"\n ]\n },\n \"referral_source\": \"APP\",\n \"ui_message_webview_url_scheme\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"aggregated_at\": {\n \"value\": \"\"\n },\n \"background_aggregation_is_disabled\": {\n \"value\": \"\"\n },\n \"connection_status\": {\n \"value\": \"\"\n },\n \"connection_status_message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"error_type\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"error_message\": {\n \"value\": \"\"\n },\n \"user_message\": {\n \"value\": \"\"\n }\n },\n \"guid\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"institution_code\": {\n \"value\": \"\"\n },\n \"institution_guid\": {\n \"value\": \"\"\n },\n \"is_being_aggregated\": {\n \"value\": \"\"\n },\n \"is_managed_by_user\": {\n \"value\": \"\"\n },\n \"is_manual\": {\n \"value\": \"\"\n },\n \"is_oauth\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"most_recent_job_detail_code\": {\n \"value\": \"\"\n },\n \"most_recent_job_detail_text\": {\n \"value\": \"\"\n },\n \"most_recent_job_guid\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"needs_updated_credentials\": {\n \"value\": \"\"\n },\n \"oauth_window_uri\": {\n \"value\": \"\"\n },\n \"successfully_aggregated_at\": {\n \"value\": \"\"\n },\n \"use_cases\": {\n \"value\": \"\"\n },\n \"user_guid\": {\n \"value\": \"\"\n },\n \"user_id\": {\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e437b7c5-d632-4392-aa1b-a68fcf436990", "name": "Accepted", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member/#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.", "key": "X-CALLBACK-PAYLOAD", "value": "813e50bd-4a7e-4517-b6bb-9eef65a68cbd" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"client_redirect_url\": \"https://{yoursite.com}\",\n \"data_request\": {\n \"products\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"enable_app2app\": false,\n \"member\": {\n \"credentials\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"institution_code\": \"mxbank\",\n \"background_aggregation_is_disabled\": false,\n \"id\": \"unique_id\",\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"skip_aggregation\": false,\n \"use_cases\": [\n \"PFM\"\n ]\n },\n \"referral_source\": \"APP\",\n \"ui_message_webview_url_scheme\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b75773d2-3a36-4d2d-9990-ae14bccee051", "name": "Delete member", "request": { "name": "Delete member", "description": { "content": "Accessing this endpoint will permanently delete a member.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "db7f721f-d584-48ae-8e3d-7ebc252e5c9c", "name": "No Content", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "1f01c61c-1325-4df4-9b16-29779d10fb55", "name": "Read member", "request": { "name": "Read member", "description": { "content": "Use this endpoint to read the attributes of a specific member.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d83dc7ff-5e56-486b-a944-f024f8f61fd3", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "cd9d862f-5c11-4178-a5e7-5816b8271b18", "name": "Update member", "request": { "name": "Update member", "description": { "content": "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.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member/#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.", "key": "X-CALLBACK-PAYLOAD", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"member\": {\n \"background_aggregation_is_disabled\": \"\",\n \"credentials\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"id\": \"\",\n \"metadata\": \"\",\n \"skip_aggregation\": \"\",\n \"use_cases\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0b4bedb1-97b6-4ae2-893a-4aeb21d04f80", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member/#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.", "key": "X-CALLBACK-PAYLOAD", "value": "813e50bd-4a7e-4517-b6bb-9eef65a68cbd" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"member\": {\n \"background_aggregation_is_disabled\": false,\n \"credentials\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"id\": \"unique_id\",\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"skip_aggregation\": false,\n \"use_cases\": [\n \"PFM\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83e6c363-046a-4659-9172-3eb5413b085c", "name": "Aggregate member", "request": { "name": "Aggregate member", "description": { "content": "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.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "aggregate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member/#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.", "key": "X-CALLBACK-PAYLOAD", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "853ebcfe-c796-4edf-b7fc-93b87141c516", "name": "Accepted", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "aggregate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member/#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.", "key": "X-CALLBACK-PAYLOAD", "value": "813e50bd-4a7e-4517-b6bb-9eef65a68cbd" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "66948041-a5d0-41a5-a0c9-0e242b5f7c54", "name": "Aggregate all members", "request": { "name": "Aggregate all members", "description": { "content": "This endpoint will kick off a new aggregation job for each member which belongs to the user. If you've set the `use_cases` field when creating the member, then the member's use case must be set to `PFM`, otherwise a 403 will return. The response will include important information about the members' aggregations including the `is_being_aggregated` and `connection_status` fields. Aggregations can take some time to finish; you can use the the read member or list members endpoints to track the status and completion of each individual aggregation as it progresses.\n\n:::warning\nNew implementations shouldn't use this endpoint. It is maintained for compatibility with our Nexus API only.\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", "aggregate_all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "d939bd33-556e-4a57-8a0f-ff96ddad1f3d", "name": "Accepted", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", "aggregate_all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"members\": [\n {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n },\n {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "408c2684-6c0d-4eae-9ecb-fe80f8323093", "name": "List member challenges", "request": { "name": "List member challenges", "description": { "content": "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.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "challenges" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a7e70875-11b6-4d3a-bd9e-6f6762999f59", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "challenges" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"challenges\": [\n {\n \"field_name\": \"Who is this guy?\",\n \"guid\": \"CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5\",\n \"image_data\": \"Who is this guy?\",\n \"image_options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"label\": \"Who is this guy?\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"IMAGE_DATA\"\n },\n {\n \"field_name\": \"Who is this guy?\",\n \"guid\": \"CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5\",\n \"image_data\": \"Who is this guy?\",\n \"image_options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"label\": \"Who is this guy?\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"IMAGE_DATA\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "0b3a90ac-6675-4f5f-8b1e-9c0525768640", "name": "Check balances", "request": { "name": "Check balances", "description": { "content": "This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "check_balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "21cba21a-0a4d-479f-b6d6-1e1fcb73ab03", "name": "Accepted", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "check_balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "fce8d963-53b4-4dd0-a4b7-756e81a9bc9e", "name": "List member credentials", "request": { "name": "List member credentials", "description": { "content": "This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "dce17a40-14a5-4411-9af5-74eefc08abe7", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"credentials\": [\n {\n \"display_order\": 1,\n \"field_name\": \"LOGIN\",\n \"field_type\": \"TEXT\",\n \"guid\": \"CRD-1ec152cd-e628-e81a-e852-d1e7104624da\",\n \"label\": \"Username\",\n \"type\": \"TEXT\"\n },\n {\n \"display_order\": 1,\n \"field_name\": \"LOGIN\",\n \"field_type\": \"TEXT\",\n \"guid\": \"CRD-1ec152cd-e628-e81a-e852-d1e7104624da\",\n \"label\": \"Username\",\n \"type\": \"TEXT\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "ac03563b-6e61-4acb-bb65-4626aac6c881", "name": "Identify member", "request": { "name": "Identify member", "description": { "content": "The identify endpoint begins an identification process for an already-existing member.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "identify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "5bc2db82-4a13-427f-b3a7-d4d653a3d783", "name": "Accepted", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "identify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "bfa4f027-126f-4b4e-b0a1-0fda56d38bfc", "name": "Resume aggregation", "request": { "name": "Resume aggregation", "description": { "content": "This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"member\": {\n \"challenges\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "23399bdc-540b-45a7-9b2d-5cce2942e296", "name": "Accepted", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"member\": {\n \"challenges\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a63ee53e-07fc-4058-8cab-4ec2564ff5c2", "name": "Read member status", "request": { "name": "Read member status", "description": { "content": "This endpoint provides the status of the members most recent aggregation event. The results returned by this endpoint should determine what you do next in order to successfully aggregate a member.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "663b279e-054f-4ebd-ae80-5b271df1fc4e", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"challenges\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"connection_status\": \"CONNECTED\",\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"has_processed_account_numbers\": true,\n \"has_processed_accounts\": true,\n \"has_processed_transactions\": false,\n \"is_authenticated\": false,\n \"is_being_aggregated\": false,\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "14e1e9df-15fd-42c4-a4c4-b37c89814c8d", "name": "Verify member", "request": { "name": "Verify member", "description": { "content": "The verify endpoint begins a verification process for a member.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member/#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.", "key": "X-CALLBACK-PAYLOAD", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "e39dc90a-5146-48bd-bace-5bc0bddfb94a", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member/#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.", "key": "X-CALLBACK-PAYLOAD", "value": "813e50bd-4a7e-4517-b6bb-9eef65a68cbd" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] } ], "event": [] }, { "id": "d8a74b23-4598-48e6-943a-ad13f079b197", "name": "merchants", "description": { "content": "Merchants are representations of a transaction’s origin. For example, if you buy a coffee at Starbucks, the transaction merchant will be `Starbucks`.\n\nUse the `merchant_guid` and a `merchant_location_guidon` any `transaction` object to access Merchant endpoints for details like the merchant’s name, logo URL, website, street address, and more.\n", "type": "text/plain" }, "item": [ { "id": "afb2d0c9-ce91-48ad-8ed1-8a2ce7443393", "name": "Read merchant location", "request": { "name": "Read merchant location", "description": { "content": "This endpoint returns the specified `merchant_location` resource. The `merchant_location_guid` can be found on `transaction` objects.", "type": "text/plain" }, "url": { "path": [ "merchant_locations", ":merchant_location_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "merchant_location_guid", "description": "(Required) The unique id for a `merchant_location`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "868a85a3-e66e-4f27-9743-3c4ca862d6bf", "name": "OK", "originalRequest": { "url": { "path": [ "merchant_locations", ":merchant_location_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "merchant_location_guid", "description": "(Required) The unique id for a `merchant_location`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"merchant_location\": {\n \"city\": \"North Kishaberg\",\n \"country\": \"US\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"MCL-00024e59-18b5-4d79-b879-2a7896726fea\",\n \"latitude\": 39.5963005,\n \"longitude\": -104.89158799999998,\n \"merchant_guid\": \"MCH-09466f0a-fb58-9d1a-bae2-2af0afbea621\",\n \"phone_number\": \"(303) 689-0728\",\n \"postal_code\": \"801121436\",\n \"state\": \"CO\",\n \"street_address\": \"8547 E Arapahoe Rd, Ste 1\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "52179ac2-1f73-47e5-b6c2-8179d9978bf8", "name": "List merchants", "request": { "name": "List merchants", "description": { "content": "This endpoint returns a paginated list of all the merchants in the MX system.", "type": "text/plain" }, "url": { "path": [ "merchants" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "name", "value": "", "description": "This will list only merchants in which the appended string appears." }, { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "83789f0c-f529-4293-91bd-254f1afe1aaf", "name": "OK", "originalRequest": { "url": { "path": [ "merchants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "name", "value": "Comcast" }, { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"merchants\": [\n {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b\",\n \"logo_url\": \"https://s3.amazonaws.com/MD_Assets/merchant_logos/comcast.png\",\n \"name\": \"Comcast\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"website_url\": \"https://www.example.com\"\n },\n {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b\",\n \"logo_url\": \"https://s3.amazonaws.com/MD_Assets/merchant_logos/comcast.png\",\n \"name\": \"Comcast\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"website_url\": \"https://www.example.com\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "2a6a9dea-c90b-4708-8b5d-4c74f27ac76e", "name": "Read merchant", "request": { "name": "Read merchant", "description": { "content": "Returns information about a particular merchant, such as a logo, name, and website.", "type": "text/plain" }, "url": { "path": [ "merchants", ":merchant_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "merchant_guid", "description": "(Required) The unique id for a `merchant`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3f077716-7b27-4530-9b1e-b344ab054b89", "name": "OK", "originalRequest": { "url": { "path": [ "merchants", ":merchant_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "merchant_guid", "description": "(Required) The unique id for a `merchant`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"merchant\": {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b\",\n \"logo_url\": \"https://s3.amazonaws.com/MD_Assets/merchant_logos/comcast.png\",\n \"name\": \"Comcast\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"website_url\": \"https://www.example.com\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] } ], "event": [] }, { "id": "55c625af-91c7-48a8-8ebb-d0ff17f1c4c8", "name": "microdeposits", "description": { "content": "Microdeposits is an additional verification method that allows you to verify account details and navigate the process of using microdeposits and the automated clearing house (ACH) system. \n\nMake two, small ACH deposits into a consumer's account using the provided account and routing number. You can then require that the end user confirm the exact amount of each deposit to verify that they own the account and meet NACHA’s account verification.\n\nFor more info, including process flows, setting block lists, and more, see [Microdeposits](docs.mx.com/products/connectivity/microdeposits).\n", "type": "text/plain" }, "item": [ { "id": "1053b2d6-ed09-4b68-93b5-73181ffd8241", "name": "List all microdeposits for a user", "request": { "name": "List all microdeposits for a user", "description": { "content": "Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "micro_deposits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6fe4d1c1-cf36-4995-8629-f0ce288fd0ab", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "micro_deposits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"micro_deposits\": [\n {\n \"error_message\": null,\n \"guid\": \"MIC-09ba578e-8448-4f7f-89e1-b62ff2517edb\",\n \"institution_code\": \"mxbank\",\n \"institution_name\": \"MX Bank\",\n \"status\": \"INITIATED\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"verified_at\": null\n },\n {\n \"error_message\": null,\n \"guid\": \"MIC-09ba578e-8448-4f7f-89e1-b62ff2517edb\",\n \"institution_code\": \"mxbank\",\n \"institution_name\": \"MX Bank\",\n \"status\": \"INITIATED\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"verified_at\": null\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "5724fe96-89a9-40c2-9846-125411cf0fc7", "name": "Create or pre-initiate a microdeposit", "request": { "name": "Create or pre-initiate a microdeposit", "description": { "content": "Use this endpoint to create or pre-initiate a microdeposit. The response will include the new microdeposit record with a status of `INITIATED` or `PREINITIATED` respectively.\n\nTo pre-initiate a microdeposit, you only need to set `email` (string), `first_name` (string), and `last_name` (string) in the request body. \n\nPre-initiating a microdeposit allows you to pass the end user's first name, last name, and email if this data has already been collected. If the end user selects an institution which requires the microdeposit flow, the pre-initiated `micro_deposit` will be used and the Connect Widget step that normally requests this info from the end user will be skipped. However, if the end user selects an institution which supports IAV, the pre-initiated `micro_deposit` will be deleted and IAV will be used instead. When requesting a Connect Widget URL after pre-initiating, make sure to set the `current_microdeposit_guid` to the resulting microdeposit's `guid` and set `data_request.products` to include `account_verification`. If you use this enhanced flow, a `micro_deposit` should be pre-initiated for all connect sessions in verification mode. After pre-initiating a microdeposit, pass the GUID to the config as `current_microdeposit_guid` and set `data_request.products` to include `account_verification` when requesting a Connect URL. Pre-initiating a microdeposit is optional. If you choose to implement this flow, it should be used for all Connect Widget sessions in verification mode.\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "micro_deposits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"micro_deposit\": {\n \"account_number\": \"\",\n \"account_type\": \"\",\n \"routing_number\": \"\",\n \"account_name\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "81543145-5905-40f4-9335-b716109d5835", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "micro_deposits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"micro_deposit\": {\n \"account_number\": \"3331261\",\n \"account_type\": \"CHECKING\",\n \"routing_number\": \"091000019\",\n \"account_name\": \"My test account\",\n \"email\": \"example@example.com\",\n \"first_name\": \"Josh\",\n \"last_name\": \"Grobanne\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"micro_deposit\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2c373693-4f10-4e46-8df3-7e4cb23f033a", "name": "Delete a microdeposit", "request": { "name": "Delete a microdeposit", "description": { "content": "Use this endpoint to delete the specified microdeposit.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "micro_deposits", ":micro_deposit_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "micro_deposit_guid", "description": "(Required) The unique identifier for the microdeposit. Defined by MX." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "686ea259-c697-44c2-bb48-e11e6788f794", "name": "No Content", "originalRequest": { "url": { "path": [ "users", ":user_guid", "micro_deposits", ":micro_deposit_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "micro_deposit_guid", "description": "(Required) The unique identifier for the microdeposit. Defined by MX." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "190ae731-a22d-4d16-9d28-a0ab5ef32f52", "name": "Read a microdeposit for a user", "request": { "name": "Read a microdeposit for a user", "description": { "content": "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.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "micro_deposits", ":micro_deposit_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "micro_deposit_guid", "description": "(Required) The unique identifier for the microdeposit. Defined by MX." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "91802b2a-a1d7-4d7c-9c21-701b282c7d4f", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "micro_deposits", ":micro_deposit_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "micro_deposit_guid", "description": "(Required) The unique identifier for the microdeposit. Defined by MX." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"micro_deposit\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "3fdcc82f-54d1-4d1b-bd5c-1469efb8473e", "name": "Verify a Microdeposit", "request": { "name": "Verify a Microdeposit", "description": { "content": "Use this endpoint to verify the amounts deposited into the account during a microdeposit verification. The verification has not successfully completed until the `status` is `VERIFIED`. Poll the `/users/{user_guid}/micro_deposits/{micro_deposit_guid}` (read microdeposit) endpoint until you see this status or an error state.", "type": "text/plain" }, "url": { "path": [ "micro_deposits", ":micro_deposit_guid", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "micro_deposit_guid", "description": "(Required) The unique identifier for the microdeposit. Defined by MX." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"micro_deposit\": {\n \"deposit_amount_1\": \"\",\n \"deposit_amount_2\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cb7396d5-2a07-40bf-9625-31f7c1501e90", "name": "OK", "originalRequest": { "url": { "path": [ "micro_deposits", ":micro_deposit_guid", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "micro_deposit_guid", "description": "(Required) The unique identifier for the microdeposit. Defined by MX." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"micro_deposit\": {\n \"deposit_amount_1\": 0.12,\n \"deposit_amount_2\": 0.15\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"micro_deposit\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8c11bde4-d2c9-480b-b7db-9f3d44bc8a29", "name": "List all verifications for a user", "request": { "name": "List all verifications for a user", "description": { "content": "This endpoint returns a list of the account verifications associated with the user, as well as the status of those verifications.\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "account_verifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "58579d96-86f9-4752-af8d-ed62cba9f4b9", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "account_verifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"micro_deposit\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] } ], "event": [] }, { "id": "f9159299-2017-4eda-aec2-cbf6d8da6133", "name": "monthly cash flow profile", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "5785febc-6260-4394-9dd7-c6413993474b", "name": "Read monthly cash flow profile", "request": { "name": "Read monthly cash flow profile", "description": { "content": "Read monthly cash flow profile.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "monthly_cash_flow_profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3b744bd0-9eee-402c-8758-e05079dde3ef", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "monthly_cash_flow_profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"monthly_cash_flow_profile\": {\n \"guid\": \"MCF-4e431124-4a29-abf9-f059-ab232ac14dbf\",\n \"user_guid\": \"USR-6c83f63c-efcc-0189-3f14-100f0bad378a\",\n \"budgeted_income\": 5000,\n \"budgeted_expenses\": 3500,\n \"goals_contribution\": 500,\n \"estimated_goals_contribution\": null,\n \"uses_estimated_goals_contribution\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "a79f2132-4539-4181-84c7-e7da67a08db8", "name": "Update monthly cash flow profile", "request": { "name": "Update monthly cash flow profile", "description": { "content": "Use this endpoint to update the attributes of a `monthly_cash_flow_profile`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "monthly_cash_flow_profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"monthly_cash_flow_profile\": {\n \"goals_contribution\": \"\",\n \"uses_estimated_goals_contribution\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "314ad26b-df3e-4503-8cc5-421ce87acb79", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "monthly_cash_flow_profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"monthly_cash_flow_profile\": {\n \"goals_contribution\": 500,\n \"uses_estimated_goals_contribution\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"monthly_cash_flow_profile\": {\n \"guid\": \"MCF-4e431124-4a29-abf9-f059-ab232ac14dbf\",\n \"user_guid\": \"USR-6c83f63c-efcc-0189-3f14-100f0bad378a\",\n \"budgeted_income\": 5000,\n \"budgeted_expenses\": 3500,\n \"goals_contribution\": 500,\n \"estimated_goals_contribution\": null,\n \"uses_estimated_goals_contribution\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "67848e1c-57e4-4c6d-b174-833863ca6dd2", "name": "notifications", "description": { "content": "You can only use notifications endpoints if you’re using the MX mobile application.\n\nAll notifications created through the API will be of notification type `API_NOTIFICATION`, channel `PUSH`, and will not be associated to an entity. No other channels are supported.\n\nThe read and list endpoints can return any notification associated with the `user`, including notifications created by MX for other channels besides `PUSH`.\n", "type": "text/plain" }, "item": [ { "id": "f351abdd-270d-4274-aea1-cb662306a5a9", "name": "Create a notification", "request": { "name": "Create a notification", "description": { "content": "All notifications created through the API will be of notification type `API_NOTIFICATION`, channel `PUSH`, and will not be associated to an entity. No other channels are supported. This will only have an effect for clients using an MX mobile application.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"notification\": {\n \"content\": \"\",\n \"subject\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b7808de5-6784-4a32-b1ea-4d95aed2ef3c", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"notification\": {\n \"content\": \"You're projected to spend $1,920.07 more than you've budgeted for Fees & Charges. You've already spent $325.67 of $716.00.\",\n \"subject\": \"Monthly Budget Report\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"notification\": {\n \"channel\": \"EMAIL\",\n \"content\": \"You're projected to spend $1,920.07 more than you've budgeted for Fees & Charges. You've already spent $325.67 of $716.00.\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"deep_link_guid\": {},\n \"delivered_at\": {},\n \"entity_guid\": {},\n \"guid\": {},\n \"has_been_delivered\": {},\n \"has_been_viewed\": {},\n \"notification_type\": {},\n \"subject\": {},\n \"threshold\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "719bea20-dd19-4c33-a7bb-2672630a02a7", "name": "List notifications", "request": { "name": "List notifications", "description": { "content": "All notifications for the user can be listed, including notifications created by MX for other channels besides `PUSH`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d0f931b0-f028-45b1-88ef-2d06eec06ce4", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"notifications\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "ad5cae0c-5468-46bf-a259-5d5600077ae8", "name": "Read notifications", "request": { "name": "Read notifications", "description": { "content": "Can pull up any notification associated with the user, including notifications created by MX for other channels besides `PUSH`.\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "notifications", ":notification_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "notification_guid", "description": "(Required) The unique identifier for notifications. Defined by MX." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f700cded-9577-4daf-be2c-2db1834e9046", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "notifications", ":notification_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "notification_guid", "description": "(Required) The unique identifier for notifications. Defined by MX." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"notification\": {\n \"channel\": \"EMAIL\",\n \"content\": \"You're projected to spend $1,920.07 more than you've budgeted for Fees & Charges. You've already spent $325.67 of $716.00.\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"deep_link_guid\": {},\n \"delivered_at\": {},\n \"entity_guid\": {},\n \"guid\": {},\n \"has_been_delivered\": {},\n \"has_been_viewed\": {},\n \"notification_type\": {},\n \"subject\": {},\n \"threshold\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] } ], "event": [] }, { "id": "45550616-581b-4154-a5fe-c0f346bdff3c", "name": "processor token", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "30455a70-e258-4d0c-aad3-471877aa1345", "name": "Request an authorization code", "request": { "name": "Request an authorization code", "description": { "content": "Clients use this endpoint to request an authorization code according to the parameters specified in the scope. Clients then pass this code to processors. Processor access is scoped only to the GUIDs and features specified in this request. Before requesting an authorization code which includes a member in the scope, clients must have verified that member.", "type": "text/plain" }, "url": { "path": [ "authorization_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"authorization_code\": {\n \"scope\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "728f1742-691c-423f-8e45-c53936395272", "name": "OK", "originalRequest": { "url": { "path": [ "authorization_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"authorization_code\": {\n \"scope\": \"user-guid:USR-101ad774-288b-44ed-ad16-da87d522ea20 member-guid:MBR-54feffb9-8474-47bd-8442-de003910113a account-guid:ACT-32a64160-582a-4f00-ab34-5f49cc35ed35 read-protected\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"authorization_code\": {\n \"code\": \"9nN-9D8_4Z3WYazx7-zXfmqsD3jwgL_2W927Sb3otI\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "97f35c1b-2343-4f6b-ad17-b3274e5950a3", "name": "View a List of Tokens", "request": { "name": "View a List of Tokens", "description": { "content": "View a list of tokens that exist for a user, member, or account.", "type": "text/plain" }, "url": { "path": [ "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null, "body": { "mode": "raw", "raw": "{\n \"scope\": {\n \"account_guid\": \"\",\n \"member_guid\": \"\",\n \"user_guid\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "37981a15-9867-4c2a-967d-5797b5eb12fe", "name": "OK", "originalRequest": { "url": { "path": [ "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": { "mode": "raw", "raw": "{\n \"scope\": {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tokens\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2eb45035-ba68-4630-97c0-432281dceae7", "name": "Request an account number (Processors Only)", "request": { "name": "Request an account number (Processors Only)", "description": { "content": "Get account information such as routing number and account number, scoped to your access token.", "type": "text/plain" }, "url": { "path": [ "account", "account_numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "" } ] } }, "response": [ { "id": "8598277c-7b11-4730-ac17-aeeba63b9aca", "name": "OK", "originalRequest": { "url": { "path": [ "account", "account_numbers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account_numbers\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "6913bcb9-7ad8-410e-a969-0c17b11fe11d", "name": "Check Real Time Account Balance (Processors Only)", "request": { "name": "Check Real Time Account Balance (Processors Only)", "description": { "content": "Check the real-time account balance using your access token.", "type": "text/plain" }, "url": { "path": [ "account", "check_balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "" } ] } }, "response": [ { "id": "33220710-a9ec-469f-b9ac-f66fc024fe5d", "name": "OK", "originalRequest": { "url": { "path": [ "account", "check_balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "253c8b0a-aa24-4ffa-a5e5-59fd970d802d", "name": "Read the account balance (Processors Only)", "request": { "name": "Read the account balance (Processors Only)", "description": { "content": "Read the account balance (Processors Only)", "type": "text/plain" }, "url": { "path": [ "payment_account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "" } ] } }, "response": [ { "id": "8e6d9811-6dfb-4ab1-b7b4-a566c89c900c", "name": "OK", "originalRequest": { "url": { "path": [ "payment_account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payment_account\": {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"account_name\": \"My test account\",\n \"account_number\": {},\n \"account_type\": \"CHECKING\",\n \"available_balance\": 1000,\n \"balance\": 1000,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"routing_number\": {},\n \"transit_number\": {},\n \"updated_at\": \"2025-02-13T18:09:00+00:00\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "1d8f1cc4-def8-4984-9f87-118877a7e3c7", "name": "Get account owner information (Processors Only)", "request": { "name": "Get account owner information (Processors Only)", "description": { "content": "Get account owner information (Processors Only)", "type": "text/plain" }, "url": { "path": [ "account", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "" } ] } }, "response": [ { "id": "fbab9140-f5b3-4431-90d3-9888152c436f", "name": "OK", "originalRequest": { "url": { "path": [ "account", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account_owners\": {},\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] } ], "event": [] }, { "id": "23ee208c-9002-427a-a071-91ec543a294b", "name": "rewards", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "6a633d4b-6e13-41c4-a7eb-b47049bd8823", "name": "Fetch Rewards", "request": { "name": "Fetch Rewards", "description": { "content": "Calling this endpoint initiates an aggregation-type event which will gather the member's rewards information, as well as account and transaction information. Rewards data is also gathered with daily background aggregations. Member and Rewards guids are defined by MX.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "fetch_rewards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "9fb74df6-9d6a-4147-b8b5-7da3b37922ad", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "fetch_rewards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "e4121691-7684-4554-8947-5cb274afc1c7", "name": "List Rewards", "request": { "name": "List Rewards", "description": { "content": "Use this endpoint to list all the `rewards` associated with a specified `member`. Member guids are defined by MX.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "rewards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e4ab658b-ed01-4d48-90e2-04e122221b01", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "rewards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rewards\": [\n {\n \"account_guid\": {\n \"value\": \"\"\n },\n \"member_guid\": {\n \"value\": \"\"\n },\n \"user_guid\": {\n \"value\": \"\"\n },\n \"balance_type\": {\n \"value\": \"\"\n },\n \"balance\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"expires_on\": {\n \"value\": \"\"\n },\n \"guid\": {\n \"value\": \"\"\n },\n \"unit_type\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n },\n {\n \"account_guid\": {\n \"value\": \"\"\n },\n \"member_guid\": {\n \"value\": \"\"\n },\n \"user_guid\": {\n \"value\": \"\"\n },\n \"balance_type\": {\n \"value\": \"\"\n },\n \"balance\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"expires_on\": {\n \"value\": \"\"\n },\n \"guid\": {\n \"value\": \"\"\n },\n \"unit_type\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "a0b960b0-8dff-45ec-84dc-9a9b42fb2551", "name": "Read Reward", "request": { "name": "Read Reward", "description": { "content": "Use this endpoint to read a specific `reward` based on its unique GUID. Member and Rewards guids are defined by MX.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "rewards", ":reward_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "reward_guid", "description": "(Required) The unique identifier for the rewards. Defined by MX." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6426f1b6-e1b3-4839-9cec-55af83e0fb5a", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "rewards", ":reward_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "reward_guid", "description": "(Required) The unique identifier for the rewards. Defined by MX." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"reward\": {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"balance_type\": \"EXPIRING_BALANCE\",\n \"balance\": 1000,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"description\": \"A description of the reward.\",\n \"expires_on\": \"2020-02-28\",\n \"guid\": \"RWD-1234\",\n \"unit_type\": \"POINTS\",\n \"updated_at\": \"2023-06-01T19:18:06Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "bea4bddc-12b1-4e56-b1a1-5a4ee5701df2", "name": "Read a Credit Card Product", "request": { "name": "Read a Credit Card Product", "description": { "content": "This endpoint returns the specified `credit_card_product` according to the unique GUID.", "type": "text/plain" }, "url": { "path": [ "credit_card_products", ":credit_card_product_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "credit_card_product_guid", "description": "(Required) The required `credit_card_product_guid` can be found on the `account` object." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1678e660-9b05-4a6d-9244-7dd8c74d22e6", "name": "OK", "originalRequest": { "url": { "path": [ "credit_card_products", ":credit_card_product_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "credit_card_product_guid", "description": "(Required) The required `credit_card_product_guid` can be found on the `account` object." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"credit_card_product\": {\n \"annual_fee\": 45,\n \"duration_of_introductory_rate_on_balance_transfer\": null,\n \"duration_of_introductory_rate_on_purchases\": null,\n \"guid\": \"CCA-b5bcd822-6d01-4e23-b8d6-846a225e714a\",\n \"has_cashback_rewards\": false,\n \"has_other_rewards\": true,\n \"has_travel_rewards\": true,\n \"has_zero_introductory_annual_fee\": true,\n \"has_zero_percent_introductory_rate\": false,\n \"has_zero_percent_introductory_rate_on_balance_transfer\": true,\n \"is_accepting_applicants\": true,\n \"is_active_credit_card_product\": true,\n \"is_small_business_card\": true,\n \"name\": \"Credit Card\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] } ], "event": [] }, { "id": "71ba8d18-012a-4255-b566-445ff3c39f50", "name": "spending plan", "description": { "content": "Use the Spending Plan endpoints to create your own version of our [Spending Plan Widget](docs.mx.com/products/experience/pfm/legacy-widget-overviews/spending-plan), which helps end users track their spending throughout the month.\n\nTo understand key terms and how to best use these endpoints, see [Build Your Own Spending Plan UI](docs.mx.com/products/experience/pfm/integration-guides/build-your-own-spending-plan-ui).\n", "type": "text/plain" }, "item": [ { "id": "c1fb55cb-0194-48eb-9a2c-06e170d0ac16", "name": "Create spending plan iteration item", "request": { "name": "Create spending plan iteration item", "description": { "content": "This endpoint creates a new `spending_plan_iteration_item`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"planned_amount\": \"\",\n \"category_guid\": \"\",\n \"item_type\": \"\",\n \"scheduled_payment_guid\": \"\",\n \"top_level_category_guid\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a648e37e-2838-46c2-94bb-0c5841f510d8", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"planned_amount\": 61.11,\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"item_type\": 1,\n \"scheduled_payment_guid\": \"SCP-c731988a-712f-4f83-9b3b-0aa5b3d5208b\",\n \"top_level_category_guid\": \"CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"actual_amount\": 345,\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262\",\n \"item_type\": 1,\n \"planned_amount\": 110,\n \"scheduled_payment_guid\": \"SCP-c731988a-712f-4f83-9b3b-0aa5b3d5208b\",\n \"spending_plan_iteration_guid\": \"SPI-848e6648-3fa3-4632-ac8f-e65f03167102\",\n \"top_level_category_guid\": \"CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8\",\n \"transaction_guids\": [\n \"TRN-265abee9-889b-af6a-c69b-25157db2bdd9\",\n \"TRN-265abee9-889b-af6a-c69b-25157db2bdd9\"\n ],\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb118fec-26ed-4b8e-b97c-1bd053d3b6c8", "name": "List spending plan iteration items", "request": { "name": "List spending plan iteration items", "description": { "content": "Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7a3ac662-d97f-422d-ac93-2e4f221bd73e", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"iteration_items\": [\n {\n \"actual_amount\": 345,\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262\",\n \"item_type\": 1,\n \"planned_amount\": 110,\n \"scheduled_payment_guid\": \"SCP-c731988a-712f-4f83-9b3b-0aa5b3d5208b\",\n \"spending_plan_iteration_guid\": \"SPI-848e6648-3fa3-4632-ac8f-e65f03167102\",\n \"top_level_category_guid\": \"CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8\",\n \"transaction_guids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n },\n {\n \"actual_amount\": 345,\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262\",\n \"item_type\": 1,\n \"planned_amount\": 110,\n \"scheduled_payment_guid\": \"SCP-c731988a-712f-4f83-9b3b-0aa5b3d5208b\",\n \"spending_plan_iteration_guid\": \"SPI-848e6648-3fa3-4632-ac8f-e65f03167102\",\n \"top_level_category_guid\": \"CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8\",\n \"transaction_guids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "3986a0d1-806c-4532-bd1a-d9e13a0fb2f3", "name": "Create spending plan", "request": { "name": "Create spending plan", "description": { "content": "This endpoint creates a new `spending_plan` for the user.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "spending_plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "b652c98f-aaa2-495f-b86b-6a61c5912f79", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "spending_plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"current_iteration_number\": 1,\n \"guid\": \"SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "6b8c2a33-891a-4f2a-ba17-d4785adb28ee", "name": "List spending plans", "request": { "name": "List spending plans", "description": { "content": "Use this endpoint to list all the spending plans associated with the user.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "spending_plans" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "295603be-3d97-48eb-9e82-3f5c707e6ec8", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "spending_plans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"spending_plans\": [\n {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"current_iteration_number\": 1,\n \"guid\": \"SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n },\n {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"current_iteration_number\": 1,\n \"guid\": \"SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "6f29d449-14fa-4012-9444-5ec369503ad9", "name": "Delete spending plan account", "request": { "name": "Delete spending plan account", "description": { "content": "Use this endpoint to delete a `spending_plan_account`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "spending_plan_accounts", ":spending_plan_account_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_account_guid", "description": "(Required) The unique ID for the specified account." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "502a2b25-2171-43bd-9334-bc928d835c3c", "name": "No Content", "originalRequest": { "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "spending_plan_accounts", ":spending_plan_account_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_account_guid", "description": "(Required) The unique ID for the specified account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "cf854d74-1868-4fdd-94e0-cb2bfbfd0b60", "name": "Read spending plan account", "request": { "name": "Read spending plan account", "description": { "content": "Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "spending_plan_accounts", ":spending_plan_account_guid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_account_guid", "description": "(Required) The unique ID for the specified account." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ff639f42-c666-4440-8198-e6284e92d218", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "spending_plan_accounts", ":spending_plan_account_guid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_account_guid", "description": "(Required) The unique ID for the specified account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"client_guid\": \"CLT-abcd-1234\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"SPA-c76e4a85-b2c4-4335-82b7-8f8b8f28c35a\",\n \"spending_plan_guid\": \"SPL-dbfe201d-c341-4bff-93c0-62a918d0b600\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "f276c4e9-5e89-4760-83a6-16c22058c65d", "name": "Delete spending plan iteration item", "request": { "name": "Delete spending plan iteration item", "description": { "content": "Use this endpoint to delete a spending plan `iteration_item`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items", ":iteration_item_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." }, { "disabled": false, "type": "any", "value": "", "key": "iteration_item_guid", "description": "(Required) The unique ID for the `iteration_item`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "e79b4807-dbb5-4d6b-87a1-e9391556ac50", "name": "No Content", "originalRequest": { "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items", ":iteration_item_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." }, { "disabled": false, "type": "any", "value": "", "key": "iteration_item_guid", "description": "(Required) The unique ID for the `iteration_item`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "cac58c7d-8384-42d9-aa23-ba1f05c3da3c", "name": "Read a spending plan iteration item", "request": { "name": "Read a spending plan iteration item", "description": { "content": "Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items", ":iteration_item_guid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." }, { "disabled": false, "type": "any", "value": "", "key": "iteration_item_guid", "description": "(Required) The unique ID for the `iteration_item`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "78648999-8f7b-4496-b07e-972fed1aaa15", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items", ":iteration_item_guid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." }, { "disabled": false, "type": "any", "value": "", "key": "iteration_item_guid", "description": "(Required) The unique ID for the `iteration_item`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"actual_amount\": 345,\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262\",\n \"item_type\": 1,\n \"planned_amount\": 110,\n \"scheduled_payment_guid\": \"SCP-c731988a-712f-4f83-9b3b-0aa5b3d5208b\",\n \"spending_plan_iteration_guid\": \"SPI-848e6648-3fa3-4632-ac8f-e65f03167102\",\n \"top_level_category_guid\": \"CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8\",\n \"transaction_guids\": [\n \"TRN-265abee9-889b-af6a-c69b-25157db2bdd9\",\n \"TRN-265abee9-889b-af6a-c69b-25157db2bdd9\"\n ],\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "b9bc73fd-8c35-45f6-913e-b34fa6fe9505", "name": "Update a spending plan iteration item", "request": { "name": "Update a spending plan iteration item", "description": { "content": "Use this endpoint to update an existing `spending_plan_iteration_item`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items", ":iteration_item_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." }, { "disabled": false, "type": "any", "value": "", "key": "iteration_item_guid", "description": "(Required) The unique ID for the `iteration_item`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"planned_amount\": \"\",\n \"category_guid\": \"\",\n \"item_type\": \"\",\n \"scheduled_payment_guid\": \"\",\n \"top_level_category_guid\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "601948e3-cc19-4258-a89a-d1998f60d28a", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items", ":iteration_item_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." }, { "disabled": false, "type": "any", "value": "", "key": "iteration_item_guid", "description": "(Required) The unique ID for the `iteration_item`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"planned_amount\": 61.11,\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"item_type\": 1,\n \"scheduled_payment_guid\": \"SCP-c731988a-712f-4f83-9b3b-0aa5b3d5208b\",\n \"top_level_category_guid\": \"CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"actual_amount\": 345,\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262\",\n \"item_type\": 1,\n \"planned_amount\": 110,\n \"scheduled_payment_guid\": \"SCP-c731988a-712f-4f83-9b3b-0aa5b3d5208b\",\n \"spending_plan_iteration_guid\": \"SPI-848e6648-3fa3-4632-ac8f-e65f03167102\",\n \"top_level_category_guid\": \"CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8\",\n \"transaction_guids\": [\n \"TRN-265abee9-889b-af6a-c69b-25157db2bdd9\",\n \"TRN-265abee9-889b-af6a-c69b-25157db2bdd9\"\n ],\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d677dfa0-004e-47e0-b5d6-b22b9ea4e6aa", "name": "Delete spending plan", "request": { "name": "Delete spending plan", "description": { "content": "Use this endpoint to delete a user's `spending_plan`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "c089c9fe-22b3-43d9-ba46-723a6a68561e", "name": "No Content", "originalRequest": { "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "734df522-ae85-4d9a-8726-35972a795583", "name": "Read a spending plan for a user", "request": { "name": "Read a spending plan for a user", "description": { "content": "Use this endpoint to read the attributes of a specific spending plan according to its unique GUID.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "bc7626a8-d27e-4653-ad8c-0d08d8a7c3da", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"current_iteration_number\": 1,\n \"guid\": \"SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "f4b66b59-734c-4139-b7a9-2edcc4ddc91f", "name": "List spending plan accounts", "request": { "name": "List spending plan accounts", "description": { "content": "Use this endpoint to list all the spending plan accounts associated with the spending plan.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "spending_plan_accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2f1a4a6a-5549-494a-965c-f5adbdd26afe", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "spending_plan_accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"spending_plan_accounts\": [\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"client_guid\": \"CLT-abcd-1234\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"SPA-c76e4a85-b2c4-4335-82b7-8f8b8f28c35a\",\n \"spending_plan_guid\": \"SPL-dbfe201d-c341-4bff-93c0-62a918d0b600\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n },\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"client_guid\": \"CLT-abcd-1234\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"SPA-c76e4a85-b2c4-4335-82b7-8f8b8f28c35a\",\n \"spending_plan_guid\": \"SPL-dbfe201d-c341-4bff-93c0-62a918d0b600\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "71b98fdc-564b-4ae8-b8e5-3f7cd85497a4", "name": "List spending plan iterations", "request": { "name": "List spending plan iterations", "description": { "content": "Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "47fe8558-aebf-42a9-a6dc-ecddf3920928", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"iterations\": [\n {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"end_on\": \"2023-05-31\",\n \"guid\": \"SPI-848e6648-3fa3-4632-ac8f-e65f03167102\",\n \"iteration_number\": 1,\n \"spending_plan_guid\": \"SPL-dbfe201d-c341-4bff-93c0-62a918d0b600\",\n \"start_on\": \"2023-05-01\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n },\n {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"end_on\": \"2023-05-31\",\n \"guid\": \"SPI-848e6648-3fa3-4632-ac8f-e65f03167102\",\n \"iteration_number\": 1,\n \"spending_plan_guid\": \"SPL-dbfe201d-c341-4bff-93c0-62a918d0b600\",\n \"start_on\": \"2023-05-01\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "b4e9ae8c-9e2e-4c63-a038-612606f0001c", "name": "Read current spending plan iteration", "request": { "name": "Read current spending plan iteration", "description": { "content": "Use this endpoint to read the attributes of the current spending plan `iteration`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1acf3971-dd0f-47a1-9e4b-ffe11827aea9", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"end_on\": \"2023-05-31\",\n \"guid\": \"SPI-848e6648-3fa3-4632-ac8f-e65f03167102\",\n \"iteration_number\": 1,\n \"spending_plan_guid\": \"SPL-dbfe201d-c341-4bff-93c0-62a918d0b600\",\n \"start_on\": \"2023-05-01\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "99066995-6a86-4d13-8230-d66b54b7625f", "name": "Read a spending plan iteration", "request": { "name": "Read a spending plan iteration", "description": { "content": "Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", ":iteration_number" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." }, { "disabled": false, "type": "any", "value": "", "key": "iteration_number", "description": "(Required) The current iteration number for the spending plan `iteration`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7fae4745-fe61-48dd-bc0c-9b3bf1fa1bb4", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", ":iteration_number" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "spending_plan_guid", "description": "(Required) The unique ID for the `spending_plan`." }, { "disabled": false, "type": "any", "value": "", "key": "iteration_number", "description": "(Required) The current iteration number for the spending plan `iteration`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"end_on\": \"2023-05-31\",\n \"guid\": \"SPI-848e6648-3fa3-4632-ac8f-e65f03167102\",\n \"iteration_number\": 1,\n \"spending_plan_guid\": \"SPL-dbfe201d-c341-4bff-93c0-62a918d0b600\",\n \"start_on\": \"2023-05-01\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] } ], "event": [] }, { "id": "b2b72522-3706-44a4-b057-de0e28925795", "name": "statements", "description": { "content": "With Statements, you can retrieve a user's monthly account statements in PDF format. This data can be used for solutions like personal financial management or risk analysis.\n", "type": "text/plain" }, "item": [ { "id": "12193ba6-8d96-4026-b41e-e1dfafa3f3d4", "name": "Fetch statements", "request": { "name": "Fetch statements", "description": { "content": "Use this endpoint to fetch the statements associated with a particular member.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "fetch_statements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "ec69ddd1-c46a-4a8d-b114-d82b8527f557", "name": "Accepted", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "fetch_statements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "aa846683-6721-476c-9437-c7e82d13a3aa", "name": "List statements by member", "request": { "name": "List statements by member", "description": { "content": "Use this endpoint to get an array of available statements.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "53fb68e7-06e6-4972-b0ac-160534d1cf8c", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statements\": [\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"content_hash\": \"ca53785b812d00ef821c3d94bfd6e5bbc0020504410589b7ea8552169f021981\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"STA-737a344b-caae-0f6e-1384-01f52e75dcb1\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"uri\": \"uri/to/statement\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n },\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"content_hash\": \"ca53785b812d00ef821c3d94bfd6e5bbc0020504410589b7ea8552169f021981\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"STA-737a344b-caae-0f6e-1384-01f52e75dcb1\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"uri\": \"uri/to/statement\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "7bc906ad-ad28-40bb-aed4-0f47f909a320", "name": "Read statement by member", "request": { "name": "Read statement by member", "description": { "content": "Use this endpoint to read a JSON representation of the statement.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "statements", ":statement_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "statement_guid", "description": "(Required) The unique id for a `statement`." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9c918c4b-479f-4112-8202-31cf89db5544", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "statements", ":statement_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "statement_guid", "description": "(Required) The unique id for a `statement`." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statement\": {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"content_hash\": \"ca53785b812d00ef821c3d94bfd6e5bbc0020504410589b7ea8552169f021981\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"guid\": \"STA-737a344b-caae-0f6e-1384-01f52e75dcb1\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"uri\": \"uri/to/statement\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "e8305acc-d724-4c61-a783-766a50cb8d8b", "name": "Download statement pdf", "request": { "name": "Download statement pdf", "description": { "content": "Use this endpoint to download a specified statement PDF.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "statements", "{{statement_guid}}.pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/vnd.mx.api.v1+pdf" } ], "method": "GET", "auth": null }, "response": [ { "id": "9cfc925a-149a-4e60-8f39-0fa92b5da9ce", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "statements", "{{statement_guid}}.pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.mx.api.v1+pdf" } ], "body": "sunt voluptate", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] } ], "event": [] }, { "id": "e0c2b085-3506-42e3-86f3-5800560a928e", "name": "taggings", "description": { "content": "Tags and taggings are two resources in the MX Platform API that, when used together, give end users more control over organizing their transactions. \n\nA tag is a custom label that can be applied to a transaction.\n\nAfter you create a tag, use it for tagging. This means you should actually apply the tag to a particular transaction.\n\nTogether, they're a powerful tool for personalization, customization, and money management.\n\nFor a guide on creating a tag and then applying it to a specific transaction with a tagging, see [Custom Tags and Taggings](docs.mx.com/products/experience/pfm/integration-guides/personalization/).\n", "type": "text/plain" }, "item": [ { "id": "56ce2ad4-1c14-4f4c-bf64-91a0e76ce0f6", "name": "List taggings", "request": { "name": "List taggings", "description": { "content": "Use this endpoint to retrieve a list of all the taggings associated with a specific user.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "taggings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5982d5ae-be70-42db-addf-2af87ec213da", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "taggings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"taggings\": [\n {\n \"guid\": \"TGN-007f5486-17e1-45fc-8b87-8f03984430fe\",\n \"member_is_managed_by_user\": false,\n \"tag_guid\": \"TAG-40faf068-abb4-405c-8f6a-e883ed541fff\",\n \"transaction_guid\": \"TRN-810828b0-5210-4878-9bd3-f4ce514f90c4\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n },\n {\n \"guid\": \"TGN-007f5486-17e1-45fc-8b87-8f03984430fe\",\n \"member_is_managed_by_user\": false,\n \"tag_guid\": \"TAG-40faf068-abb4-405c-8f6a-e883ed541fff\",\n \"transaction_guid\": \"TRN-810828b0-5210-4878-9bd3-f4ce514f90c4\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "c83b6434-eb05-4e2d-ae05-962c5394a5de", "name": "Create tagging", "request": { "name": "Create tagging", "description": { "content": "Use this endpoint to create a new association between a tag and a particular transaction, according to their unique GUIDs.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "taggings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"tagging\": {\n \"tag_guid\": \"\",\n \"transaction_guid\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "38f56c2c-fde5-4a4a-8773-f5fe65074bd9", "name": "Accepted", "originalRequest": { "url": { "path": [ "users", ":user_guid", "taggings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tagging\": {\n \"tag_guid\": \"TAG-40faf068-abb4-405c-8f6a-e883ed541fff\",\n \"transaction_guid\": \"TRN-810828b0-5210-4878-9bd3-f4ce514f90c4\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tagging\": {\n \"guid\": \"TGN-007f5486-17e1-45fc-8b87-8f03984430fe\",\n \"member_is_managed_by_user\": false,\n \"tag_guid\": \"TAG-40faf068-abb4-405c-8f6a-e883ed541fff\",\n \"transaction_guid\": \"TRN-810828b0-5210-4878-9bd3-f4ce514f90c4\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e62dacb-5264-46a7-a129-5e8c953b498d", "name": "Delete tagging", "request": { "name": "Delete tagging", "description": { "content": "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.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "taggings", ":tagging_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tagging_guid", "description": "(Required) The unique id for a `tagging`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "2997857a-3861-4c00-819c-4a3821cfed71", "name": "No Content", "originalRequest": { "url": { "path": [ "users", ":user_guid", "taggings", ":tagging_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tagging_guid", "description": "(Required) The unique id for a `tagging`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "2df9ba81-a0c1-45f8-ad0c-98b56a2b1d3f", "name": "Read tagging", "request": { "name": "Read tagging", "description": { "content": "Use this endpoint to read the attributes of a `tagging` according to its unique GUID.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "taggings", ":tagging_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tagging_guid", "description": "(Required) The unique id for a `tagging`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b5c2e691-dcbb-4dc2-a02b-d3e27892c6d0", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "taggings", ":tagging_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tagging_guid", "description": "(Required) The unique id for a `tagging`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tagging\": {\n \"guid\": \"TGN-007f5486-17e1-45fc-8b87-8f03984430fe\",\n \"member_is_managed_by_user\": false,\n \"tag_guid\": \"TAG-40faf068-abb4-405c-8f6a-e883ed541fff\",\n \"transaction_guid\": \"TRN-810828b0-5210-4878-9bd3-f4ce514f90c4\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "46cb7f43-755e-470f-ab47-8f27725be1b3", "name": "Update tagging", "request": { "name": "Update tagging", "description": { "content": "Use this endpoint to update a tagging.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "taggings", ":tagging_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tagging_guid", "description": "(Required) The unique id for a `tagging`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"tagging\": {\n \"tag_guid\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "66f90862-bd9a-4a26-a57d-a2fac81a2585", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "taggings", ":tagging_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tagging_guid", "description": "(Required) The unique id for a `tagging`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"tagging\": {\n \"tag_guid\": \"TAG-40faf068-abb4-405c-8f6a-e883ed541fff\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tagging\": {\n \"guid\": \"TGN-007f5486-17e1-45fc-8b87-8f03984430fe\",\n \"member_is_managed_by_user\": false,\n \"tag_guid\": \"TAG-40faf068-abb4-405c-8f6a-e883ed541fff\",\n \"transaction_guid\": \"TRN-810828b0-5210-4878-9bd3-f4ce514f90c4\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0d1d5e3e-85a8-4484-865a-90e9c0ae8c0f", "name": "tags", "description": { "content": "Tags and taggings are two resources in the MX Platform API that, when used together, give end users more control over organizing their transactions. \n\nA tag is a custom label that can be applied to a transaction.\n\nAfter you create a tag, use it for tagging. This means you should actually apply the tag to a particular transaction.\n\nTogether, they're a powerful tool for personalization, customization, and money management.\n\nFor a guide on creating a tag and then applying it to a specific transaction with a tagging, see [Custom Tags and Taggings](docs.mx.com/products/experience/pfm/integration-guides/personalization/).\n", "type": "text/plain" }, "item": [ { "id": "38e91cd9-8d33-4e4b-9746-9ea0c1809e61", "name": "List tags", "request": { "name": "List tags", "description": { "content": "Use this endpoint to list all tags associated with the specified `user`. Each user includes the `Business` tag by default.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9a33a6ef-3a43-42f4-a766-80646665099d", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tags\": [\n {\n \"guid\": \"TAG-aef36e72-6294-4c38-844d-e573e80aed52\",\n \"name\": \"MY TAG\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n },\n {\n \"guid\": \"TAG-aef36e72-6294-4c38-844d-e573e80aed52\",\n \"name\": \"MY TAG\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "12723a58-aa1c-4399-b4b5-b8d6f2ddfe27", "name": "Create tag", "request": { "name": "Create tag", "description": { "content": "Use this endpoint to create a new custom tag.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"tag\": {\n \"name\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "504383ec-c642-498c-a468-cfb3830db9d8", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tag\": {\n \"name\": \"MY TAG\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tag\": {\n \"guid\": \"TAG-aef36e72-6294-4c38-844d-e573e80aed52\",\n \"name\": \"MY TAG\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "11db8783-3527-4d6c-b80d-c621d49f3670", "name": "Delete tag", "request": { "name": "Delete tag", "description": { "content": "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`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "tags", ":tag_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tag_guid", "description": "(Required) The unique id for a `tag`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "61f75c57-72d6-4f6e-b7c6-39b845a4f7ba", "name": "No Content", "originalRequest": { "url": { "path": [ "users", ":user_guid", "tags", ":tag_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tag_guid", "description": "(Required) The unique id for a `tag`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "(Required) Specifies the media type expected in the response.", "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "7b448d37-57c1-47de-a9d3-b83be29e32c0", "name": "Read tag", "request": { "name": "Read tag", "description": { "content": "Use this endpoint to read the attributes of a particular tag according to its unique GUID.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "tags", ":tag_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tag_guid", "description": "(Required) The unique id for a `tag`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2d920a65-4f35-4e5c-a637-6592393628b8", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "tags", ":tag_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tag_guid", "description": "(Required) The unique id for a `tag`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tag\": {\n \"guid\": \"TAG-aef36e72-6294-4c38-844d-e573e80aed52\",\n \"name\": \"MY TAG\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "ef73b56f-8d31-497b-9952-3935006774bb", "name": "Update tag", "request": { "name": "Update tag", "description": { "content": "Use this endpoint to update the name of a specific tag according to its unique GUID.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "tags", ":tag_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tag_guid", "description": "(Required) The unique id for a `tag`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"tag\": {\n \"name\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "26a78255-b8ae-4651-85d6-62a61c201a2b", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "tags", ":tag_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tag_guid", "description": "(Required) The unique id for a `tag`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"tag\": {\n \"name\": \"MY TAG\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tag\": {\n \"guid\": \"TAG-aef36e72-6294-4c38-844d-e573e80aed52\",\n \"name\": \"MY TAG\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "fbe07a1e-69fb-4194-bb4a-53cc30802e2e", "name": "transaction rules", "description": { "content": "Transaction Rules allow users to automatically recategorize or rename all similar transactions according to their preferences. This only applies to future transactions.\n\nWhen recategorizing or renaming a transaction, the user will be asked whether they want the new data to apply to the selected transaction or to all future transactions. If they choose to apply it to all future transactions, it will create a transaction rule which will automatically apply the changes going forward.\n", "type": "text/plain" }, "item": [ { "id": "cf78307a-20ee-45ae-9e86-08039ae1701c", "name": "List transaction rules", "request": { "name": "List transaction rules", "description": { "content": "Use this endpoint to read the attributes of all existing transaction rules belonging to the user.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "transaction_rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "70ad19cd-7087-4b41-8d27-50a29b74fb4a", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "transaction_rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transaction_rules\": [\n {\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"description\": \"Wal-mart food storage\",\n \"guid\": \"TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3\",\n \"match_description\": \"Wal-mart\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n },\n {\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"description\": \"Wal-mart food storage\",\n \"guid\": \"TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3\",\n \"match_description\": \"Wal-mart\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "14b1f320-dbb1-4f6a-a659-f8c8808cb16d", "name": "Create transaction rule", "request": { "name": "Create transaction rule", "description": { "content": "Use this endpoint to create a new transaction rule. The newly-created `transaction_rule` object will be returned if successful.\n\nFor more information about transaction rules, see the [Transaction Rules Guide](/products/experience/pfm/integration-guides/personalization/transaction-rules).\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "transaction_rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"transaction_rule\": {\n \"category_guid\": \"\",\n \"match_description\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "70dfb7e6-98cc-469f-9409-bb94fd37a3a7", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "transaction_rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transaction_rule\": {\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"match_description\": \"Wal-mart\",\n \"description\": \"Wal-mart food storage\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transaction_rule\": {\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"description\": \"Wal-mart food storage\",\n \"guid\": \"TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3\",\n \"match_description\": \"Wal-mart\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3cc38d2-8eee-48d9-9414-5c23bf9fb317", "name": "Read transaction rule", "request": { "name": "Read transaction rule", "description": { "content": "Use this endpoint to read the attributes of an existing transaction rule based on the rule’s unique GUID.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "transaction_rules", ":transaction_rule_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_rule_guid", "description": "(Required) The unique id for a `transaction_rule`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "bc9de044-0b61-47b2-930a-abc9ff54d652", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "transaction_rules", ":transaction_rule_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_rule_guid", "description": "(Required) The unique id for a `transaction_rule`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transaction_rule\": {\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"description\": \"Wal-mart food storage\",\n \"guid\": \"TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3\",\n \"match_description\": \"Wal-mart\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "612bdef0-ef43-4f83-b3f1-1fa4cde9eec2", "name": "Update transaction rule", "request": { "name": "Update transaction rule", "description": { "content": "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.\n\nFor more information about transaction rules, see the [Transaction Rules Guide](/products/experience/pfm/integration-guides/personalization/transaction-rules).\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "transaction_rules", ":transaction_rule_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_rule_guid", "description": "(Required) The unique id for a `transaction_rule`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"transaction_rule\": {\n \"category_guid\": \"\",\n \"description\": \"\",\n \"match_description\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2e99ca67-8109-4e45-a955-617ff6eaa402", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "transaction_rules", ":transaction_rule_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_rule_guid", "description": "(Required) The unique id for a `transaction_rule`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"transaction_rule\": {\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"description\": \"Wal-mart food storage\",\n \"match_description\": \"Wal-mart\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transaction_rule\": {\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"description\": \"Wal-mart food storage\",\n \"guid\": \"TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3\",\n \"match_description\": \"Wal-mart\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "59f8d557-7796-4973-a8f6-15ea2ce04fb4", "name": "transactions", "description": { "content": "Transactions represent any instance in which money moves into or out of an account. This could be a purchase at a business, a payroll deposit, a transfer from one account to another, an ATM withdrawal, and so on.\n\nTransactions are created automatically when a member is successfully aggregated.\n\nEach `transaction` belongs to only one `account`.\n\nFor more info, see [Transactions Overview](docs.mx.com/api-reference/reference/transactions).\n", "type": "text/plain" }, "item": [ { "id": "6f1b5f62-2554-43cf-9423-55511b860870", "name": "Enhance transactions", "request": { "name": "Enhance transactions", "description": { "content": "Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform.

For more information on returned data, please see the [Enhanced Transactions fields guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions).", "type": "text/plain" }, "url": { "path": [ "transactions", "enhance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"amount\": \"\",\n \"extended_transaction_type\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"type\": \"\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"amount\": \"\",\n \"extended_transaction_type\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"type\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5dd204e2-cce4-4987-8cac-13e549f88496", "name": "OK", "originalRequest": { "url": { "path": [ "transactions", "enhance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n {\n \"description\": \"ubr* pending.uber.com\",\n \"id\": \"ID-123\",\n \"amount\": 61.11,\n \"extended_transaction_type\": \"partner_transaction_type\",\n \"memo\": \"Additional-information*on_transaction\",\n \"merchant_category_code\": 4121,\n \"type\": \"DEBIT\"\n },\n {\n \"description\": \"ubr* pending.uber.com\",\n \"id\": \"ID-123\",\n \"amount\": 61.11,\n \"extended_transaction_type\": \"partner_transaction_type\",\n \"memo\": \"Additional-information*on_transaction\",\n \"merchant_category_code\": 4121,\n \"type\": \"DEBIT\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transactions\": [\n {\n \"amount\": 61.11,\n \"categorized_by\": 13,\n \"category\": \"Paycheck\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"described_by\": 6,\n \"description\": \"Uber\",\n \"extended_transaction_type\": \"partner_transaction_type\",\n \"id\": \"ID-123\",\n \"is_bill_pay\": false,\n \"is_direct_deposit\": false,\n \"is_expense\": false,\n \"is_fee\": false,\n \"is_income\": false,\n \"is_international\": false,\n \"is_overdraft_fee\": false,\n \"is_payroll_advance\": false,\n \"is_subscription\": false,\n \"memo\": \"Additional-information*on_transaction\",\n \"merchant_category_code\": 4121,\n \"merchant_guid\": \"MCH-14f25b63-ef47-a38e-b2b6-d02b280b6e4e\",\n \"merchant_location_guid\": \"MCL-00024e59-18b5-4d79-b879-2a7896726fea\",\n \"original_description\": \"ubr* pending.uber.com\",\n \"top_level_category_guid\": \"CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8\",\n \"type\": \"DEBIT\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n },\n {\n \"amount\": 61.11,\n \"categorized_by\": 13,\n \"category\": \"Paycheck\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"described_by\": 6,\n \"description\": \"Uber\",\n \"extended_transaction_type\": \"partner_transaction_type\",\n \"id\": \"ID-123\",\n \"is_bill_pay\": false,\n \"is_direct_deposit\": false,\n \"is_expense\": false,\n \"is_fee\": false,\n \"is_income\": false,\n \"is_international\": false,\n \"is_overdraft_fee\": false,\n \"is_payroll_advance\": false,\n \"is_subscription\": false,\n \"memo\": \"Additional-information*on_transaction\",\n \"merchant_category_code\": 4121,\n \"merchant_guid\": \"MCH-14f25b63-ef47-a38e-b2b6-d02b280b6e4e\",\n \"merchant_location_guid\": \"MCL-00024e59-18b5-4d79-b879-2a7896726fea\",\n \"original_description\": \"ubr* pending.uber.com\",\n \"top_level_category_guid\": \"CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8\",\n \"type\": \"DEBIT\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "264c4a61-3d89-4b10-b2b6-b10b3b724b2a", "name": "Create manual transaction", "request": { "name": "Create manual transaction", "description": { "content": "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.\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "accounts", ":account_guid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"category_guid\": \"\",\n \"currency_code\": \"\",\n \"has_been_viewed\": \"\",\n \"is_hidden\": \"\",\n \"is_international\": \"\",\n \"memo\": \"\",\n \"metadata\": \"\",\n \"skip_webhook\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0a7866b8-207b-4adc-9977-571d398d6898", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "accounts", ":account_guid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": 61.11,\n \"date\": \"2016-10-06\",\n \"description\": \"Whole foods\",\n \"type\": \"DEBIT\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"currency_code\": \"USD\",\n \"has_been_viewed\": false,\n \"is_hidden\": false,\n \"is_international\": false,\n \"memo\": \"This is a memo\",\n \"metadata\": \"some metadata\",\n \"skip_webhook\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_id\": \"account123\",\n \"amount\": 61.11,\n \"category\": \"Groceries\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"check_number_string\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"currency_code\": \"USD\",\n \"date\": \"2016-10-06T00:00:00.000Z\",\n \"description\": \"Whole foods\",\n \"extended_transaction_type\": null,\n \"guid\": \"TRN-265abee9-889b-af6a-c69b-25157db2bdd9\",\n \"id\": null,\n \"is_bill_pay\": false,\n \"is_direct_deposit\": false,\n \"is_expense\": true,\n \"is_fee\": false,\n \"is_income\": false,\n \"is_international\": false,\n \"is_manual\": false,\n \"is_overdraft_fee\": false,\n \"is_payroll_advance\": false,\n \"is_recurring\": null,\n \"is_subscription\": false,\n \"latitude\": null,\n \"localized_description\": null,\n \"localized_memo\": null,\n \"longitude\": null,\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_is_managed_by_user\": true,\n \"memo\": \"This is a memo\",\n \"merchant_category_code\": null,\n \"merchant_guid\": null,\n \"merchant_location_guid\": null,\n \"metadata\": \"some metadata\",\n \"original_description\": null,\n \"posted_at\": null,\n \"status\": \"POSTED\",\n \"top_level_category\": \"Food & Dining\",\n \"transacted_at\": null,\n \"type\": \"DEBIT\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9060c654-bbfa-41a6-8cf6-51d6da77b727", "name": "List transactions by account", "request": { "name": "List transactions by account", "description": { "content": "Requests to this endpoint return a list of transactions associated with the specified account.

Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "accounts", ":account_guid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." }, { "disabled": false, "key": "from_date", "value": "", "description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided." }, { "disabled": false, "key": "to_date", "value": "", "description": "Filter transactions to this date (at midnight). This only supports unix timestamp format. Defaults to 5 days forward from the day the request is made to capture pending transactions." }, { "disabled": false, "key": "from_created_at", "value": "", "description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format." }, { "disabled": false, "key": "to_created_at", "value": "", "description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format." }, { "disabled": false, "key": "from_updated_at", "value": "", "description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format." }, { "disabled": false, "key": "to_updated_at", "value": "", "description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format." }, { "disabled": false, "key": "includes", "value": "", "description": "Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append:\n\n`?includes=repeating_transactions,merchants,classifications,geolocations`. \n \nThe query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: \n\n`?includes=repeating_transactions,geolocations`.\n\n- Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription).\n- Merchants: Enriches transactions with merchant name.\n- Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments.\n- Geolocation: Provides geographic metadata.\n" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "254b3029-00b7-4cee-992d-f191cbadf367", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "accounts", ":account_guid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" }, { "key": "from_date", "value": "1666936800" }, { "key": "to_date", "value": "1698472800" }, { "key": "from_created_at", "value": "1666936800" }, { "key": "to_created_at", "value": "1698472800" }, { "key": "from_updated_at", "value": "1666936800" }, { "key": "to_updated_at", "value": "1698472800" }, { "key": "includes", "value": "repeating_transactions,merchants,classifications,geolocations" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transactions\": [\n {\n \"classification\": {\n \"value\": \"\"\n },\n \"geolocation\": {\n \"value\": \"\"\n },\n \"merchant\": {\n \"value\": \"\"\n },\n \"repeating_transaction\": {\n \"value\": \"\"\n }\n },\n {\n \"classification\": {\n \"value\": \"\"\n },\n \"geolocation\": {\n \"value\": \"\"\n },\n \"merchant\": {\n \"value\": \"\"\n },\n \"repeating_transaction\": {\n \"value\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "c85dc0cb-221f-4b3e-8f0b-364efef4e747", "name": "List transactions by account per member", "request": { "name": "List transactions by account per member", "description": { "content": "Requests to this endpoint return a list of transactions associated with the specified account.

Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." }, { "disabled": false, "key": "from_date", "value": "", "description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided." }, { "disabled": false, "key": "to_date", "value": "", "description": "Filter transactions to this date (at midnight). This only supports unix timestamp format. Defaults to 5 days forward from the day the request is made to capture pending transactions." }, { "disabled": false, "key": "from_created_at", "value": "", "description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format." }, { "disabled": false, "key": "to_created_at", "value": "", "description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format." }, { "disabled": false, "key": "from_updated_at", "value": "", "description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format." }, { "disabled": false, "key": "to_updated_at", "value": "", "description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format." }, { "disabled": false, "key": "includes", "value": "", "description": "Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append:\n\n`?includes=repeating_transactions,merchants,classifications,geolocations`. \n \nThe query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: \n\n`?includes=repeating_transactions,geolocations`.\n\n- Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription).\n- Merchants: Enriches transactions with merchant name.\n- Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments.\n- Geolocation: Provides geographic metadata.\n" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "account_identifier", "description": "(Required) Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "357398fb-6606-4585-885d-2994710f290e", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" }, { "key": "from_date", "value": "1666936800" }, { "key": "to_date", "value": "1698472800" }, { "key": "from_created_at", "value": "1666936800" }, { "key": "to_created_at", "value": "1698472800" }, { "key": "from_updated_at", "value": "1666936800" }, { "key": "to_updated_at", "value": "1698472800" }, { "key": "includes", "value": "repeating_transactions,merchants,classifications,geolocations" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "account_identifier", "description": "(Required) Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transactions\": [\n {\n \"classification\": {\n \"value\": \"\"\n },\n \"geolocation\": {\n \"value\": \"\"\n },\n \"merchant\": {\n \"value\": \"\"\n },\n \"repeating_transaction\": {\n \"value\": \"\"\n }\n },\n {\n \"classification\": {\n \"value\": \"\"\n },\n \"geolocation\": {\n \"value\": \"\"\n },\n \"merchant\": {\n \"value\": \"\"\n },\n \"repeating_transaction\": {\n \"value\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "628a05e1-d1eb-45b1-9429-d4141fa88a53", "name": "Extend history", "request": { "name": "Extend history", "description": { "content": "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.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "extend_history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "e701389f-66be-40c5-b00b-572b873ed27b", "name": "Accepted", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "extend_history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "e44ee8ad-30a1-4cca-bacb-2a43a927b0d6", "name": "List transactions by member", "request": { "name": "List transactions by member", "description": { "content": "Requests to this endpoint return a list of transactions associated with the specified `member`, across all accounts associated with that `member`.

Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." }, { "disabled": false, "key": "from_date", "value": "", "description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided." }, { "disabled": false, "key": "to_date", "value": "", "description": "Filter transactions to this date (at midnight). This only supports unix timestamp format. Defaults to 5 days forward from the day the request is made to capture pending transactions." }, { "disabled": false, "key": "from_created_at", "value": "", "description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format." }, { "disabled": false, "key": "to_created_at", "value": "", "description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format." }, { "disabled": false, "key": "from_timestamp", "value": "", "description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format." }, { "disabled": false, "key": "to_timestamp", "value": "", "description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format." }, { "disabled": false, "key": "from_updated_at", "value": "", "description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format." }, { "disabled": false, "key": "to_updated_at", "value": "", "description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format." }, { "disabled": false, "key": "includes", "value": "", "description": "Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append:\n\n`?includes=repeating_transactions,merchants,classifications,geolocations`. \n \nThe query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: \n\n`?includes=repeating_transactions,geolocations`.\n\n- Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription).\n- Merchants: Enriches transactions with merchant name.\n- Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments.\n- Geolocation: Provides geographic metadata.\n" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "80dde599-492c-4599-a5a2-2884522983aa", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" }, { "key": "from_date", "value": "1666936800" }, { "key": "to_date", "value": "1698472800" }, { "key": "from_created_at", "value": "1666936800" }, { "key": "to_created_at", "value": "1698472800" }, { "key": "from_timestamp", "value": "1666936800" }, { "key": "to_timestamp", "value": "1698472800" }, { "key": "from_updated_at", "value": "1666936800" }, { "key": "to_updated_at", "value": "1698472800" }, { "key": "includes", "value": "repeating_transactions,merchants,classifications,geolocations" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transactions\": [\n {\n \"classification\": {\n \"value\": \"\"\n },\n \"geolocation\": {\n \"value\": \"\"\n },\n \"merchant\": {\n \"value\": \"\"\n },\n \"repeating_transaction\": {\n \"value\": \"\"\n }\n },\n {\n \"classification\": {\n \"value\": \"\"\n },\n \"geolocation\": {\n \"value\": \"\"\n },\n \"merchant\": {\n \"value\": \"\"\n },\n \"repeating_transaction\": {\n \"value\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "a9cbafff-0920-4988-b129-fc9daa04bc4e", "name": "List transactions by tag", "request": { "name": "List transactions by tag", "description": { "content": "Use this endpoint to get a list of all transactions associated with a particular tag according to the tag's unique GUID. This lists all transactions that have been assigned to a particular tag using the create tagging endpoint.

Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "tags", ":tag_guid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." }, { "disabled": false, "key": "from_date", "value": "", "description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided." }, { "disabled": false, "key": "to_date", "value": "", "description": "Filter transactions to this date (at midnight). This only supports unix timestamp format. Defaults to 5 days forward from the day the request is made to capture pending transactions." }, { "disabled": false, "key": "from_created_at", "value": "", "description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format." }, { "disabled": false, "key": "to_created_at", "value": "", "description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format." }, { "disabled": false, "key": "from_updated_at", "value": "", "description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format." }, { "disabled": false, "key": "to_updated_at", "value": "", "description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format." }, { "disabled": false, "key": "includes", "value": "", "description": "Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append:\n\n`?includes=repeating_transactions,merchants,classifications,geolocations`. \n \nThe query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: \n\n`?includes=repeating_transactions,geolocations`.\n\n- Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription).\n- Merchants: Enriches transactions with merchant name.\n- Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments.\n- Geolocation: Provides geographic metadata.\n" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "tag_guid", "description": "(Required) The unique id for a `tag`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "01275685-f362-4f19-9a37-29fcce2f884d", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "tags", ":tag_guid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" }, { "key": "from_date", "value": "1666936800" }, { "key": "to_date", "value": "1698472800" }, { "key": "from_created_at", "value": "1666936800" }, { "key": "to_created_at", "value": "1698472800" }, { "key": "from_updated_at", "value": "1666936800" }, { "key": "to_updated_at", "value": "1698472800" }, { "key": "includes", "value": "repeating_transactions,merchants,classifications,geolocations" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "tag_guid", "description": "(Required) The unique id for a `tag`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transactions\": [\n {\n \"classification\": {\n \"value\": \"\"\n },\n \"geolocation\": {\n \"value\": \"\"\n },\n \"merchant\": {\n \"value\": \"\"\n },\n \"repeating_transaction\": {\n \"value\": \"\"\n }\n },\n {\n \"classification\": {\n \"value\": \"\"\n },\n \"geolocation\": {\n \"value\": \"\"\n },\n \"merchant\": {\n \"value\": \"\"\n },\n \"repeating_transaction\": {\n \"value\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "ef747e88-d5e1-47bc-b9e2-5529eed7ed1a", "name": "Delete transaction rule", "request": { "name": "Delete transaction rule", "description": { "content": "Use this endpoint to permanently delete a transaction rule based on its unique GUID.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "transaction_rules", ":transaction_rule_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_rule_guid", "description": "(Required) The unique id for a `transaction_rule`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "2e8d8937-ced0-4e90-a93a-1b86a793ba01", "name": "No Content", "originalRequest": { "url": { "path": [ "users", ":user_guid", "transaction_rules", ":transaction_rule_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_rule_guid", "description": "(Required) The unique id for a `transaction_rule`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "f2eba35d-4fc2-4a34-a53d-85f63861c91d", "name": "List transactions", "request": { "name": "List transactions", "description": { "content": "Requests to this endpoint return a list of transactions associated with the specified `user`, across all members and accounts associated with that `user`.

Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." }, { "disabled": false, "key": "from_date", "value": "", "description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided." }, { "disabled": false, "key": "to_date", "value": "", "description": "Filter transactions to this date (at midnight). This only supports unix timestamp format. Defaults to 5 days forward from the day the request is made to capture pending transactions." }, { "disabled": false, "key": "from_created_at", "value": "", "description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format." }, { "disabled": false, "key": "to_created_at", "value": "", "description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format." }, { "disabled": false, "key": "from_updated_at", "value": "", "description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format." }, { "disabled": false, "key": "to_updated_at", "value": "", "description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format." }, { "disabled": false, "key": "use_case", "value": "", "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`." }, { "disabled": false, "key": "includes", "value": "", "description": "Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append:\n\n`?includes=repeating_transactions,merchants,classifications,geolocations`. \n \nThe query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: \n\n`?includes=repeating_transactions,geolocations`.\n\n- Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription).\n- Merchants: Enriches transactions with merchant name.\n- Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments.\n- Geolocation: Provides geographic metadata.\n" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "08d56f31-e773-4874-bff0-76a84c2c4fc5", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" }, { "key": "from_date", "value": "1666936800" }, { "key": "to_date", "value": "1698472800" }, { "key": "from_created_at", "value": "1666936800" }, { "key": "to_created_at", "value": "1698472800" }, { "key": "from_updated_at", "value": "1666936800" }, { "key": "to_updated_at", "value": "1698472800" }, { "key": "use_case", "value": "" }, { "key": "includes", "value": "repeating_transactions,merchants,classifications,geolocations" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transactions\": [\n {\n \"classification\": {\n \"value\": \"\"\n },\n \"geolocation\": {\n \"value\": \"\"\n },\n \"merchant\": {\n \"value\": \"\"\n },\n \"repeating_transaction\": {\n \"value\": \"\"\n }\n },\n {\n \"classification\": {\n \"value\": \"\"\n },\n \"geolocation\": {\n \"value\": \"\"\n },\n \"merchant\": {\n \"value\": \"\"\n },\n \"repeating_transaction\": {\n \"value\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "92ec0d2e-27f3-4176-867f-0faf4627d2d3", "name": "Read transaction", "request": { "name": "Read transaction", "description": { "content": "Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`.

Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "transactions", ":transaction_guid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "includes", "value": "", "description": "Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append:\n\n`?includes=repeating_transactions,merchants,classifications,geolocations`. \n \nThe query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: \n\n`?includes=repeating_transactions,geolocations`.\n\n- Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription).\n- Merchants: Enriches transactions with merchant name.\n- Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments.\n- Geolocation: Provides geographic metadata.\n" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2ab12e61-5436-479c-9a1e-41efe64a276d", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "transactions", ":transaction_guid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includes", "value": "repeating_transactions,merchants,classifications,geolocations" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transaction\": {\n \"account_guid\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"amount\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"category_guid\": {\n \"value\": \"\"\n },\n \"check_number_string\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"date\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"extended_transaction_type\": {\n \"value\": \"\"\n },\n \"guid\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"is_bill_pay\": {\n \"value\": \"\"\n },\n \"is_direct_deposit\": {\n \"value\": \"\"\n },\n \"is_expense\": {\n \"value\": \"\"\n },\n \"is_fee\": {\n \"value\": \"\"\n },\n \"is_income\": {\n \"value\": \"\"\n },\n \"is_international\": {\n \"value\": \"\"\n },\n \"is_manual\": {\n \"value\": \"\"\n },\n \"is_overdraft_fee\": {\n \"value\": \"\"\n },\n \"is_payroll_advance\": {\n \"value\": \"\"\n },\n \"is_recurring\": {\n \"value\": \"\"\n },\n \"is_subscription\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"localized_description\": {\n \"value\": \"\"\n },\n \"localized_memo\": {\n \"value\": \"\"\n },\n \"longitude\": {\n \"value\": \"\"\n },\n \"member_guid\": {\n \"value\": \"\"\n },\n \"member_is_managed_by_user\": {\n \"value\": \"\"\n },\n \"memo\": {\n \"value\": \"\"\n },\n \"merchant_category_code\": {\n \"value\": \"\"\n },\n \"merchant_guid\": {\n \"value\": \"\"\n },\n \"merchant_location_guid\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"original_description\": {\n \"value\": \"\"\n },\n \"posted_at\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"top_level_category\": {\n \"value\": \"\"\n },\n \"transacted_at\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"user_guid\": {\n \"value\": \"\"\n },\n \"user_id\": {\n \"value\": \"\"\n },\n \"classification\": {\n \"parent_class\": {\n \"value\": \"\"\n },\n \"guid\": {\n \"value\": \"\"\n }\n },\n \"geolocation\": {\n \"country\": {\n \"value\": \"\"\n },\n \"state\": {\n \"value\": \"\"\n },\n \"city\": {\n \"value\": \"\"\n },\n \"postal code\": {\n \"value\": \"\"\n }\n },\n \"merchant\": {\n \"name\": {\n \"value\": \"\"\n },\n \"guid\": {\n \"value\": \"\"\n },\n \"logo_url\": {\n \"value\": \"\"\n },\n \"website_url\": {\n \"value\": \"\"\n }\n },\n \"repeating_transaction\": {\n \"repeating_transaction_type\": {\n \"value\": \"\"\n },\n \"recurrence_type\": {\n \"value\": \"\"\n },\n \"guid\": {\n \"value\": \"\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "2269801b-5514-4c92-bd41-12d6167e68cc", "name": "Update transaction", "request": { "name": "Update transaction", "description": { "content": "Use this endpoint to update a specific transaction according to its unique GUID.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "transactions", ":transaction_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"description\": \"\",\n \"date\": \"\",\n \"memo\": \"\",\n \"category_guid\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "55f28f92-a43f-443e-b91a-d8a2a8c1097c", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "transactions", ":transaction_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"description\": \"new description\",\n \"date\": \"\",\n \"memo\": \"\",\n \"category_guid\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transaction\": {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_id\": \"account123\",\n \"amount\": 61.11,\n \"category\": \"Paycheck\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"check_number_string\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"currency_code\": \"USD\",\n \"date\": \"2024-12-20\",\n \"description\": \"MX Technologies Payroll\",\n \"extended_transaction_type\": null,\n \"guid\": \"TRN-429ad9fe-a1d2-4559-8590-885b2603f0e1\",\n \"id\": \"1734681600000-178fa8095c154a55b9172f977b4c5f9a-0\",\n \"is_bill_pay\": false,\n \"is_direct_deposit\": false,\n \"is_expense\": false,\n \"is_fee\": false,\n \"is_income\": true,\n \"is_international\": false,\n \"is_manual\": false,\n \"is_overdraft_fee\": false,\n \"is_payroll_advance\": false,\n \"is_recurring\": null,\n \"is_subscription\": false,\n \"latitude\": null,\n \"localized_description\": \"This is a localized_description\",\n \"localized_memo\": \"This is a localized_memo\",\n \"longitude\": null,\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_is_managed_by_user\": true,\n \"memo\": \"Transactions\",\n \"merchant_category_code\": null,\n \"merchant_guid\": \"MCH-8cc3b01a-1c52-47d4-970d-30f8ee5566f1\",\n \"merchant_location_guid\": null,\n \"metadata\": \"some metadata\",\n \"original_description\": \"MX TECHNOLOGIES PAYMENT\",\n \"posted_at\": \"2024-12-20T12:00:00Z\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"Income\",\n \"transacted_at\": \"2024-12-20T12:00:00Z\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "579ae567-950c-4540-a508-2b8bb9ca1784", "name": "Delete manual transactions", "request": { "name": "Delete manual transactions", "description": { "content": "Delete a manual transaction. In the path, use the manual transaction guid as the `transaction_guid`, such as `MAN-810828b0-5210-4878-9bd3-f4ce514f90c4`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "transactions", ":transaction_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "7acdfcf7-c2fc-474d-845d-8ba6d8e5d277", "name": "No content", "originalRequest": { "url": { "path": [ "users", ":user_guid", "transactions", ":transaction_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "2644736b-7594-4911-a2fb-53ffe0cdb61c", "name": "Read transaction by account", "request": { "name": "Read transaction by account", "description": { "content": "Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`.

Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions", ":transaction_identifier" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "includes", "value": "", "description": "Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append:\n\n`?includes=repeating_transactions,merchants,classifications,geolocations`. \n \nThe query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: \n\n`?includes=repeating_transactions,geolocations`.\n\n- Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription).\n- Merchants: Enriches transactions with merchant name.\n- Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments.\n- Geolocation: Provides geographic metadata.\n" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "account_identifier", "description": "(Required) Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_identifier", "description": "(Required) Use either the transaction `id` you defined or the MX-defined transaction `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "19333c1f-2590-4a8a-b219-987a916877e4", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions", ":transaction_identifier" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includes", "value": "repeating_transactions,merchants,classifications,geolocations" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "account_identifier", "description": "(Required) Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_identifier", "description": "(Required) Use either the transaction `id` you defined or the MX-defined transaction `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transaction\": {\n \"account_guid\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"amount\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"category_guid\": {\n \"value\": \"\"\n },\n \"check_number_string\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"date\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"extended_transaction_type\": {\n \"value\": \"\"\n },\n \"guid\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"is_bill_pay\": {\n \"value\": \"\"\n },\n \"is_direct_deposit\": {\n \"value\": \"\"\n },\n \"is_expense\": {\n \"value\": \"\"\n },\n \"is_fee\": {\n \"value\": \"\"\n },\n \"is_income\": {\n \"value\": \"\"\n },\n \"is_international\": {\n \"value\": \"\"\n },\n \"is_manual\": {\n \"value\": \"\"\n },\n \"is_overdraft_fee\": {\n \"value\": \"\"\n },\n \"is_payroll_advance\": {\n \"value\": \"\"\n },\n \"is_recurring\": {\n \"value\": \"\"\n },\n \"is_subscription\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"localized_description\": {\n \"value\": \"\"\n },\n \"localized_memo\": {\n \"value\": \"\"\n },\n \"longitude\": {\n \"value\": \"\"\n },\n \"member_guid\": {\n \"value\": \"\"\n },\n \"member_is_managed_by_user\": {\n \"value\": \"\"\n },\n \"memo\": {\n \"value\": \"\"\n },\n \"merchant_category_code\": {\n \"value\": \"\"\n },\n \"merchant_guid\": {\n \"value\": \"\"\n },\n \"merchant_location_guid\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"original_description\": {\n \"value\": \"\"\n },\n \"posted_at\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"top_level_category\": {\n \"value\": \"\"\n },\n \"transacted_at\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"user_guid\": {\n \"value\": \"\"\n },\n \"user_id\": {\n \"value\": \"\"\n },\n \"classification\": {\n \"parent_class\": {\n \"value\": \"\"\n },\n \"guid\": {\n \"value\": \"\"\n }\n },\n \"geolocation\": {\n \"country\": {\n \"value\": \"\"\n },\n \"state\": {\n \"value\": \"\"\n },\n \"city\": {\n \"value\": \"\"\n },\n \"postal code\": {\n \"value\": \"\"\n }\n },\n \"merchant\": {\n \"name\": {\n \"value\": \"\"\n },\n \"guid\": {\n \"value\": \"\"\n },\n \"logo_url\": {\n \"value\": \"\"\n },\n \"website_url\": {\n \"value\": \"\"\n }\n },\n \"repeating_transaction\": {\n \"repeating_transaction_type\": {\n \"value\": \"\"\n },\n \"recurrence_type\": {\n \"value\": \"\"\n },\n \"guid\": {\n \"value\": \"\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "9514c65c-d467-4602-9742-0e45ab4e896c", "name": "Update transaction by account", "request": { "name": "Update transaction by account", "description": { "content": "Use this endpoint to update a specific transaction according to its unique GUID.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions", ":transaction_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "account_identifier", "description": "(Required) Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_identifier", "description": "(Required) Use either the transaction `id` you defined or the MX-defined transaction `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"description\": \"\",\n \"date\": \"\",\n \"memo\": \"\",\n \"category_guid\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "998f475b-1398-43a5-86d4-b2618b191f7a", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions", ":transaction_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "account_identifier", "description": "(Required) Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_identifier", "description": "(Required) Use either the transaction `id` you defined or the MX-defined transaction `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"description\": \"new description\",\n \"date\": \"\",\n \"memo\": \"\",\n \"category_guid\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transaction\": {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_id\": \"account123\",\n \"amount\": 61.11,\n \"category\": \"Paycheck\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"check_number_string\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"currency_code\": \"USD\",\n \"date\": \"2024-12-20\",\n \"description\": \"MX Technologies Payroll\",\n \"extended_transaction_type\": null,\n \"guid\": \"TRN-429ad9fe-a1d2-4559-8590-885b2603f0e1\",\n \"id\": \"1734681600000-178fa8095c154a55b9172f977b4c5f9a-0\",\n \"is_bill_pay\": false,\n \"is_direct_deposit\": false,\n \"is_expense\": false,\n \"is_fee\": false,\n \"is_income\": true,\n \"is_international\": false,\n \"is_manual\": false,\n \"is_overdraft_fee\": false,\n \"is_payroll_advance\": false,\n \"is_recurring\": null,\n \"is_subscription\": false,\n \"latitude\": null,\n \"localized_description\": \"This is a localized_description\",\n \"localized_memo\": \"This is a localized_memo\",\n \"longitude\": null,\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_is_managed_by_user\": true,\n \"memo\": \"Transactions\",\n \"merchant_category_code\": null,\n \"merchant_guid\": \"MCH-8cc3b01a-1c52-47d4-970d-30f8ee5566f1\",\n \"merchant_location_guid\": null,\n \"metadata\": \"some metadata\",\n \"original_description\": \"MX TECHNOLOGIES PAYMENT\",\n \"posted_at\": \"2024-12-20T12:00:00Z\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"Income\",\n \"transacted_at\": \"2024-12-20T12:00:00Z\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c665336d-77c8-4d71-a89b-f8f3c95482f1", "name": "List Repeating Transactions", "request": { "name": "List Repeating Transactions", "description": { "content": "Retrieve a list of all recurring transactions for a user.

For more see the [Repeating Transactions guide](/api-reference/platform-api/reference/transactions-overview#repeating-transactions).", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "repeating_transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d45697dc-a595-4289-b0ee-60ab99a35e8d", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "repeating_transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"repeating_transactions\": [\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"amount\": 61.11,\n \"description\": \"Dominion Energy\",\n \"guid\": \"RPT-a2264e1a-d2e6-41d9-88d2-2cfdf1143959\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"merchant_guid\": \"MCH-1b5d7e4d-fa29-95d1-fd0f-540b6f17d986\",\n \"last_posted_date\": \"2024-12-09\",\n \"predicted_occurs_on\": \"2025-01-09\",\n \"recurrence_type\": \"EVERY_MONTH\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"repeating_transaction_type\": \"SUBSCRIPTION\",\n \"transaction_type\": \"CREDIT\"\n },\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"amount\": 61.11,\n \"description\": \"Dominion Energy\",\n \"guid\": \"RPT-a2264e1a-d2e6-41d9-88d2-2cfdf1143959\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"merchant_guid\": \"MCH-1b5d7e4d-fa29-95d1-fd0f-540b6f17d986\",\n \"last_posted_date\": \"2024-12-09\",\n \"predicted_occurs_on\": \"2025-01-09\",\n \"recurrence_type\": \"EVERY_MONTH\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"repeating_transaction_type\": \"BILL\",\n \"transaction_type\": \"CREDIT\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "c1c7b575-39f3-4341-b2c6-3b748cf0a671", "name": "Get a Repeating Transaction", "request": { "name": "Get a Repeating Transaction", "description": { "content": "Get a Specific Repeating Transaction.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "repeating_transactions", ":repeating_transaction_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "repeating_transaction_guid", "description": "(Required) The unique id for a recurring transaction." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c325f9b8-caec-472c-9b66-068b1841aae5", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "repeating_transactions", ":repeating_transaction_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "repeating_transaction_guid", "description": "(Required) The unique id for a recurring transaction." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"repeating_transactions\": [\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"amount\": 61.11,\n \"description\": \"Dominion Energy\",\n \"guid\": \"RPT-a2264e1a-d2e6-41d9-88d2-2cfdf1143959\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"merchant_guid\": \"MCH-1b5d7e4d-fa29-95d1-fd0f-540b6f17d986\",\n \"last_posted_date\": \"2024-12-09\",\n \"predicted_occurs_on\": \"2025-01-09\",\n \"recurrence_type\": \"EVERY_MONTH\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"repeating_transaction_type\": \"BILL\",\n \"transaction_type\": \"DEBIT\"\n },\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"amount\": 61.11,\n \"description\": \"Dominion Energy\",\n \"guid\": \"RPT-a2264e1a-d2e6-41d9-88d2-2cfdf1143959\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"merchant_guid\": \"MCH-1b5d7e4d-fa29-95d1-fd0f-540b6f17d986\",\n \"last_posted_date\": \"2024-12-09\",\n \"predicted_occurs_on\": \"2025-01-09\",\n \"recurrence_type\": \"EVERY_MONTH\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"repeating_transaction_type\": \"BILL\",\n \"transaction_type\": \"DEBIT\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "ebf05908-1d87-4f3f-84de-38b0e71c4efa", "name": "Delete split transactions", "request": { "name": "Delete split transactions", "description": { "content": "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.", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "transactions", ":transaction_guid", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "9ce37f1f-dc00-483c-b702-82b95f17e79d", "name": "No content", "originalRequest": { "url": { "path": [ "users", ":user_guid", "transactions", ":transaction_guid", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "0e66b3b2-20c7-421e-b2d2-5a77337d9087", "name": "Create split transactions", "request": { "name": "Create split transactions", "description": { "content": "This endpoint creates two or more child transactions that are branched from a previous transaction. This endpoint allows you to link multiple categories, descriptions, and amounts to a parent transaction. When a split transaction is created, the parent transaction's `has_been_split` field will automatically be updated to true and the child transactions' `parent_guid` will have the transaction guid of the parent. The total amount of the child transactions must equal the amount of the parent transaction. Once a transaction has been split it can't be split again. In order to re-split a transaction, it must first be un-split. This can be done by calling the Delete Split Transactions endpoint. Calling this endpoint will delete the existing child transactions and update the parent transaction's `has_been_split` field to false. You can then re-split the parent transaction by calling Create Split Transaction again.\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "transactions", ":transaction_guid", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"transactions\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"category_guid\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "49836e8a-ffed-4e7f-b836-37204c4dee97", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "transactions", ":transaction_guid", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactions\": {\n \"amount\": 61.11,\n \"description\": \"Chevron Gas\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"memo\": \"Chips and Soda\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transactions\": [\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_id\": \"account123\",\n \"amount\": 61.11,\n \"category\": \"Paycheck\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"check_number_string\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"currency_code\": \"USD\",\n \"date\": \"2024-12-20\",\n \"description\": \"MX Technologies Payroll\",\n \"extended_transaction_type\": null,\n \"guid\": \"TRN-429ad9fe-a1d2-4559-8590-885b2603f0e1\",\n \"id\": \"1734681600000-178fa8095c154a55b9172f977b4c5f9a-0\",\n \"is_bill_pay\": false,\n \"is_direct_deposit\": false,\n \"is_expense\": false,\n \"is_fee\": false,\n \"is_income\": true,\n \"is_international\": false,\n \"is_manual\": false,\n \"is_overdraft_fee\": false,\n \"is_payroll_advance\": false,\n \"is_recurring\": null,\n \"is_subscription\": false,\n \"latitude\": null,\n \"localized_description\": \"This is a localized_description\",\n \"localized_memo\": \"This is a localized_memo\",\n \"longitude\": null,\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_is_managed_by_user\": true,\n \"memo\": \"Transactions\",\n \"merchant_category_code\": null,\n \"merchant_guid\": \"MCH-8cc3b01a-1c52-47d4-970d-30f8ee5566f1\",\n \"merchant_location_guid\": null,\n \"metadata\": \"some metadata\",\n \"original_description\": \"MX TECHNOLOGIES PAYMENT\",\n \"posted_at\": \"2024-12-20T12:00:00Z\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"Income\",\n \"transacted_at\": \"2024-12-20T12:00:00Z\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n },\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_id\": \"account123\",\n \"amount\": 61.11,\n \"category\": \"Paycheck\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"check_number_string\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"currency_code\": \"USD\",\n \"date\": \"2024-12-20\",\n \"description\": \"MX Technologies Payroll\",\n \"extended_transaction_type\": null,\n \"guid\": \"TRN-429ad9fe-a1d2-4559-8590-885b2603f0e1\",\n \"id\": \"1734681600000-178fa8095c154a55b9172f977b4c5f9a-0\",\n \"is_bill_pay\": false,\n \"is_direct_deposit\": false,\n \"is_expense\": false,\n \"is_fee\": false,\n \"is_income\": true,\n \"is_international\": false,\n \"is_manual\": false,\n \"is_overdraft_fee\": false,\n \"is_payroll_advance\": false,\n \"is_recurring\": null,\n \"is_subscription\": false,\n \"latitude\": null,\n \"localized_description\": \"This is a localized_description\",\n \"localized_memo\": \"This is a localized_memo\",\n \"longitude\": null,\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_is_managed_by_user\": true,\n \"memo\": \"Transactions\",\n \"merchant_category_code\": null,\n \"merchant_guid\": \"MCH-8cc3b01a-1c52-47d4-970d-30f8ee5566f1\",\n \"merchant_location_guid\": null,\n \"metadata\": \"some metadata\",\n \"original_description\": \"MX TECHNOLOGIES PAYMENT\",\n \"posted_at\": \"2024-12-20T12:00:00Z\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"Income\",\n \"transacted_at\": \"2024-12-20T12:00:00Z\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "47f407b9-371f-4e57-9f63-1574dbb7fef9", "name": "Delete split transactions by account", "request": { "name": "Delete split transactions by account", "description": { "content": "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.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions", ":transaction_identifier", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "account_identifier", "description": "(Required) Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_identifier", "description": "(Required) Use either the transaction `id` you defined or the MX-defined transaction `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "93832fce-1440-4205-b42e-1e42e236b638", "name": "No content", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions", ":transaction_identifier", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "account_identifier", "description": "(Required) Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_identifier", "description": "(Required) Use either the transaction `id` you defined or the MX-defined transaction `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "7e636c09-dce5-4735-95e3-4d75e80e6530", "name": "Create split transactions by account", "request": { "name": "Create split transactions by account", "description": { "content": "This endpoint creates two or more child transactions that are branched from a previous transaction. This endpoint allows you to link multiple categories, descriptions, and amounts to a parent transaction. When a split transaction is created, the parent transaction's `has_been_split` field will automatically be updated to true and the child transactions' `parent_guid` will have the transaction guid of the parent. The total amount of the child transactions must equal the amount of the parent transaction. Once a transaction has been split it can't be split again. In order to re-split a transaction, it must first be un-split. This can be done by calling the Delete Split Transactions endpoint. Calling this endpoint will delete the existing child transactions and update the parent transaction's `has_been_split` field to false. You can then re-split the parent transaction by calling Create Split Transaction again.\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions", ":transaction_identifier", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "account_identifier", "description": "(Required) Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_identifier", "description": "(Required) Use either the transaction `id` you defined or the MX-defined transaction `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"transactions\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"category_guid\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5a4dc0d6-ff7c-480c-b059-c65efe27b788", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions", ":transaction_identifier", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "account_identifier", "description": "(Required) Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_identifier", "description": "(Required) Use either the transaction `id` you defined or the MX-defined transaction `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactions\": {\n \"amount\": 61.11,\n \"description\": \"Chevron Gas\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"memo\": \"Chips and Soda\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transactions\": [\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_id\": \"account123\",\n \"amount\": 61.11,\n \"category\": \"Paycheck\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"check_number_string\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"currency_code\": \"USD\",\n \"date\": \"2024-12-20\",\n \"description\": \"MX Technologies Payroll\",\n \"extended_transaction_type\": null,\n \"guid\": \"TRN-429ad9fe-a1d2-4559-8590-885b2603f0e1\",\n \"id\": \"1734681600000-178fa8095c154a55b9172f977b4c5f9a-0\",\n \"is_bill_pay\": false,\n \"is_direct_deposit\": false,\n \"is_expense\": false,\n \"is_fee\": false,\n \"is_income\": true,\n \"is_international\": false,\n \"is_manual\": false,\n \"is_overdraft_fee\": false,\n \"is_payroll_advance\": false,\n \"is_recurring\": null,\n \"is_subscription\": false,\n \"latitude\": null,\n \"localized_description\": \"This is a localized_description\",\n \"localized_memo\": \"This is a localized_memo\",\n \"longitude\": null,\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_is_managed_by_user\": true,\n \"memo\": \"Transactions\",\n \"merchant_category_code\": null,\n \"merchant_guid\": \"MCH-8cc3b01a-1c52-47d4-970d-30f8ee5566f1\",\n \"merchant_location_guid\": null,\n \"metadata\": \"some metadata\",\n \"original_description\": \"MX TECHNOLOGIES PAYMENT\",\n \"posted_at\": \"2024-12-20T12:00:00Z\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"Income\",\n \"transacted_at\": \"2024-12-20T12:00:00Z\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n },\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_id\": \"account123\",\n \"amount\": 61.11,\n \"category\": \"Paycheck\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"check_number_string\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"currency_code\": \"USD\",\n \"date\": \"2024-12-20\",\n \"description\": \"MX Technologies Payroll\",\n \"extended_transaction_type\": null,\n \"guid\": \"TRN-429ad9fe-a1d2-4559-8590-885b2603f0e1\",\n \"id\": \"1734681600000-178fa8095c154a55b9172f977b4c5f9a-0\",\n \"is_bill_pay\": false,\n \"is_direct_deposit\": false,\n \"is_expense\": false,\n \"is_fee\": false,\n \"is_income\": true,\n \"is_international\": false,\n \"is_manual\": false,\n \"is_overdraft_fee\": false,\n \"is_payroll_advance\": false,\n \"is_recurring\": null,\n \"is_subscription\": false,\n \"latitude\": null,\n \"localized_description\": \"This is a localized_description\",\n \"localized_memo\": \"This is a localized_memo\",\n \"longitude\": null,\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_is_managed_by_user\": true,\n \"memo\": \"Transactions\",\n \"merchant_category_code\": null,\n \"merchant_guid\": \"MCH-8cc3b01a-1c52-47d4-970d-30f8ee5566f1\",\n \"merchant_location_guid\": null,\n \"metadata\": \"some metadata\",\n \"original_description\": \"MX TECHNOLOGIES PAYMENT\",\n \"posted_at\": \"2024-12-20T12:00:00Z\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"Income\",\n \"transacted_at\": \"2024-12-20T12:00:00Z\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "89496f41-7a83-4b47-b2cf-778170438257", "name": "users", "description": { "content": "Users represent an end user using the Platform API through your web or mobile app.\n\nUsers are created by MX clients and belong to a specific [client](docs.mx.com/products/connectivity/overview/data-architecture/#clients) on the platform.\n", "type": "text/plain" }, "item": [ { "id": "6e1d4f0d-c4b0-4df4-91d2-9101fc50b3ff", "name": "List users", "request": { "name": "List users", "description": { "content": "Use this endpoint to list every user you've created in the MX Platform API.", "type": "text/plain" }, "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." }, { "disabled": false, "key": "id", "value": "", "description": "The user `id` to search for." }, { "disabled": false, "key": "email", "value": "", "description": "The user `email` to search for." }, { "disabled": false, "key": "is_disabled", "value": "", "description": "Search for users that are disabled." } ], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "080ba3e8-6b19-4df5-b1c1-9d2c885efeaa", "name": "OK", "originalRequest": { "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" }, { "key": "id", "value": "u-12324-abdc" }, { "key": "email", "value": "example@example.com" }, { "key": "is_disabled", "value": "true" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"users\": [\n {\n \"email\": \"example@example.com\",\n \"guid\": \"USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6\",\n \"id\": \"My-Unique-ID\",\n \"is_disabled\": false,\n \"metadata\": \"{\\\\\\\"first_name\\\\\\\": \\\\\\\"Steven\\\\\\\", \\\\\\\"last_name\\\\\\\": \\\\\\\"Universe\\\\\\\"}\"\n },\n {\n \"email\": \"example@example.com\",\n \"guid\": \"USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6\",\n \"id\": \"My-Unique-ID\",\n \"is_disabled\": false,\n \"metadata\": \"{\\\\\\\"first_name\\\\\\\": \\\\\\\"Steven\\\\\\\", \\\\\\\"last_name\\\\\\\": \\\\\\\"Universe\\\\\\\"}\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "893b029e-48a4-495e-b9ac-8726c273b807", "name": "Create user", "request": { "name": "Create user", "description": { "content": "Use this endpoint to create a new user. The API will respond with the newly-created user object if successful, containing a `guid` that you'll set as the `user_guid` in other requests when required. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user’s data until they are no longer disabled.", "type": "text/plain" }, "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"email\": \"\",\n \"id\": \"\",\n \"is_disabled\": \"\",\n \"metadata\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5cd39633-0161-4f1d-b228-0ff852c49738", "name": "OK", "originalRequest": { "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"email\": \"example@example.com\",\n \"id\": \"My-Unique-ID\",\n \"is_disabled\": false,\n \"metadata\": \"{\\\\\\\"type\\\\\\\": \\\\\\\"individual\\\\\\\", \\\\\\\"status\\\\\\\": \\\\\\\"preferred\\\\\\\"}\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"user\": {\n \"email\": \"example@example.com\",\n \"guid\": \"USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6\",\n \"id\": \"My-Unique-ID\",\n \"is_disabled\": false,\n \"metadata\": \"{\\\\\\\"first_name\\\\\\\": \\\\\\\"Steven\\\\\\\", \\\\\\\"last_name\\\\\\\": \\\\\\\"Universe\\\\\\\"}\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "95365a84-2e6d-4d66-a944-42ce35b228d3", "name": "Delete user", "request": { "name": "Delete user", "description": { "content": "Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object.\n\n:::warning\nDeleting a user is permanent. Deleted users can never be restored. For more info, see [Deleting Objects](/api-reference/platform-api/overview/deleting-objects).\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "80eee496-5bc4-4c8c-9527-d065026cd92f", "name": "No Content", "originalRequest": { "url": { "path": [ "users", ":user_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "(Required) Specifies the media type expected in the response.", "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "1de88c53-91cc-4939-b792-0df16b6ead43", "name": "Read user", "request": { "name": "Read user", "description": { "content": "Use this endpoint to read the attributes of a specific user.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "23da2649-ac10-45eb-9db1-d8e65bee682a", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"user\": {\n \"email\": \"example@example.com\",\n \"guid\": \"USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6\",\n \"id\": \"My-Unique-ID\",\n \"is_disabled\": false,\n \"metadata\": \"{\\\\\\\"first_name\\\\\\\": \\\\\\\"Steven\\\\\\\", \\\\\\\"last_name\\\\\\\": \\\\\\\"Universe\\\\\\\"}\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "72b3a615-6176-4bab-81c7-8c6bcb2e28ca", "name": "Update user", "request": { "name": "Update user", "description": { "content": "Use this endpoint to update the attributes of the specified user.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"email\": \"\",\n \"id\": \"\",\n \"is_disabled\": \"\",\n \"metadata\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2dc6f5ae-7e72-49f8-86ed-9b9571dfc44b", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"email\": \"example@example.com\",\n \"id\": \"My-Unique-ID\",\n \"is_disabled\": false,\n \"metadata\": \"{\\\\\\\"first_name\\\\\\\": \\\\\\\"Steven\\\\\\\", \\\\\\\"last_name\\\\\\\": \\\\\\\"Universe\\\\\\\"}\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"user\": {\n \"email\": \"example@example.com\",\n \"guid\": \"USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6\",\n \"id\": \"My-Unique-ID\",\n \"is_disabled\": false,\n \"metadata\": \"{\\\\\\\"first_name\\\\\\\": \\\\\\\"Steven\\\\\\\", \\\\\\\"last_name\\\\\\\": \\\\\\\"Universe\\\\\\\"}\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "fc85c963-715e-4144-b4fd-0b87d1725e4d", "name": "verifiable credentials", "description": { "content": "MX provides Verifiable Credential endpoints that comply with web5 standards. \n\nFor more info, see [Verifiable Credentials Overview](docs.mx.com/api-reference/reference/verifiable-credentials).\n", "type": "text/plain" }, "item": [ { "id": "c6e412f3-bfe1-4dd3-b60f-e405a759cf43", "name": "Get Identity Data", "request": { "name": "Get Identity Data", "description": { "content": "Get an MX-issued verifiable credential of a user's identity data.", "type": "text/plain" }, "url": { "path": [ "vc", "users", ":user_guid", "members", ":member_guid", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/vnd.mx.api.v2beta+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "fcfe89f5-49dc-4a59-b76b-15e729ae67dd", "name": "OK", "originalRequest": { "url": { "path": [ "vc", "users", ":user_guid", "members", ":member_guid", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.mx.api.v2beta+json" } ], "body": "{\n \"verifiableCredential\": \"feJgbGciOiJFZERTQSEsImtpFCI6ImRpZDpksHR6c4E6MTNkdzdqeWc0NGVqd2NkZjhpcWNzZWg3amN6NTF3ajZmanhib29qNDFpcGVnNzZlbyMwIiwidHlwIjoiSldUIn0.eyJ2YyI6eyJAY29udGV4dCI6WyJodHRwczovL3d3dy53My5vcmcvMjAxOC9jcmVkZW50aWFscy92MSJdLCJpZCI6Imh0dHBzOi8vYXBpLnNhbmQuaW50ZXJuYWwubXgvdmMvdXNlcnMvVVNSLTNlYTdjYzMxLWVkZDYtNDQxNy05YjM1LWRlZTZlMjQ4NDI1Yi9tZW1iZXJzL01CUi1jYzUxNDViZi02M2Q5LTQ5OGYtODc3Mi1lNGVmMzI0MWNjYjYvYWNjb3VudHMiLCJ0eXBlIjpbIlZlcmlmaWFibGVDcmVkZW50aWFsIiwiRmluYW5jaWFsQWNjb3VudENyZWRlbnRpYWwiXSwiaXNzdWVyIjoiZGlkOmRodDpzYTcxM2R3N2p5ZzQ0ZWp3Y2RmOGlxY3NlaDdqY3o1MXdqNmZqeGJvb2o0MWlwZWc3NmVvIiwiaXNzdWFuY2VEYXRlIjoiMjAyNC0wMy0wMVQxODo0MjoxOVoiLCJjcmVkZW50aWFsU3ViamVjdCI6eyJhY2NvdW50cyI6W3sibG9jQWNjb3VudCI6eyJhY2NvdW52SWQiOeABQ1RtODRhMDEyNjgtNTdkMC00YTI4LWEwYzEtZTcyYWRyNDA5NbJkIiwiYWNjb3VudFR5cFUiOiJDUkVESVRDQVJEIiwiYWNjb3VudE51bWJlciI6IjM0OTcyNTM0NCIsImFjY291bnROdW1iZXJEaXNwbGF5IjoiKioqKjUzNDQiLCJwcm9kdWN0TmFtZSI6bnVsbCwibmlja25hbWUiOm51bGwsInN0YXR1cyI6Ik9QRU4iLCJhY2NvdW50T3BlbkRhdGUiOiIyMDIyLTA3LTExVDE1OjQwOjQwWiIsImFjY291bnRDbG9zZWREYXRlIjpudWxsLCJjdXJyZW5jeSI6eyJjdXJyZW5jeVJhdGUiOm51bGwsImN1cnJlbmN5Q29kZSI6bnVsbCwib3JpZ2luYWxDdXJyZW5jeUNvZGUiOm51bGx9LCJmaUF0dHJpYnV0ZXMiOlt7Im5hbWUiOiJtZW1iZXJfZ3VpZCIsInZhbHVlIjoiTUJSLWNjNTE0NWJmLTYzZDktNDk4Zi04NzcyLWU0ZWYzMjQxY2NiNiJ9LHsibmFtZSI6Imluc3RpdHV0aW9uX2d1aWQiLCJ2YWx1ZSI6IklOUy1mMWEzMjg1ZC1lODU1LWI2OGYtNmFhNy04YWU3NzVjMGUwZTkifSx7Im5hbWUiOiJleHRlcm5hbF9ndWlkIiwidmFsdWUiOiJhY2NvdW50LWY3ZTg3ZWZmLTA2YzAtNDZhMS1iODAwLTUxOTI3ODM2MjFhOSJ9XSwicm91dGluZ1RyYW5zaXROdW1iZXIiOm51bGwsImJhbGFuY2VUeXBlIjoiTElBQklMSVRZIiwiaW50ZXJlc3RSYXRlIjpudWxsLCJsYXN0QWN0aXZpdHlEYXRlIjoiMjAyMi0wNy0xMVQxNTo0MDo0MFoiLCJiYWxhbmNlQXNPZiI6IjIwMjItMDctMTFUMTU6NDA6NDBaIiwiY3JlZGl0TGluZSI6bnVsbCwiYXZhaWxhYmxlQ3JlZGl0IjoxMzAwMC4wLCJuZXh0UGF5bWVudERhdGUiOm51bGwsInByaW5jaXBhbEJhbGFuY2UiOm51bGwsImN1cnJlbnRCYWxhbmNlIjoxMDAwLjAsIm1pbmltdW1QYXltZW50QW1vdW50IjpudWxsLCJwdXJjaGFzZXNBcHIiOm51bGx9fSx7ImRlcG9zaXRBY2NvdW50Ijp7ImFjY291bnRJZCI6IkFDVC05NmYzMGQ2Ny0xZTA1LTRhNGItOWZkNS01NzFlYmUzZGU5NWMiLCJhY2NvdW50VHlwZSI6IkNIRUNLSU5HIiwiYWNjb3VudE51bWJlciI6Ijg0NTUzNTE2MSIsImFjY291bnROdW1iZXJEaXNwbGF5IjoiKioqKjUxNjEiLCJwcm9kdWN0TmFtZSI6bnVsbCwibmlja25hbWUiOm51bGwsInN0YXR1cyI6Ik9QRU4iLCJhY2NvdW50T3BlbkRhdGUiOiIyMDIyLTA3LTExVDE1OjQwOjQwWiIsImFjY291bnRDbG9zZWREYXRlIjpudWxsLCJjdXJyZW5jeSI6eyJjdXJyZW5jeVJhdGUiOm51bGwsImN1cnJlbmN5Q29kZSI6bnVsbCwib3JpZ2luYWxDdXJyZW5jeUNvZGUiOm51bGx9LCJmaUF0dHJpYnV0ZXMiOlt7Im5hbWUiOiJtZW1iZXJfZ3VpZCIsInZhbHVlIjoiTUJSLWNjNTE0NWJmLTYzZDktNDk4Zi04NzcyLWU0ZWYzMjQxY2NiNiJ9LHsibmFtZSI6Imluc3RpdHV0aW9uX2d1aWQiLCJ2YWx1ZSI6IklOUy1mMWEzMjg1ZC1lODU1LWI2OGYtNmFhNy04YWU3NzVjMGUwZTkifSx7Im5hbWUiOiJleHRlcm5hbF9ndWlkIiwidmFsdWUiOiJhY2NvdW50LWM2ZTc2MjQ0LTg4NjAtNDY0OS05ZDg1LTY1MGQzYWY5ZmViZSJ9XSwicm91dGluZ1RyYW5zaXROdW1iZXIiOm51bGwsImJhbGFuY2VUeXBlIjoiQVNTRVQiLCJpbnRlcmVzdFJhdGUiOm51bGwsImxhc3RBY3Rpdml0eURhdGUiOiIyMDIyLTA3LTExVDE1OjQwOjQwWiIsImJhbGFuY2VBc09mIjoiMjAyMi0wNy0xMVQxNTo0MDo0MFoiLCJjdXJyZW50QmFsYW5jZSI6MTAwMC4wLCJvcGVuaW5nRGF5QmFsYW5jZSI6bnVsbCwiYXZhaWxhYmxlQmFsYW5jZSI6MTAwMC4wLCJhbm51YWxQZXJjZW50YWdlWWllbGQiOm51bGwsIm1hdHVyaXR5RGF0ZSI6bnVsbH19LHsiZGVwb3NpdEFjY291bnQiOnsiYWNjb3VudElkIjoiQUNULWI4MjZlNGMyLTZkNjktNDVkNy1hMTM5LWJlNTY0NDFkNmE1OCIsImFjY291bnRUeXBlIjoiU0FWSU5HUyIsImFjY291bnROdW1iZXIiOiI1OTE4NzE2NjgiLCJhY2NvdW50TnVtYmVyRGlzcGxheSI6IioqKioxNjY4IiwicHJvZHVjdE5hbWUiOm51bGwsIm5pY2tuYW1lIjpudWxsLCJzdGF0dXMiOiJPUEVOIiwiYWNjb3VudE9wZW5EYXRlIjoiMjAyMi0wNy0xMVQxNTo0MDo0MFoiLCJhY2NvdW50Q2xvc2VkRGF0ZSI6bnVsbCwiY3VycmVuY3kiOnsiY3VycmVuY3lSYXRlIjpudWxsLCJjdXJyZW5jeUNvZGUiOm51bGwsIm9yaWdpbmFsQ3VycmVuY3lDb2RlIjpudWxsfSwiZmlBdHRyaWJ1dGVzIjpbeyJuYW1lIjoibWVtYmVyX2d1aWQiLCJ2YWx1ZSI6Ik1CUi1jYzUxNDViZi02M2Q5LTQ5OGYtODc3Mi1lNGVmMzI0MWNjYjYifSx7Im5hbWUiOiJpbnN0aXR1dGlvbl9ndWlkIiwidmFsdWUiOiJJTlMtZjFhMzI4NWQtZTg1NS1iNjhmLTZhYTctOGFlNzc1YzBlMGU5In0seyJuYW1lIjoiZXh0ZXJuYWxfZ3VpZCIsInZhbHVlIjoiYWNjb3VudC1kOTIyNTA4OC1hOTM2LTRkNjctOGQyYy0wY2EyYzgwOGYxMTYifV0sInJvdXRpbmdUcmFuc2l0TnVtYmVyIjpudWxsLCJiYWxhbmNlVHlwZSI6IkFTU0VUIiwiaW50ZXJlc3RSYXRlIjpudWxsLCJsYXN0QWN0aXZpdHlEYXRlIjoiMjAyMi0wNy0xMVQxNTo0MDo0MFoiLCJiYWxhbmNlQXNPZiI6IjIwMjItMDctMTFUMTU6NDA6NDBaIiwiY3VycmVudEJhbGFuY2UiOjEwMDAuMCwib3BlbmluZ0RheUJhbGFuY2UiOm51bGwsImF2YWlsYWJsZUJhbGFuY2UiOjEwMDAuMCwiYW5udWFsUGVyY2VudGFnZVlpZWxkIjpudWxsLCJtYXR1cml0eURhdGUiOm51bGx9fV0sImlkIjoiVVNSLTNlYTdjYzMxLWVkZDYtNDQxNy05YjM1LWRlZTZlMjQ4NDI1YiJ9fSwiaXNzIjoiZGlkOmRodDpzYTcxM2R3N2p5ZzQ0ZWp3Y2RmOGlxY3NlaDdqY3o1MXdqNmZqeGJvb2o0MWlwZWc3NmVvIiwiaWF0IjoxNzA5MzE4NTM5LCJqdGkiOiJodHRwczovL2FwaS5zYW5kLmludGVybmFsLm14L3ZjL3VzZXJzL1VTUi0zZWE3Y2MzMS1lZGQ2LTQ0MTctOWIzNS1kZWU2ZTI0ODQyNWIvbWVtYmVycy9NQlItY2M1MTQ1YmYtNjNkOS00OThmLTg3NzItZTRlZjMyNDFjY2I2L2FjY291bnRzIiwic3ViIjoiVVNSLTNlYTdjYzMxLWVkZDYtNDQxNy05YjM1LWRlZTZlMjQ4NDI1YiJ9._CiFkwbuhKxwwIehEQ1opsi-9NSoIwDqD2HFMw1ROKNuJPdepTXFEd_RDFbbg7lFj05vBXPUL7y9eVVgZXTvDw\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "5104f046-cbab-422a-9c97-c89c794b4bf7", "name": "Get Accounts Data", "request": { "name": "Get Accounts Data", "description": { "content": "Get an MX-issued verifiable credential of a user's accounts data.", "type": "text/plain" }, "url": { "path": [ "vc", "users", ":user_guid", "members", ":member_guid", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/vnd.mx.api.v2beta+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6c67a7d5-6241-4bf6-9509-2c01ad625e01", "name": "OK", "originalRequest": { "url": { "path": [ "vc", "users", ":user_guid", "members", ":member_guid", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.mx.api.v2beta+json" } ], "body": "{\n \"verifiableCredential\": \"feJgbGciOiJFZERTQSEsImtpFCI6ImRpZDpksHR6c4E6MTNkdzdqeWc0NGVqd2NkZjhpcWNzZWg3amN6NTF3ajZmanhib29qNDFpcGVnNzZlbyMwIiwidHlwIjoiSldUIn0.eyJ2YyI6eyJAY29udGV4dCI6WyJodHRwczovL3d3dy53My5vcmcvMjAxOC9jcmVkZW50aWFscy92MSJdLCJpZCI6Imh0dHBzOi8vYXBpLnNhbmQuaW50ZXJuYWwubXgvdmMvdXNlcnMvVVNSLTNlYTdjYzMxLWVkZDYtNDQxNy05YjM1LWRlZTZlMjQ4NDI1Yi9tZW1iZXJzL01CUi1jYzUxNDViZi02M2Q5LTQ5OGYtODc3Mi1lNGVmMzI0MWNjYjYvYWNjb3VudHMiLCJ0eXBlIjpbIlZlcmlmaWFibGVDcmVkZW50aWFsIiwiRmluYW5jaWFsQWNjb3VudENyZWRlbnRpYWwiXSwiaXNzdWVyIjoiZGlkOmRodDpzYTcxM2R3N2p5ZzQ0ZWp3Y2RmOGlxY3NlaDdqY3o1MXdqNmZqeGJvb2o0MWlwZWc3NmVvIiwiaXNzdWFuY2VEYXRlIjoiMjAyNC0wMy0wMVQxODo0MjoxOVoiLCJjcmVkZW50aWFsU3ViamVjdCI6eyJhY2NvdW50cyI6W3sibG9jQWNjb3VudCI6eyJhY2NvdW52SWQiOeABQ1RtODRhMDEyNjgtNTdkMC00YTI4LWEwYzEtZTcyYWRyNDA5NbJkIiwiYWNjb3VudFR5cFUiOiJDUkVESVRDQVJEIiwiYWNjb3VudE51bWJlciI6IjM0OTcyNTM0NCIsImFjY291bnROdW1iZXJEaXNwbGF5IjoiKioqKjUzNDQiLCJwcm9kdWN0TmFtZSI6bnVsbCwibmlja25hbWUiOm51bGwsInN0YXR1cyI6Ik9QRU4iLCJhY2NvdW50T3BlbkRhdGUiOiIyMDIyLTA3LTExVDE1OjQwOjQwWiIsImFjY291bnRDbG9zZWREYXRlIjpudWxsLCJjdXJyZW5jeSI6eyJjdXJyZW5jeVJhdGUiOm51bGwsImN1cnJlbmN5Q29kZSI6bnVsbCwib3JpZ2luYWxDdXJyZW5jeUNvZGUiOm51bGx9LCJmaUF0dHJpYnV0ZXMiOlt7Im5hbWUiOiJtZW1iZXJfZ3VpZCIsInZhbHVlIjoiTUJSLWNjNTE0NWJmLTYzZDktNDk4Zi04NzcyLWU0ZWYzMjQxY2NiNiJ9LHsibmFtZSI6Imluc3RpdHV0aW9uX2d1aWQiLCJ2YWx1ZSI6IklOUy1mMWEzMjg1ZC1lODU1LWI2OGYtNmFhNy04YWU3NzVjMGUwZTkifSx7Im5hbWUiOiJleHRlcm5hbF9ndWlkIiwidmFsdWUiOiJhY2NvdW50LWY3ZTg3ZWZmLTA2YzAtNDZhMS1iODAwLTUxOTI3ODM2MjFhOSJ9XSwicm91dGluZ1RyYW5zaXROdW1iZXIiOm51bGwsImJhbGFuY2VUeXBlIjoiTElBQklMSVRZIiwiaW50ZXJlc3RSYXRlIjpudWxsLCJsYXN0QWN0aXZpdHlEYXRlIjoiMjAyMi0wNy0xMVQxNTo0MDo0MFoiLCJiYWxhbmNlQXNPZiI6IjIwMjItMDctMTFUMTU6NDA6NDBaIiwiY3JlZGl0TGluZSI6bnVsbCwiYXZhaWxhYmxlQ3JlZGl0IjoxMzAwMC4wLCJuZXh0UGF5bWVudERhdGUiOm51bGwsInByaW5jaXBhbEJhbGFuY2UiOm51bGwsImN1cnJlbnRCYWxhbmNlIjoxMDAwLjAsIm1pbmltdW1QYXltZW50QW1vdW50IjpudWxsLCJwdXJjaGFzZXNBcHIiOm51bGx9fSx7ImRlcG9zaXRBY2NvdW50Ijp7ImFjY291bnRJZCI6IkFDVC05NmYzMGQ2Ny0xZTA1LTRhNGItOWZkNS01NzFlYmUzZGU5NWMiLCJhY2NvdW50VHlwZSI6IkNIRUNLSU5HIiwiYWNjb3VudE51bWJlciI6Ijg0NTUzNTE2MSIsImFjY291bnROdW1iZXJEaXNwbGF5IjoiKioqKjUxNjEiLCJwcm9kdWN0TmFtZSI6bnVsbCwibmlja25hbWUiOm51bGwsInN0YXR1cyI6Ik9QRU4iLCJhY2NvdW50T3BlbkRhdGUiOiIyMDIyLTA3LTExVDE1OjQwOjQwWiIsImFjY291bnRDbG9zZWREYXRlIjpudWxsLCJjdXJyZW5jeSI6eyJjdXJyZW5jeVJhdGUiOm51bGwsImN1cnJlbmN5Q29kZSI6bnVsbCwib3JpZ2luYWxDdXJyZW5jeUNvZGUiOm51bGx9LCJmaUF0dHJpYnV0ZXMiOlt7Im5hbWUiOiJtZW1iZXJfZ3VpZCIsInZhbHVlIjoiTUJSLWNjNTE0NWJmLTYzZDktNDk4Zi04NzcyLWU0ZWYzMjQxY2NiNiJ9LHsibmFtZSI6Imluc3RpdHV0aW9uX2d1aWQiLCJ2YWx1ZSI6IklOUy1mMWEzMjg1ZC1lODU1LWI2OGYtNmFhNy04YWU3NzVjMGUwZTkifSx7Im5hbWUiOiJleHRlcm5hbF9ndWlkIiwidmFsdWUiOiJhY2NvdW50LWM2ZTc2MjQ0LTg4NjAtNDY0OS05ZDg1LTY1MGQzYWY5ZmViZSJ9XSwicm91dGluZ1RyYW5zaXROdW1iZXIiOm51bGwsImJhbGFuY2VUeXBlIjoiQVNTRVQiLCJpbnRlcmVzdFJhdGUiOm51bGwsImxhc3RBY3Rpdml0eURhdGUiOiIyMDIyLTA3LTExVDE1OjQwOjQwWiIsImJhbGFuY2VBc09mIjoiMjAyMi0wNy0xMVQxNTo0MDo0MFoiLCJjdXJyZW50QmFsYW5jZSI6MTAwMC4wLCJvcGVuaW5nRGF5QmFsYW5jZSI6bnVsbCwiYXZhaWxhYmxlQmFsYW5jZSI6MTAwMC4wLCJhbm51YWxQZXJjZW50YWdlWWllbGQiOm51bGwsIm1hdHVyaXR5RGF0ZSI6bnVsbH19LHsiZGVwb3NpdEFjY291bnQiOnsiYWNjb3VudElkIjoiQUNULWI4MjZlNGMyLTZkNjktNDVkNy1hMTM5LWJlNTY0NDFkNmE1OCIsImFjY291bnRUeXBlIjoiU0FWSU5HUyIsImFjY291bnROdW1iZXIiOiI1OTE4NzE2NjgiLCJhY2NvdW50TnVtYmVyRGlzcGxheSI6IioqKioxNjY4IiwicHJvZHVjdE5hbWUiOm51bGwsIm5pY2tuYW1lIjpudWxsLCJzdGF0dXMiOiJPUEVOIiwiYWNjb3VudE9wZW5EYXRlIjoiMjAyMi0wNy0xMVQxNTo0MDo0MFoiLCJhY2NvdW50Q2xvc2VkRGF0ZSI6bnVsbCwiY3VycmVuY3kiOnsiY3VycmVuY3lSYXRlIjpudWxsLCJjdXJyZW5jeUNvZGUiOm51bGwsIm9yaWdpbmFsQ3VycmVuY3lDb2RlIjpudWxsfSwiZmlBdHRyaWJ1dGVzIjpbeyJuYW1lIjoibWVtYmVyX2d1aWQiLCJ2YWx1ZSI6Ik1CUi1jYzUxNDViZi02M2Q5LTQ5OGYtODc3Mi1lNGVmMzI0MWNjYjYifSx7Im5hbWUiOiJpbnN0aXR1dGlvbl9ndWlkIiwidmFsdWUiOiJJTlMtZjFhMzI4NWQtZTg1NS1iNjhmLTZhYTctOGFlNzc1YzBlMGU5In0seyJuYW1lIjoiZXh0ZXJuYWxfZ3VpZCIsInZhbHVlIjoiYWNjb3VudC1kOTIyNTA4OC1hOTM2LTRkNjctOGQyYy0wY2EyYzgwOGYxMTYifV0sInJvdXRpbmdUcmFuc2l0TnVtYmVyIjpudWxsLCJiYWxhbmNlVHlwZSI6IkFTU0VUIiwiaW50ZXJlc3RSYXRlIjpudWxsLCJsYXN0QWN0aXZpdHlEYXRlIjoiMjAyMi0wNy0xMVQxNTo0MDo0MFoiLCJiYWxhbmNlQXNPZiI6IjIwMjItMDctMTFUMTU6NDA6NDBaIiwiY3VycmVudEJhbGFuY2UiOjEwMDAuMCwib3BlbmluZ0RheUJhbGFuY2UiOm51bGwsImF2YWlsYWJsZUJhbGFuY2UiOjEwMDAuMCwiYW5udWFsUGVyY2VudGFnZVlpZWxkIjpudWxsLCJtYXR1cml0eURhdGUiOm51bGx9fV0sImlkIjoiVVNSLTNlYTdjYzMxLWVkZDYtNDQxNy05YjM1LWRlZTZlMjQ4NDI1YiJ9fSwiaXNzIjoiZGlkOmRodDpzYTcxM2R3N2p5ZzQ0ZWp3Y2RmOGlxY3NlaDdqY3o1MXdqNmZqeGJvb2o0MWlwZWc3NmVvIiwiaWF0IjoxNzA5MzE4NTM5LCJqdGkiOiJodHRwczovL2FwaS5zYW5kLmludGVybmFsLm14L3ZjL3VzZXJzL1VTUi0zZWE3Y2MzMS1lZGQ2LTQ0MTctOWIzNS1kZWU2ZTI0ODQyNWIvbWVtYmVycy9NQlItY2M1MTQ1YmYtNjNkOS00OThmLTg3NzItZTRlZjMyNDFjY2I2L2FjY291bnRzIiwic3ViIjoiVVNSLTNlYTdjYzMxLWVkZDYtNDQxNy05YjM1LWRlZTZlMjQ4NDI1YiJ9._CiFkwbuhKxwwIehEQ1opsi-9NSoIwDqD2HFMw1ROKNuJPdepTXFEd_RDFbbg7lFj05vBXPUL7y9eVVgZXTvDw\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "52dd1a0b-f954-4221-b764-b9ffe69114fe", "name": "Get Transactions Data", "request": { "name": "Get Transactions Data", "description": { "content": "Get an MX-issued verifiable credential of a user's transaction data.", "type": "text/plain" }, "url": { "path": [ "vc", "users", ":user_guid", "accounts", ":account_guid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "startTime", "value": "", "description": "Filter transactions from this date. Must be in the format YYYY-MM-DD. The range is limited to 1 year." }, { "disabled": false, "key": "endTime", "value": "", "description": "Filter transactions to this date. Must be in the format YYYY-MM-DD. The range is limited to 1 year." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/vnd.mx.api.v2beta+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "bd876143-1e0c-490a-b470-1104b48d6a61", "name": "OK", "originalRequest": { "url": { "path": [ "vc", "users", ":user_guid", "accounts", ":account_guid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startTime", "value": "2015-09-20" }, { "key": "endTime", "value": "2015-09-20" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.mx.api.v2beta+json" } ], "body": "{\n \"verifiableCredential\": \"feJgbGciOiJFZERTQSEsImtpFCI6ImRpZDpksHR6c4E6MTNkdzdqeWc0NGVqd2NkZjhpcWNzZWg3amN6NTF3ajZmanhib29qNDFpcGVnNzZlbyMwIiwidHlwIjoiSldUIn0.eyJ2YyI6eyJAY29udGV4dCI6WyJodHRwczovL3d3dy53My5vcmcvMjAxOC9jcmVkZW50aWFscy92MSJdLCJpZCI6Imh0dHBzOi8vYXBpLnNhbmQuaW50ZXJuYWwubXgvdmMvdXNlcnMvVVNSLTNlYTdjYzMxLWVkZDYtNDQxNy05YjM1LWRlZTZlMjQ4NDI1Yi9tZW1iZXJzL01CUi1jYzUxNDViZi02M2Q5LTQ5OGYtODc3Mi1lNGVmMzI0MWNjYjYvYWNjb3VudHMiLCJ0eXBlIjpbIlZlcmlmaWFibGVDcmVkZW50aWFsIiwiRmluYW5jaWFsQWNjb3VudENyZWRlbnRpYWwiXSwiaXNzdWVyIjoiZGlkOmRodDpzYTcxM2R3N2p5ZzQ0ZWp3Y2RmOGlxY3NlaDdqY3o1MXdqNmZqeGJvb2o0MWlwZWc3NmVvIiwiaXNzdWFuY2VEYXRlIjoiMjAyNC0wMy0wMVQxODo0MjoxOVoiLCJjcmVkZW50aWFsU3ViamVjdCI6eyJhY2NvdW50cyI6W3sibG9jQWNjb3VudCI6eyJhY2NvdW52SWQiOeABQ1RtODRhMDEyNjgtNTdkMC00YTI4LWEwYzEtZTcyYWRyNDA5NbJkIiwiYWNjb3VudFR5cFUiOiJDUkVESVRDQVJEIiwiYWNjb3VudE51bWJlciI6IjM0OTcyNTM0NCIsImFjY291bnROdW1iZXJEaXNwbGF5IjoiKioqKjUzNDQiLCJwcm9kdWN0TmFtZSI6bnVsbCwibmlja25hbWUiOm51bGwsInN0YXR1cyI6Ik9QRU4iLCJhY2NvdW50T3BlbkRhdGUiOiIyMDIyLTA3LTExVDE1OjQwOjQwWiIsImFjY291bnRDbG9zZWREYXRlIjpudWxsLCJjdXJyZW5jeSI6eyJjdXJyZW5jeVJhdGUiOm51bGwsImN1cnJlbmN5Q29kZSI6bnVsbCwib3JpZ2luYWxDdXJyZW5jeUNvZGUiOm51bGx9LCJmaUF0dHJpYnV0ZXMiOlt7Im5hbWUiOiJtZW1iZXJfZ3VpZCIsInZhbHVlIjoiTUJSLWNjNTE0NWJmLTYzZDktNDk4Zi04NzcyLWU0ZWYzMjQxY2NiNiJ9LHsibmFtZSI6Imluc3RpdHV0aW9uX2d1aWQiLCJ2YWx1ZSI6IklOUy1mMWEzMjg1ZC1lODU1LWI2OGYtNmFhNy04YWU3NzVjMGUwZTkifSx7Im5hbWUiOiJleHRlcm5hbF9ndWlkIiwidmFsdWUiOiJhY2NvdW50LWY3ZTg3ZWZmLTA2YzAtNDZhMS1iODAwLTUxOTI3ODM2MjFhOSJ9XSwicm91dGluZ1RyYW5zaXROdW1iZXIiOm51bGwsImJhbGFuY2VUeXBlIjoiTElBQklMSVRZIiwiaW50ZXJlc3RSYXRlIjpudWxsLCJsYXN0QWN0aXZpdHlEYXRlIjoiMjAyMi0wNy0xMVQxNTo0MDo0MFoiLCJiYWxhbmNlQXNPZiI6IjIwMjItMDctMTFUMTU6NDA6NDBaIiwiY3JlZGl0TGluZSI6bnVsbCwiYXZhaWxhYmxlQ3JlZGl0IjoxMzAwMC4wLCJuZXh0UGF5bWVudERhdGUiOm51bGwsInByaW5jaXBhbEJhbGFuY2UiOm51bGwsImN1cnJlbnRCYWxhbmNlIjoxMDAwLjAsIm1pbmltdW1QYXltZW50QW1vdW50IjpudWxsLCJwdXJjaGFzZXNBcHIiOm51bGx9fSx7ImRlcG9zaXRBY2NvdW50Ijp7ImFjY291bnRJZCI6IkFDVC05NmYzMGQ2Ny0xZTA1LTRhNGItOWZkNS01NzFlYmUzZGU5NWMiLCJhY2NvdW50VHlwZSI6IkNIRUNLSU5HIiwiYWNjb3VudE51bWJlciI6Ijg0NTUzNTE2MSIsImFjY291bnROdW1iZXJEaXNwbGF5IjoiKioqKjUxNjEiLCJwcm9kdWN0TmFtZSI6bnVsbCwibmlja25hbWUiOm51bGwsInN0YXR1cyI6Ik9QRU4iLCJhY2NvdW50T3BlbkRhdGUiOiIyMDIyLTA3LTExVDE1OjQwOjQwWiIsImFjY291bnRDbG9zZWREYXRlIjpudWxsLCJjdXJyZW5jeSI6eyJjdXJyZW5jeVJhdGUiOm51bGwsImN1cnJlbmN5Q29kZSI6bnVsbCwib3JpZ2luYWxDdXJyZW5jeUNvZGUiOm51bGx9LCJmaUF0dHJpYnV0ZXMiOlt7Im5hbWUiOiJtZW1iZXJfZ3VpZCIsInZhbHVlIjoiTUJSLWNjNTE0NWJmLTYzZDktNDk4Zi04NzcyLWU0ZWYzMjQxY2NiNiJ9LHsibmFtZSI6Imluc3RpdHV0aW9uX2d1aWQiLCJ2YWx1ZSI6IklOUy1mMWEzMjg1ZC1lODU1LWI2OGYtNmFhNy04YWU3NzVjMGUwZTkifSx7Im5hbWUiOiJleHRlcm5hbF9ndWlkIiwidmFsdWUiOiJhY2NvdW50LWM2ZTc2MjQ0LTg4NjAtNDY0OS05ZDg1LTY1MGQzYWY5ZmViZSJ9XSwicm91dGluZ1RyYW5zaXROdW1iZXIiOm51bGwsImJhbGFuY2VUeXBlIjoiQVNTRVQiLCJpbnRlcmVzdFJhdGUiOm51bGwsImxhc3RBY3Rpdml0eURhdGUiOiIyMDIyLTA3LTExVDE1OjQwOjQwWiIsImJhbGFuY2VBc09mIjoiMjAyMi0wNy0xMVQxNTo0MDo0MFoiLCJjdXJyZW50QmFsYW5jZSI6MTAwMC4wLCJvcGVuaW5nRGF5QmFsYW5jZSI6bnVsbCwiYXZhaWxhYmxlQmFsYW5jZSI6MTAwMC4wLCJhbm51YWxQZXJjZW50YWdlWWllbGQiOm51bGwsIm1hdHVyaXR5RGF0ZSI6bnVsbH19LHsiZGVwb3NpdEFjY291bnQiOnsiYWNjb3VudElkIjoiQUNULWI4MjZlNGMyLTZkNjktNDVkNy1hMTM5LWJlNTY0NDFkNmE1OCIsImFjY291bnRUeXBlIjoiU0FWSU5HUyIsImFjY291bnROdW1iZXIiOiI1OTE4NzE2NjgiLCJhY2NvdW50TnVtYmVyRGlzcGxheSI6IioqKioxNjY4IiwicHJvZHVjdE5hbWUiOm51bGwsIm5pY2tuYW1lIjpudWxsLCJzdGF0dXMiOiJPUEVOIiwiYWNjb3VudE9wZW5EYXRlIjoiMjAyMi0wNy0xMVQxNTo0MDo0MFoiLCJhY2NvdW50Q2xvc2VkRGF0ZSI6bnVsbCwiY3VycmVuY3kiOnsiY3VycmVuY3lSYXRlIjpudWxsLCJjdXJyZW5jeUNvZGUiOm51bGwsIm9yaWdpbmFsQ3VycmVuY3lDb2RlIjpudWxsfSwiZmlBdHRyaWJ1dGVzIjpbeyJuYW1lIjoibWVtYmVyX2d1aWQiLCJ2YWx1ZSI6Ik1CUi1jYzUxNDViZi02M2Q5LTQ5OGYtODc3Mi1lNGVmMzI0MWNjYjYifSx7Im5hbWUiOiJpbnN0aXR1dGlvbl9ndWlkIiwidmFsdWUiOiJJTlMtZjFhMzI4NWQtZTg1NS1iNjhmLTZhYTctOGFlNzc1YzBlMGU5In0seyJuYW1lIjoiZXh0ZXJuYWxfZ3VpZCIsInZhbHVlIjoiYWNjb3VudC1kOTIyNTA4OC1hOTM2LTRkNjctOGQyYy0wY2EyYzgwOGYxMTYifV0sInJvdXRpbmdUcmFuc2l0TnVtYmVyIjpudWxsLCJiYWxhbmNlVHlwZSI6IkFTU0VUIiwiaW50ZXJlc3RSYXRlIjpudWxsLCJsYXN0QWN0aXZpdHlEYXRlIjoiMjAyMi0wNy0xMVQxNTo0MDo0MFoiLCJiYWxhbmNlQXNPZiI6IjIwMjItMDctMTFUMTU6NDA6NDBaIiwiY3VycmVudEJhbGFuY2UiOjEwMDAuMCwib3BlbmluZ0RheUJhbGFuY2UiOm51bGwsImF2YWlsYWJsZUJhbGFuY2UiOjEwMDAuMCwiYW5udWFsUGVyY2VudGFnZVlpZWxkIjpudWxsLCJtYXR1cml0eURhdGUiOm51bGx9fV0sImlkIjoiVVNSLTNlYTdjYzMxLWVkZDYtNDQxNy05YjM1LWRlZTZlMjQ4NDI1YiJ9fSwiaXNzIjoiZGlkOmRodDpzYTcxM2R3N2p5ZzQ0ZWp3Y2RmOGlxY3NlaDdqY3o1MXdqNmZqeGJvb2o0MWlwZWc3NmVvIiwiaWF0IjoxNzA5MzE4NTM5LCJqdGkiOiJodHRwczovL2FwaS5zYW5kLmludGVybmFsLm14L3ZjL3VzZXJzL1VTUi0zZWE3Y2MzMS1lZGQ2LTQ0MTctOWIzNS1kZWU2ZTI0ODQyNWIvbWVtYmVycy9NQlItY2M1MTQ1YmYtNjNkOS00OThmLTg3NzItZTRlZjMyNDFjY2I2L2FjY291bnRzIiwic3ViIjoiVVNSLTNlYTdjYzMxLWVkZDYtNDQxNy05YjM1LWRlZTZlMjQ4NDI1YiJ9._CiFkwbuhKxwwIehEQ1opsi-9NSoIwDqD2HFMw1ROKNuJPdepTXFEd_RDFbbg7lFj05vBXPUL7y9eVVgZXTvDw\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] } ], "event": [] }, { "id": "39e7d4e6-8f8b-44a5-8fb5-ebf254c5c369", "name": "widgets", "description": { "content": "Use the [Request Widget URL](docs.mx.com/api-reference/platform-api/reference/request-widget-url) endpoint to generate a URL that loads one of our widgets.\n\nMany request body parameters only work for some widgets.\n\nFor more info, including widget types, see [Widgets Overview](docs.mx.com/api-reference/reference/widgets).\n", "type": "text/plain" }, "item": [ { "id": "ba044d0a-51cc-453b-95b3-832d12791076", "name": "Request oauth window uri", "request": { "name": "Request oauth window uri", "description": { "content": "This endpoint will generate an `oauth_window_uri` for the specified `member`.", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "oauth_window_uri" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "client_redirect_url", "value": "", "description": "A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with `referral_source=APP`." }, { "disabled": false, "key": "enable_app2app", "value": "", "description": "This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to `true`. When set to `false`, any `oauth_window_uri` generated will **not** direct the end user to the institution's mobile application. This setting is not persistent. This setting currently only affects Chase institutions." }, { "disabled": false, "key": "referral_source", "value": "", "description": "Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`." }, { "disabled": false, "key": "skip_aggregation", "value": "", "description": "(Deprecated) This field remains supported in this version but will be removed at a future date.\n\nSetting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page.\n" }, { "disabled": false, "key": "ui_message_webview_url_scheme", "value": "", "description": "A scheme for routing the user back to the application state they were previously in. Only available with `referral_source=APP`." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "32a1418d-30ec-4472-abff-74136086ea7d", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "members", ":member_identifier", "oauth_window_uri" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "client_redirect_url", "value": "https://{yoursite.com}" }, { "key": "enable_app2app", "value": "false" }, { "key": "referral_source", "value": "APP" }, { "key": "skip_aggregation", "value": "false" }, { "key": "ui_message_webview_url_scheme", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_identifier", "description": "(Required) Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"guid\": \"MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f\",\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "8d467a54-c900-4782-a009-3385ba7d21e3", "name": "Request widget URL", "request": { "name": "Request widget URL", "description": { "content": "Get an embeddable URL for integrating a widget into your website or app. The URL expires after ten minutes or upon first use, whichever occurs first. You'll need to obtain a new URL each time the page loads or reloads.\n\nInclude the `widget_type` in the request body to specify which widget you want to embed—the Connect Widget, a Personal Financial Management widget, or an Insights widget. Some request parameters are specific to certain widget types.\n\nTo embed the Connect Widget, set `widget_type` to `connect_widget`.\n\nFor a full list of available widget types, see [Widget Types](/api-reference/platform-api/reference/widgets#widget-types).\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "widget_urls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "The desired language of the widget.", "key": "Accept-Language", "value": "" }, { "disabled": false, "description": "The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member/#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.", "key": "X-CALLBACK-PAYLOAD", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"widget_url\": {\n \"widget_type\": \"\",\n \"client_redirect_url\": \"\",\n \"color_scheme\": \"\",\n \"current_institution_code\": \"\",\n \"current_institution_guid\": \"\",\n \"current_member_guid\": \"\",\n \"current_microdeposit_guid\": \"\",\n \"data_request\": {\n \"products\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"deep_link_params\": {\n \"account_guid\": \"\",\n \"date_range\": {\n \"start_date\": {\n \"value\": \"\"\n },\n \"end_date\": {\n \"value\": \"\"\n }\n },\n \"launch_integration\": \"\",\n \"view\": \"\",\n \"widget\": \"\"\n },\n \"disable_background_agg\": \"\",\n \"disable_institution_search\": \"\",\n \"enable_app2app\": \"\",\n \"include_identity\": \"\",\n \"include_transactions\": \"\",\n \"insight_guid\": \"\",\n \"iso_country_code\": [\n \"\",\n \"\"\n ],\n \"is_mobile_webview\": \"\",\n \"microwidget_instance_id\": \"\",\n \"locale\": \"\",\n \"mode\": \"\",\n \"oauth_referral_source\": \"\",\n \"style\": {\n \"font_name\": \"\"\n },\n \"ui_message_version\": \"\",\n \"ui_message_webview_url_scheme\": \"\",\n \"update_credentials\": \"\",\n \"use_cases\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5f4cab71-2270-4943-a95a-b4b6de36990d", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "widget_urls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "The desired language of the widget.", "key": "Accept-Language", "value": "en-US" }, { "disabled": false, "description": "The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member/#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.", "key": "X-CALLBACK-PAYLOAD", "value": "813e50bd-4a7e-4517-b6bb-9eef65a68cbd" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"widget_url\": {\n \"widget_type\": \"connect_widget\",\n \"client_redirect_url\": \"https://{yoursite.com}\",\n \"color_scheme\": \"light\",\n \"current_institution_code\": \"mx_bank\",\n \"current_institution_guid\": \"INS-f1a3285d-e855-b61f-6aa7-8ae575c0e0e9\",\n \"current_member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"current_microdeposit_guid\": \"MIC-1234567890\",\n \"data_request\": {\n \"products\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"deep_link_params\": {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"date_range\": {\n \"start_date\": {\n \"value\": \"\"\n },\n \"end_date\": {\n \"value\": \"\"\n }\n },\n \"launch_integration\": \"direct-deposit\",\n \"view\": \"manage_income\",\n \"widget\": \"budgets\"\n },\n \"disable_background_agg\": false,\n \"disable_institution_search\": false,\n \"enable_app2app\": false,\n \"include_identity\": false,\n \"include_transactions\": true,\n \"insight_guid\": null,\n \"iso_country_code\": [\n \"US\",\n \"CA\"\n ],\n \"is_mobile_webview\": false,\n \"microwidget_instance_id\": null,\n \"locale\": \"fr-CA\",\n \"mode\": \"aggregation\",\n \"oauth_referral_source\": \"BROWSER\",\n \"style\": {\n \"font_name\": \"Roboto\"\n },\n \"ui_message_version\": 4,\n \"ui_message_webview_url_scheme\": \"\",\n \"update_credentials\": false,\n \"use_cases\": [\n \"PFM\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"widget_url\": {\n \"type\": \"connect_widget\",\n \"url\": \"https://int-widgets.moneydesktop.com/md/connect/yxcdk7f1nb99jwApp34lA24m0AZ8rzprgmw17gm8z8h2AzjyAnd1rj42qfv42r3xnn07Amfwlg3j09hwp8bkq8tc5z21j33xjggmp2qtlpkz2v4gywfhfn31l44tx2w91bfc2thc58j4syqp0hgxcyvA4g7754hk7gjc56kt7tc36s45mmkdz2jqqqydspytmtr3dAb9jh6fkb24f3zkfpdjj0v77f0vmrtzvzxkmxz7dklsq8gd0gstkbhlw5bgpgc3m9mAtpAcr2w15gwy5xc4blgxppl42Avnm63291z3cyp0wm3lqgmvgzdAddct423gAdqxdlfx5d4mvc0ck2gt7ktqgks4vxq1pAy5\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7b4e2f59-7dbf-4167-b582-be52c8cf4fd2", "name": "managed data [deprecated]", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "3dbcb9c1-ad54-4ddb-ac3d-75a61b1751c3", "name": "List managed institutions", "request": { "name": "List managed institutions", "description": { "content": "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](/api-reference/platform-api/overview/migration)\n:::\n", "type": "text/plain" }, "url": { "path": [ "managed_institutions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "982aa138-ea31-4c4f-8233-f3a3ef053e1c", "name": "OK", "originalRequest": { "url": { "path": [ "managed_institutions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"institutions\": [\n {\n \"client_status\": \"AVAILABLE\",\n \"code\": \"mxbank\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"forgot_password_url\": \"https://example.url.mxbank.com/forgot-password\",\n \"forgot_username_url\": \"https://example.url.mxbank.com/forgot-username\",\n \"guid\": \"INS-1572a04c-912b-59bf-5841-332c7dfafaef\",\n \"instructional_text\": \"Some instructional text for end users.\",\n \"instructional_text_steps\": [\n \"Step 1: Do this.\",\n \"Step 2: Do that.\"\n ],\n \"is_disabled_by_client\": false,\n \"is_hidden\": true,\n \"iso_country_code\": \"US\",\n \"medium_logo_url\": \"https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png\",\n \"name\": \"MX Bank\",\n \"small_logo_url\": \"https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png\",\n \"status\": \"OPERATIONAL\",\n \"supported_products\": {},\n \"supports_oauth\": true,\n \"supports_tax_document\": true,\n \"trouble_signing_in_url\": \"https://example.url.mxbank.com/login-trouble\",\n \"url\": \"https://www.mxbank.com\"\n },\n {\n \"client_status\": \"AVAILABLE\",\n \"code\": \"mxbank\",\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"forgot_password_url\": \"https://example.url.mxbank.com/forgot-password\",\n \"forgot_username_url\": \"https://example.url.mxbank.com/forgot-username\",\n \"guid\": \"INS-1572a04c-912b-59bf-5841-332c7dfafaef\",\n \"instructional_text\": \"Some instructional text for end users.\",\n \"instructional_text_steps\": [\n \"Step 1: Do this.\",\n \"Step 2: Do that.\"\n ],\n \"is_disabled_by_client\": false,\n \"is_hidden\": true,\n \"iso_country_code\": \"US\",\n \"medium_logo_url\": \"https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png\",\n \"name\": \"MX Bank\",\n \"small_logo_url\": \"https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png\",\n \"status\": \"OPERATIONAL\",\n \"supported_products\": {},\n \"supports_oauth\": true,\n \"supports_tax_document\": true,\n \"trouble_signing_in_url\": \"https://example.url.mxbank.com/login-trouble\",\n \"url\": \"https://www.mxbank.com\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "379b0fed-ba24-4fde-aa9b-51d0756fd19b", "name": "List managed members", "request": { "name": "List managed members", "description": { "content": "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](/api-reference/platform-api/overview/migration).\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "managed_members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a60e7a6a-e350-4a24-abaa-971235729ead", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "managed_members" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"members\": [\n {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n },\n {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "a1b731c7-21af-445b-a93a-3559b9a38f15", "name": "Create managed member", "request": { "name": "Create managed member", "description": { "content": "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](/api-reference/platform-api/overview/migration).\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "managed_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"member\": {\n \"institution_code\": \"\",\n \"id\": \"\",\n \"metadata\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "030dba73-a5f8-4c94-b1d1-03559e71268f", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "managed_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"member\": {\n \"institution_code\": \"mxbank\",\n \"id\": \"member123\",\n \"metadata\": \"some metadata\",\n \"name\": \"MX Bank\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0c95397d-5c0d-455a-a632-d5a61c7fe866", "name": "Delete managed member", "request": { "name": "Delete managed member", "description": { "content": "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](/api-reference/platform-api/overview/migration).\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "8d1b7a92-8337-4b8b-909c-84e2e354392d", "name": "No Content", "originalRequest": { "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "disabled": false, "description": "(Required) Specifies the media type expected in the response.", "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "e8c227b8-1033-4939-a04e-43ed1290fe4f", "name": "Read managed member", "request": { "name": "Read managed member", "description": { "content": "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](/api-reference/platform-api/overview/migration).\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7daea7ef-e990-4e7c-868f-3035d53692be", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "e52c5ec2-ebdf-413a-b73a-dc64cb490472", "name": "Update managed member", "request": { "name": "Update managed member", "description": { "content": "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](/api-reference/platform-api/overview/migration).\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"member\": {\n \"id\": \"\",\n \"metadata\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "227791eb-6e5d-42c2-ab44-18855fad6b48", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"member\": {\n \"id\": \"member123\",\n \"metadata\": \"some metadata\",\n \"name\": \"MX Bank\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"member\": {\n \"aggregated_at\": \"2016-10-13T18:07:57.000Z\",\n \"background_aggregation_is_disabled\": false,\n \"connection_status\": \"CONNECTED\",\n \"connection_status_message\": \"Connected to MX Bank\",\n \"error\": {},\n \"guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"id\": \"unique_id\",\n \"institution_code\": \"mxbank\",\n \"institution_guid\": \"INST-12345678-90ab-cdef-1234-567890abcdef\",\n \"is_being_aggregated\": false,\n \"is_managed_by_user\": false,\n \"is_manual\": false,\n \"is_oauth\": false,\n \"metadata\": \"\\\\\\\"credentials_last_refreshed_at\\\\\\\": \\\\\\\"2015-10-15\\\\\",\n \"most_recent_job_detail_code\": null,\n \"most_recent_job_detail_text\": null,\n \"most_recent_job_guid\": \"JOB-12345678-90ab-cdef-1234-567890abcdef\",\n \"name\": \"MX Bank\",\n \"needs_updated_credentials\": false,\n \"oauth_window_uri\": \"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2\",\n \"successfully_aggregated_at\": \"2016-10-13T17:57:38.000Z\",\n \"use_cases\": [\n \"PFM\"\n ],\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0a78767c-8fdd-483e-91d1-0b24e7765254", "name": "List managed accounts", "request": { "name": "List managed accounts", "description": { "content": "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](/api-reference/platform-api/overview/migration).\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e113841f-50b5-4caf-9825-07ff088bc1d1", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accounts\": [\n {\n \"account_number\": \"3331261\",\n \"account_ownership\": \"INDIVIDUAL\",\n \"annuity_policy_to_date\": \"2025-12-31\",\n \"annuity_provider\": \"Metlife\",\n \"annuity_term_year\": 30,\n \"apr\": 1,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"available_credit\": 4000,\n \"balance\": 1000,\n \"cash_balance\": 2500,\n \"cash_surrender_value\": 1000,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"day_payment_is_due\": 14,\n \"death_benefit\": 1000,\n \"federal_insurance_status\": \"INSURED\",\n \"guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"id\": \"1040434698\",\n \"imported_at\": \"2015-10-13T17:57:37.000Z\",\n \"interest_rate\": 3.25,\n \"institution_code\": \"3af3685e-05d9-7060-359f-008d0755e993\",\n \"insured_name\": \"Tommy Shelby\",\n \"is_closed\": false,\n \"is_hidden\": false,\n \"is_manual\": false,\n \"last_payment\": 100,\n \"last_payment_at\": \"2023-07-25T17:14:46Z\",\n \"loan_amount\": 1000,\n \"margin_balance\": 1000,\n \"matures_on\": \"2015-10-13T17:57:37.000Z\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_id\": \"member123\",\n \"member_is_managed_by_user\": false,\n \"metadata\": \"some metadata\",\n \"minimum_balance\": 100,\n \"minimum_payment\": 10,\n \"name\": \"Test account 2\",\n \"nickname\": \"My Checking\",\n \"original_balance\": 10,\n \"pay_out_amount\": 10,\n \"payment_due_at\": \"2015-10-13T17:57:37.000Z\",\n \"payoff_balance\": 10,\n \"premium_amount\": 1,\n \"property_type\": \"VEHICLE\",\n \"routing_number\": \"68899990000000\",\n \"started_on\": \"2025-10-13T17:57:37.000Z\",\n \"statement_balance\": 1000.5,\n \"subtype\": \"MONEY_MARKET\",\n \"today_ugl_amount\": 1000.5,\n \"today_ugl_percentage\": 6.9,\n \"total_account_value\": 1,\n \"total_account_value_ugl\": 1,\n \"type\": \"CHECKING\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n },\n {\n \"account_number\": \"3331261\",\n \"account_ownership\": \"INDIVIDUAL\",\n \"annuity_policy_to_date\": \"2025-12-31\",\n \"annuity_provider\": \"Metlife\",\n \"annuity_term_year\": 30,\n \"apr\": 1,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"available_credit\": 4000,\n \"balance\": 1000,\n \"cash_balance\": 2500,\n \"cash_surrender_value\": 1000,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"day_payment_is_due\": 14,\n \"death_benefit\": 1000,\n \"federal_insurance_status\": \"INSURED\",\n \"guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"id\": \"1040434698\",\n \"imported_at\": \"2015-10-13T17:57:37.000Z\",\n \"interest_rate\": 3.25,\n \"institution_code\": \"3af3685e-05d9-7060-359f-008d0755e993\",\n \"insured_name\": \"Tommy Shelby\",\n \"is_closed\": false,\n \"is_hidden\": false,\n \"is_manual\": false,\n \"last_payment\": 100,\n \"last_payment_at\": \"2023-07-25T17:14:46Z\",\n \"loan_amount\": 1000,\n \"margin_balance\": 1000,\n \"matures_on\": \"2015-10-13T17:57:37.000Z\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_id\": \"member123\",\n \"member_is_managed_by_user\": false,\n \"metadata\": \"some metadata\",\n \"minimum_balance\": 100,\n \"minimum_payment\": 10,\n \"name\": \"Test account 2\",\n \"nickname\": \"My Checking\",\n \"original_balance\": 10,\n \"pay_out_amount\": 10,\n \"payment_due_at\": \"2015-10-13T17:57:37.000Z\",\n \"payoff_balance\": 10,\n \"premium_amount\": 1,\n \"property_type\": \"VEHICLE\",\n \"routing_number\": \"68899990000000\",\n \"started_on\": \"2025-10-13T17:57:37.000Z\",\n \"statement_balance\": 1000.5,\n \"subtype\": \"MONEY_MARKET\",\n \"today_ugl_amount\": 1000.5,\n \"today_ugl_percentage\": 6.9,\n \"total_account_value\": 1,\n \"total_account_value_ugl\": 1,\n \"type\": \"CHECKING\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "562e4939-4e5d-4097-b148-652aa8dccf8d", "name": "Create managed account", "request": { "name": "Create managed account", "description": { "content": "Use this endpoint to create a partner-managed account.\n:::warning Deprecated\nThis endpoint has been deprecated. For more information, reference the [Migration guide](/api-reference/platform-api/overview/migration).\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"balance\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"account_number\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"available_credit\": \"\",\n \"cash_surrender_value\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"day_payment_is_due\": \"\",\n \"death_benefit\": \"\",\n \"interest_rate\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"last_payment\": \"\",\n \"last_payment_at\": \"\",\n \"loan_amount\": \"\",\n \"matures_on\": \"\",\n \"metadata\": \"\",\n \"minimum_balance\": \"\",\n \"minimum_payment\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"payment_due_at\": \"\",\n \"payoff_balance\": \"\",\n \"routing_number\": \"\",\n \"started_on\": \"\",\n \"subtype\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b35b3a52-c83c-4829-bf33-a205a0c9fc57", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"balance\": 1000,\n \"id\": \"1040434698\",\n \"name\": \"Test account 2\",\n \"type\": \"SAVINGS\",\n \"account_number\": \"3331261\",\n \"apr\": 5.25,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"available_credit\": 4000,\n \"cash_surrender_value\": 1000,\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"day_payment_is_due\": 14,\n \"death_benefit\": 1000,\n \"interest_rate\": 3.25,\n \"is_closed\": false,\n \"is_hidden\": false,\n \"last_payment\": 100,\n \"last_payment_at\": \"2015-10-13T17:57:37.000Z\",\n \"loan_amount\": 1000,\n \"matures_on\": \"2015-10-13T17:57:37.000Z\",\n \"metadata\": \"\",\n \"minimum_balance\": 100,\n \"minimum_payment\": 10,\n \"nickname\": \"Swiss Account\",\n \"original_balance\": 10,\n \"payment_due_at\": \"2015-10-13T17:57:37.000Z\",\n \"payoff_balance\": 10,\n \"routing_number\": \"68899990000000\",\n \"started_on\": \"2015-10-13T17:57:37.000Z\",\n \"subtype\": \"NONE\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account\": {\n \"account_number\": \"3331261\",\n \"account_ownership\": \"INDIVIDUAL\",\n \"annuity_policy_to_date\": \"2025-12-31\",\n \"annuity_provider\": \"Metlife\",\n \"annuity_term_year\": 30,\n \"apr\": 1,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"available_credit\": 4000,\n \"balance\": 1000,\n \"cash_balance\": 2500,\n \"cash_surrender_value\": 1000,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"day_payment_is_due\": 14,\n \"death_benefit\": 1000,\n \"federal_insurance_status\": \"INSURED\",\n \"guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"id\": \"1040434698\",\n \"imported_at\": \"2015-10-13T17:57:37.000Z\",\n \"interest_rate\": 3.25,\n \"institution_code\": \"3af3685e-05d9-7060-359f-008d0755e993\",\n \"insured_name\": \"Tommy Shelby\",\n \"is_closed\": false,\n \"is_hidden\": false,\n \"is_manual\": false,\n \"last_payment\": 100,\n \"last_payment_at\": \"2023-07-25T17:14:46Z\",\n \"loan_amount\": 1000,\n \"margin_balance\": 1000,\n \"matures_on\": \"2015-10-13T17:57:37.000Z\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_id\": \"member123\",\n \"member_is_managed_by_user\": false,\n \"metadata\": \"some metadata\",\n \"minimum_balance\": 100,\n \"minimum_payment\": 10,\n \"name\": \"Test account 2\",\n \"nickname\": \"My Checking\",\n \"original_balance\": 10,\n \"pay_out_amount\": 10,\n \"payment_due_at\": \"2015-10-13T17:57:37.000Z\",\n \"payoff_balance\": 10,\n \"premium_amount\": 1,\n \"property_type\": \"VEHICLE\",\n \"routing_number\": \"68899990000000\",\n \"started_on\": \"2025-10-13T17:57:37.000Z\",\n \"statement_balance\": 1000.5,\n \"subtype\": \"MONEY_MARKET\",\n \"today_ugl_amount\": 1000.5,\n \"today_ugl_percentage\": 6.9,\n \"total_account_value\": 1,\n \"total_account_value_ugl\": 1,\n \"type\": \"CHECKING\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2c114dcb-0abf-4178-8ba1-08804a78ea86", "name": "Delete managed account", "request": { "name": "Delete managed account", "description": { "content": "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](/api-reference/platform-api/overview/migration).\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "b6a71872-4e25-4193-bae2-04210e96c649", "name": "No Content", "originalRequest": { "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "e1a4979f-b67c-4c11-846c-23e6c4f8992e", "name": "Read managed account", "request": { "name": "Read managed account", "description": { "content": "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](/api-reference/platform-api/overview/migration).\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5a28cdd3-4fba-4c19-8fbc-ed615fb95af1", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account\": {\n \"account_number\": \"3331261\",\n \"account_ownership\": \"INDIVIDUAL\",\n \"annuity_policy_to_date\": \"2025-12-31\",\n \"annuity_provider\": \"Metlife\",\n \"annuity_term_year\": 30,\n \"apr\": 1,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"available_credit\": 4000,\n \"balance\": 1000,\n \"cash_balance\": 2500,\n \"cash_surrender_value\": 1000,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"day_payment_is_due\": 14,\n \"death_benefit\": 1000,\n \"federal_insurance_status\": \"INSURED\",\n \"guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"id\": \"1040434698\",\n \"imported_at\": \"2015-10-13T17:57:37.000Z\",\n \"interest_rate\": 3.25,\n \"institution_code\": \"3af3685e-05d9-7060-359f-008d0755e993\",\n \"insured_name\": \"Tommy Shelby\",\n \"is_closed\": false,\n \"is_hidden\": false,\n \"is_manual\": false,\n \"last_payment\": 100,\n \"last_payment_at\": \"2023-07-25T17:14:46Z\",\n \"loan_amount\": 1000,\n \"margin_balance\": 1000,\n \"matures_on\": \"2015-10-13T17:57:37.000Z\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_id\": \"member123\",\n \"member_is_managed_by_user\": false,\n \"metadata\": \"some metadata\",\n \"minimum_balance\": 100,\n \"minimum_payment\": 10,\n \"name\": \"Test account 2\",\n \"nickname\": \"My Checking\",\n \"original_balance\": 10,\n \"pay_out_amount\": 10,\n \"payment_due_at\": \"2015-10-13T17:57:37.000Z\",\n \"payoff_balance\": 10,\n \"premium_amount\": 1,\n \"property_type\": \"VEHICLE\",\n \"routing_number\": \"68899990000000\",\n \"started_on\": \"2025-10-13T17:57:37.000Z\",\n \"statement_balance\": 1000.5,\n \"subtype\": \"MONEY_MARKET\",\n \"today_ugl_amount\": 1000.5,\n \"today_ugl_percentage\": 6.9,\n \"total_account_value\": 1,\n \"total_account_value_ugl\": 1,\n \"type\": \"CHECKING\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "bfcfbbc1-5120-442b-98f0-b61f5a8e0b1c", "name": "Update managed account", "request": { "name": "Update managed account", "description": { "content": "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](/api-reference/platform-api/overview/migration).\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"account_number\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"available_credit\": \"\",\n \"balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"day_payment_is_due\": \"\",\n \"death_benefit\": \"\",\n \"id\": \"\",\n \"interest_rate\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"last_payment\": \"\",\n \"last_payment_at\": \"\",\n \"loan_amount\": \"\",\n \"matures_on\": \"\",\n \"metadata\": \"\",\n \"minimum_balance\": \"\",\n \"minimum_payment\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"payment_due_at\": \"\",\n \"payoff_balance\": \"\",\n \"routing_number\": \"\",\n \"started_on\": \"\",\n \"subtype\": \"\",\n \"type\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "76858bba-345f-4e8c-8900-af00e44fa645", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"account_number\": \"3331261\",\n \"apr\": 5.25,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"available_credit\": 4000,\n \"balance\": 1000,\n \"cash_surrender_value\": 1000,\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"day_payment_is_due\": 14,\n \"death_benefit\": 1000,\n \"id\": \"1040434698\",\n \"interest_rate\": 3.25,\n \"is_closed\": false,\n \"is_hidden\": false,\n \"last_payment\": 100,\n \"last_payment_at\": \"2015-10-13T17:57:37.000Z\",\n \"loan_amount\": 1000,\n \"matures_on\": \"2015-10-13T17:57:37.000Z\",\n \"metadata\": \"some metadata\",\n \"minimum_balance\": 100,\n \"minimum_payment\": 10,\n \"name\": \"Test account 2\",\n \"nickname\": \"Swiss Account\",\n \"original_balance\": 10,\n \"payment_due_at\": \"2015-10-13T17:57:37.000Z\",\n \"payoff_balance\": 10,\n \"routing_number\": \"68899990000000\",\n \"started_on\": \"2015-10-13T17:57:37.000Z\",\n \"subtype\": \"NONE\",\n \"type\": \"SAVINGS\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account\": {\n \"account_number\": \"3331261\",\n \"account_ownership\": \"INDIVIDUAL\",\n \"annuity_policy_to_date\": \"2025-12-31\",\n \"annuity_provider\": \"Metlife\",\n \"annuity_term_year\": 30,\n \"apr\": 1,\n \"apy\": 2.35,\n \"available_balance\": 1000,\n \"available_credit\": 4000,\n \"balance\": 1000,\n \"cash_balance\": 2500,\n \"cash_surrender_value\": 1000,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"credit_limit\": 5000,\n \"currency_code\": \"USD\",\n \"day_payment_is_due\": 14,\n \"death_benefit\": 1000,\n \"federal_insurance_status\": \"INSURED\",\n \"guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"id\": \"1040434698\",\n \"imported_at\": \"2015-10-13T17:57:37.000Z\",\n \"interest_rate\": 3.25,\n \"institution_code\": \"3af3685e-05d9-7060-359f-008d0755e993\",\n \"insured_name\": \"Tommy Shelby\",\n \"is_closed\": false,\n \"is_hidden\": false,\n \"is_manual\": false,\n \"last_payment\": 100,\n \"last_payment_at\": \"2023-07-25T17:14:46Z\",\n \"loan_amount\": 1000,\n \"margin_balance\": 1000,\n \"matures_on\": \"2015-10-13T17:57:37.000Z\",\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_id\": \"member123\",\n \"member_is_managed_by_user\": false,\n \"metadata\": \"some metadata\",\n \"minimum_balance\": 100,\n \"minimum_payment\": 10,\n \"name\": \"Test account 2\",\n \"nickname\": \"My Checking\",\n \"original_balance\": 10,\n \"pay_out_amount\": 10,\n \"payment_due_at\": \"2015-10-13T17:57:37.000Z\",\n \"payoff_balance\": 10,\n \"premium_amount\": 1,\n \"property_type\": \"VEHICLE\",\n \"routing_number\": \"68899990000000\",\n \"started_on\": \"2025-10-13T17:57:37.000Z\",\n \"statement_balance\": 1000.5,\n \"subtype\": \"MONEY_MARKET\",\n \"today_ugl_amount\": 1000.5,\n \"today_ugl_percentage\": 6.9,\n \"total_account_value\": 1,\n \"total_account_value_ugl\": 1,\n \"type\": \"CHECKING\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f21d1a8-a918-4bb8-ab0c-14ecd1879ed5", "name": "List managed transactions", "request": { "name": "List managed transactions", "description": { "content": "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](/api-reference/platform-api/overview/migration).\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Results are paginated. Specify current page." }, { "disabled": false, "key": "from_date", "value": "", "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." }, { "disabled": false, "key": "to_date", "value": "", "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." }, { "disabled": false, "key": "records_per_page", "value": "", "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." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e97fa63d-d052-4472-a5c3-bda614620190", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "from_date", "value": "2024-02-01" }, { "key": "to_date", "value": "2024-08-28" }, { "key": "records_per_page", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transactions\": [\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_id\": \"account123\",\n \"amount\": 61.11,\n \"category\": \"Paycheck\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"check_number_string\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"currency_code\": \"USD\",\n \"date\": \"2024-12-20\",\n \"description\": \"MX Technologies Payroll\",\n \"extended_transaction_type\": null,\n \"guid\": \"TRN-429ad9fe-a1d2-4559-8590-885b2603f0e1\",\n \"id\": \"1734681600000-178fa8095c154a55b9172f977b4c5f9a-0\",\n \"is_bill_pay\": false,\n \"is_direct_deposit\": false,\n \"is_expense\": false,\n \"is_fee\": false,\n \"is_income\": true,\n \"is_international\": false,\n \"is_manual\": false,\n \"is_overdraft_fee\": false,\n \"is_payroll_advance\": false,\n \"is_recurring\": null,\n \"is_subscription\": false,\n \"latitude\": null,\n \"localized_description\": \"This is a localized_description\",\n \"localized_memo\": \"This is a localized_memo\",\n \"longitude\": null,\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_is_managed_by_user\": true,\n \"memo\": \"Transactions\",\n \"merchant_category_code\": null,\n \"merchant_guid\": \"MCH-8cc3b01a-1c52-47d4-970d-30f8ee5566f1\",\n \"merchant_location_guid\": null,\n \"metadata\": \"some metadata\",\n \"original_description\": \"MX TECHNOLOGIES PAYMENT\",\n \"posted_at\": \"2024-12-20T12:00:00Z\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"Income\",\n \"transacted_at\": \"2024-12-20T12:00:00Z\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n },\n {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_id\": \"account123\",\n \"amount\": 61.11,\n \"category\": \"Paycheck\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"check_number_string\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"currency_code\": \"USD\",\n \"date\": \"2024-12-20\",\n \"description\": \"MX Technologies Payroll\",\n \"extended_transaction_type\": null,\n \"guid\": \"TRN-429ad9fe-a1d2-4559-8590-885b2603f0e1\",\n \"id\": \"1734681600000-178fa8095c154a55b9172f977b4c5f9a-0\",\n \"is_bill_pay\": false,\n \"is_direct_deposit\": false,\n \"is_expense\": false,\n \"is_fee\": false,\n \"is_income\": true,\n \"is_international\": false,\n \"is_manual\": false,\n \"is_overdraft_fee\": false,\n \"is_payroll_advance\": false,\n \"is_recurring\": null,\n \"is_subscription\": false,\n \"latitude\": null,\n \"localized_description\": \"This is a localized_description\",\n \"localized_memo\": \"This is a localized_memo\",\n \"longitude\": null,\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_is_managed_by_user\": true,\n \"memo\": \"Transactions\",\n \"merchant_category_code\": null,\n \"merchant_guid\": \"MCH-8cc3b01a-1c52-47d4-970d-30f8ee5566f1\",\n \"merchant_location_guid\": null,\n \"metadata\": \"some metadata\",\n \"original_description\": \"MX TECHNOLOGIES PAYMENT\",\n \"posted_at\": \"2024-12-20T12:00:00Z\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"Income\",\n \"transacted_at\": \"2024-12-20T12:00:00Z\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 25,\n \"total_entries\": 1,\n \"total_pages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "e53d3c62-cda3-46d7-9141-32b54d3d43ce", "name": "Create managed transaction", "request": { "name": "Create managed transaction", "description": { "content": "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](/api-reference/platform-api/overview/migration).\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"status\": \"\",\n \"posted_at\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"\",\n \"category\": \"\",\n \"check_number_string\": \"\",\n \"currency_code\": \"\",\n \"id\": \"\",\n \"is_international\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "417381f8-4502-46cc-a9ff-120d934e8e0f", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"61.11\",\n \"description\": \"Whole Foods\",\n \"status\": \"POSTED\",\n \"posted_at\": \"2016-10-07T06:00:00.000Z\",\n \"transacted_at\": \"2016-10-06T13:00:00.000Z\",\n \"type\": \"DEBIT\",\n \"category\": \"Groceries\",\n \"check_number_string\": \"6812\",\n \"currency_code\": \"USD\",\n \"id\": \"transaction-265abee9-889b-af6a-c69b-25157db2bdd9\",\n \"is_international\": false,\n \"latitude\": -43.2075,\n \"localized_description\": \"This is a localized_description\",\n \"localized_memo\": \"This is a localized_memo\",\n \"longitude\": 139.691706,\n \"memo\": \"This is a memo\",\n \"merchant_category_code\": 5411,\n \"merchant_guid\": \"MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b\",\n \"merchant_location_guid\": \"MCL-00024e59-18b5-4d79-b879-2a7896726fea\",\n \"metadata\": \"some metadata\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transaction\": {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_id\": \"account123\",\n \"amount\": 61.11,\n \"category\": \"Paycheck\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"check_number_string\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"currency_code\": \"USD\",\n \"date\": \"2024-12-20\",\n \"description\": \"MX Technologies Payroll\",\n \"extended_transaction_type\": null,\n \"guid\": \"TRN-429ad9fe-a1d2-4559-8590-885b2603f0e1\",\n \"id\": \"1734681600000-178fa8095c154a55b9172f977b4c5f9a-0\",\n \"is_bill_pay\": false,\n \"is_direct_deposit\": false,\n \"is_expense\": false,\n \"is_fee\": false,\n \"is_income\": true,\n \"is_international\": false,\n \"is_manual\": false,\n \"is_overdraft_fee\": false,\n \"is_payroll_advance\": false,\n \"is_recurring\": null,\n \"is_subscription\": false,\n \"latitude\": null,\n \"localized_description\": \"This is a localized_description\",\n \"localized_memo\": \"This is a localized_memo\",\n \"longitude\": null,\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_is_managed_by_user\": true,\n \"memo\": \"Transactions\",\n \"merchant_category_code\": null,\n \"merchant_guid\": \"MCH-8cc3b01a-1c52-47d4-970d-30f8ee5566f1\",\n \"merchant_location_guid\": null,\n \"metadata\": \"some metadata\",\n \"original_description\": \"MX TECHNOLOGIES PAYMENT\",\n \"posted_at\": \"2024-12-20T12:00:00Z\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"Income\",\n \"transacted_at\": \"2024-12-20T12:00:00Z\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "145c06c8-141f-4984-b159-b4b2c5f8994d", "name": "Delete managed transaction", "request": { "name": "Delete managed transaction", "description": { "content": "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](/api-reference/platform-api/overview/migration).\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions", ":transaction_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "024bd14a-3ee1-4ae4-9721-85c038b2346e", "name": "No Content", "originalRequest": { "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions", ":transaction_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "181940bb-c400-4ed2-bffd-a525582b62eb", "name": "Read managed transaction", "request": { "name": "Read managed transaction", "description": { "content": "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](/api-reference/platform-api/overview/migration).\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions", ":transaction_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e318b66a-e4f5-4976-9814-b9fcba2660eb", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions", ":transaction_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transaction\": {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_id\": \"account123\",\n \"amount\": 61.11,\n \"category\": \"Paycheck\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"check_number_string\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"currency_code\": \"USD\",\n \"date\": \"2024-12-20\",\n \"description\": \"MX Technologies Payroll\",\n \"extended_transaction_type\": null,\n \"guid\": \"TRN-429ad9fe-a1d2-4559-8590-885b2603f0e1\",\n \"id\": \"1734681600000-178fa8095c154a55b9172f977b4c5f9a-0\",\n \"is_bill_pay\": false,\n \"is_direct_deposit\": false,\n \"is_expense\": false,\n \"is_fee\": false,\n \"is_income\": true,\n \"is_international\": false,\n \"is_manual\": false,\n \"is_overdraft_fee\": false,\n \"is_payroll_advance\": false,\n \"is_recurring\": null,\n \"is_subscription\": false,\n \"latitude\": null,\n \"localized_description\": \"This is a localized_description\",\n \"localized_memo\": \"This is a localized_memo\",\n \"longitude\": null,\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_is_managed_by_user\": true,\n \"memo\": \"Transactions\",\n \"merchant_category_code\": null,\n \"merchant_guid\": \"MCH-8cc3b01a-1c52-47d4-970d-30f8ee5566f1\",\n \"merchant_location_guid\": null,\n \"metadata\": \"some metadata\",\n \"original_description\": \"MX TECHNOLOGIES PAYMENT\",\n \"posted_at\": \"2024-12-20T12:00:00Z\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"Income\",\n \"transacted_at\": \"2024-12-20T12:00:00Z\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] }, { "id": "03b39598-ed38-4939-b078-d4ad9ca9e308", "name": "Update managed transaction", "request": { "name": "Update managed transaction", "description": { "content": "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](/api-reference/platform-api/overview/migration).\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions", ":transaction_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"category\": \"\",\n \"check_number_string\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"is_international\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"posted_at\": \"\",\n \"status\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5d7de289-3211-406c-a3b7-036c69deab94", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions", ":transaction_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "account_guid", "description": "(Required) The unique id for an `account`." }, { "disabled": false, "type": "any", "value": "", "key": "member_guid", "description": "(Required) The unique id for a `member`." }, { "disabled": false, "type": "any", "value": "", "key": "transaction_guid", "description": "(Required) The unique id for a `transaction`." }, { "disabled": false, "type": "any", "value": "", "key": "user_guid", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"61.11\",\n \"category\": \"Groceries\",\n \"check_number_string\": \"6812\",\n \"currency_code\": \"USD\",\n \"description\": \"Whole foods\",\n \"id\": \"transaction-265abee9-889b-af6a-c69b-25157db2bdd9\",\n \"is_international\": false,\n \"latitude\": -43.2075,\n \"localized_description\": \"This is a localized_description\",\n \"localized_memo\": \"This is a localized_memo\",\n \"longitude\": 139.691706,\n \"memo\": \"This is a memo\",\n \"merchant_category_code\": 5411,\n \"merchant_guid\": \"MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b\",\n \"merchant_location_guid\": \"MCL-00024e59-18b5-4d79-b879-2a7896726fea\",\n \"metadata\": \"some metadata\",\n \"posted_at\": \"2016-10-07T06:00:00.000Z\",\n \"status\": \"POSTED\",\n \"transacted_at\": \"2016-10-06T13:00:00.000Z\",\n \"type\": \"DEBIT\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transaction\": {\n \"account_guid\": \"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1\",\n \"account_id\": \"account123\",\n \"amount\": 61.11,\n \"category\": \"Paycheck\",\n \"category_guid\": \"CAT-b6d61a19-30a7-e852-2703-bdfb4072289e\",\n \"check_number_string\": null,\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"currency_code\": \"USD\",\n \"date\": \"2024-12-20\",\n \"description\": \"MX Technologies Payroll\",\n \"extended_transaction_type\": null,\n \"guid\": \"TRN-429ad9fe-a1d2-4559-8590-885b2603f0e1\",\n \"id\": \"1734681600000-178fa8095c154a55b9172f977b4c5f9a-0\",\n \"is_bill_pay\": false,\n \"is_direct_deposit\": false,\n \"is_expense\": false,\n \"is_fee\": false,\n \"is_income\": true,\n \"is_international\": false,\n \"is_manual\": false,\n \"is_overdraft_fee\": false,\n \"is_payroll_advance\": false,\n \"is_recurring\": null,\n \"is_subscription\": false,\n \"latitude\": null,\n \"localized_description\": \"This is a localized_description\",\n \"localized_memo\": \"This is a localized_memo\",\n \"longitude\": null,\n \"member_guid\": \"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b\",\n \"member_is_managed_by_user\": true,\n \"memo\": \"Transactions\",\n \"merchant_category_code\": null,\n \"merchant_guid\": \"MCH-8cc3b01a-1c52-47d4-970d-30f8ee5566f1\",\n \"merchant_location_guid\": null,\n \"metadata\": \"some metadata\",\n \"original_description\": \"MX TECHNOLOGIES PAYMENT\",\n \"posted_at\": \"2024-12-20T12:00:00Z\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"Income\",\n \"transacted_at\": \"2024-12-20T12:00:00Z\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"2025-02-13T18:09:00+00:00\",\n \"user_guid\": \"USR-fa7537f3-48aa-a683-a02a-b18940482f54\",\n \"user_id\": \"u-1234\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a3f2088f-fb53-4f24-b538-42459ca25c0b", "name": "jobs", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "3e86fe14-307e-44ed-bd47-3f61646b3c20", "name": "Read job", "request": { "name": "Read job", "description": { "content": "Use this endpoint to read the attributes of a specific job.\n:::warning\nNew implementations shouldn't use this endpoint. It is maintained for compatibility with our Nexus API only.\n:::\n", "type": "text/plain" }, "url": { "path": [ "users", ":user_identifier", "jobs", ":job_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "job_guid", "description": "(Required) The unique identifier for the job. Defined by MX." } ] }, "header": [ { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "8905d49e-ad0f-4736-8e28-beb5ff4e0a5a", "name": "OK", "originalRequest": { "url": { "path": [ "users", ":user_identifier", "jobs", ":job_guid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_identifier", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "disabled": false, "type": "any", "value": "", "key": "job_guid", "description": "(Required) The unique identifier for the job. Defined by MX." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " }, { "disabled": false, "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"job\": {\n \"created_at\": \"2025-02-13T18:08:00+00:00\",\n \"error_message\": null,\n \"error_message_code\": null,\n \"finished_at\": \"2022-06-16T18:42:43+00:00\",\n \"institution_guid\": \"INS-1572a04c-912b-59bf-5841-332c7dfafaef\",\n \"is_authenticated\": true,\n \"member_guid\": \"MBR-84ca0882-ad6c-4f10-817f-c8c0de7424fa\",\n \"started_at\": \"2022-06-16T18:42:30+00:00\",\n \"status\": 6,\n \"status_name\": {},\n \"updated_at\": \"2022-06-16T18:42:43+00:00\",\n \"user_guid\": \"USR-11141024-90b3-1bce-cac9-c06ced52ab4c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [] } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://int-api.mx.com", "key": "baseUrl" }, { "disabled": false, "description": { "content": "(Required) The unique id for a `statement`.", "type": "text/plain" }, "type": "any", "value": "", "key": "statement_guid" } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "" }, { "key": "password", "value": "" } ] }, "info": { "_postman_id": "efd5b024-339c-4baf-a932-38e6f1837dde", "name": "MX Platform API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.\n\n## What's Changed?\n\nSeveral endpoints, headers, and fields changed in `v20250224`. For more on breaking changes, refer to our [versioning](/api-reference/platform-api/overview/versioning#v20250224) and [migration](/api-reference/platform-api/overview/migration) guides.\n\n## Version Header\nVersions are set in the `Accept-Version` header of API requests. Version numbers correspond with the date associated with that version. The example below uses the version `v20250224`.\n\n```\n-H 'Accept: application/json'\n-H 'Accept-Version: v20250224'\n```\n\n---\n\n\nContact Support:\n Name: MX Platform API", "type": "text/plain" } } }