{ "info": { "_postman_id": "97ef8567-a492-4c85-9bc2-52bd9f0c9bb3", "name": "MX Platform API", "description": "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", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:15:32.000Z", "updatedAt": "2026-07-28T02:15:34.000Z", "lastUpdatedBy": "35240", "uid": "35240-97ef8567-a492-4c85-9bc2-52bd9f0c9bb3" }, "item": [ { "name": "authorization_code", "item": [ { "name": "Request an authorization code", "id": "0f3533f6-395b-4f69-8c17-9519f5c8a57f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"authorization_code\": {\n \"scope\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/authorization_code", "host": [ "{{baseUrl}}" ], "path": [ "authorization_code" ] }, "description": "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." }, "response": [ { "id": "bec7834c-be0d-4a8b-a3c9-fbb36c6f1244", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"authorization_code\": {\n \"scope\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/authorization_code", "host": [ "{{baseUrl}}" ], "path": [ "authorization_code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"authorization_code\": {\n \"code\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-bec7834c-be0d-4a8b-a3c9-fbb36c6f1244" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-0f3533f6-395b-4f69-8c17-9519f5c8a57f" } ], "id": "1d6fc211-6e90-4ea7-bcbb-d96d648fd29f", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-1d6fc211-6e90-4ea7-bcbb-d96d648fd29f" }, { "name": "ach_returns", "item": [ { "name": "{ach_return_guid}", "item": [ { "name": "Read ACH Return", "id": "d70615e3-0f6c-474e-96b8-f9eb43b9316d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ach_returns/:ach_return_guid", "host": [ "{{baseUrl}}" ], "path": [ "ach_returns", ":ach_return_guid" ], "variable": [ { "id": "3d568911-f803-4b8c-8277-14ac8669a168", "key": "ach_return_guid", "value": "", "description": "(Required) The unique identifier (`guid`) for the ACH return. Defined by MX." } ] }, "description": "Use this endpoint to get an ACH return by its `guid` or `id`.\n" }, "response": [ { "id": "83e0c051-bcc7-40d2-b4de-eb1a088c0a9f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/ach_returns/:ach_return_guid", "host": [ "{{baseUrl}}" ], "path": [ "ach_returns", ":ach_return_guid" ], "variable": [ { "key": "ach_return_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"ach_return\": {\n \"account_guid\": \"\",\n \"account_number_last_four\": \"\",\n \"account_type\": \"CREDIT_CARD\",\n \"ach_initiated_at\": \"\",\n \"client_guid\": \"\",\n \"corrected_account_number\": \"\",\n \"corrected_routing_number\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_guid\": \"\",\n \"investigation_notes\": \"\",\n \"member_guid\": \"\",\n \"processing_errors\": \"\",\n \"resolution_code\": \"\",\n \"resolution_detail\": \"\",\n \"resolved_status_at\": \"\",\n \"return_code\": \"\",\n \"return_notes\": \"\",\n \"return_account_number\": \"\",\n \"return_routing_number\": \"\",\n \"return_status\": \"\",\n \"returned_at\": \"\",\n \"sec_code\": \"\",\n \"started_processing_at\": \"\",\n \"submitted_at\": \"\",\n \"transaction_amount\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-83e0c051-bcc7-40d2-b4de-eb1a088c0a9f" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d70615e3-0f6c-474e-96b8-f9eb43b9316d" } ], "id": "90c618b9-e695-4d02-b168-cc9d3cebe10a", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-90c618b9-e695-4d02-b168-cc9d3cebe10a" }, { "name": "List ACH Returns", "id": "7eb106f5-fabc-41db-9024-6607c09160df", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ach_returns?institution_guid=&returned_at=&resolved_status_at=&return_code=&return_status=&page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "ach_returns" ], "query": [ { "description": "The identifier for the institution associated with the ACH return. Defined by MX.", "key": "institution_guid", "value": "" }, { "description": "The date and time when the return was reported by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp.", "key": "returned_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", "key": "resolved_status_at", "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.", "key": "return_code", "value": "" }, { "description": "The status of the return. See [Return Statuses](/api-reference/platform-api/reference/ach-return-fields/#return-status) for a complete list.", "key": "return_status", "value": "" }, { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ] }, "description": "Use this endpoint to get all ACH returns.\n" }, "response": [ { "id": "9dbdf871-7fcd-4727-b69c-7d406358a06a", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/ach_returns?institution_guid=&returned_at=&resolved_status_at=&return_code=&return_status=&page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "ach_returns" ], "query": [ { "description": "The identifier for the institution associated with the ACH return. Defined by MX.", "key": "institution_guid", "value": "" }, { "description": "The date and time when the return was reported by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp.", "key": "returned_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", "key": "resolved_status_at", "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.", "key": "return_code", "value": "" }, { "description": "The status of the return. See [Return Statuses](/api-reference/platform-api/reference/ach-return-fields/#return-status) for a complete list.", "key": "return_status", "value": "" }, { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"ach_returns\": [\n {\n \"account_guid\": \"\",\n \"account_number_last_four\": \"\",\n \"account_type\": \"CHECKING_LINE_OF_CREDIT\",\n \"ach_initiated_at\": \"\",\n \"client_guid\": \"\",\n \"corrected_account_number\": \"\",\n \"corrected_routing_number\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_guid\": \"\",\n \"investigation_notes\": \"\",\n \"member_guid\": \"\",\n \"processing_errors\": \"\",\n \"resolution_code\": \"\",\n \"resolution_detail\": \"\",\n \"resolved_status_at\": \"\",\n \"return_code\": \"\",\n \"return_notes\": \"\",\n \"return_account_number\": \"\",\n \"return_routing_number\": \"\",\n \"return_status\": \"\",\n \"returned_at\": \"\",\n \"sec_code\": \"\",\n \"started_processing_at\": \"\",\n \"submitted_at\": \"\",\n \"transaction_amount\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n },\n {\n \"account_guid\": \"\",\n \"account_number_last_four\": \"\",\n \"account_type\": \"CREDIT_CARD\",\n \"ach_initiated_at\": \"\",\n \"client_guid\": \"\",\n \"corrected_account_number\": \"\",\n \"corrected_routing_number\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_guid\": \"\",\n \"investigation_notes\": \"\",\n \"member_guid\": \"\",\n \"processing_errors\": \"\",\n \"resolution_code\": \"\",\n \"resolution_detail\": \"\",\n \"resolved_status_at\": \"\",\n \"return_code\": \"\",\n \"return_notes\": \"\",\n \"return_account_number\": \"\",\n \"return_routing_number\": \"\",\n \"return_status\": \"\",\n \"returned_at\": \"\",\n \"sec_code\": \"\",\n \"started_processing_at\": \"\",\n \"submitted_at\": \"\",\n \"transaction_amount\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-9dbdf871-7fcd-4727-b69c-7d406358a06a" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-7eb106f5-fabc-41db-9024-6607c09160df" }, { "name": "Create ACH Return", "id": "6d0c0d85-be49-4f7f-b16f-a2470358e37e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/ach_returns", "host": [ "{{baseUrl}}" ], "path": [ "ach_returns" ] }, "description": "Use this endpoint to create an ACH return in our system.\n" }, "response": [ { "id": "1b86aaf8-12fc-4fab-b5cf-35225f2e6ee7", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/ach_returns", "host": [ "{{baseUrl}}" ], "path": [ "ach_returns" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"ach_return\": {\n \"account_guid\": \"\",\n \"account_number_last_four\": \"\",\n \"account_type\": \"CREDIT_CARD\",\n \"ach_initiated_at\": \"\",\n \"client_guid\": \"\",\n \"corrected_account_number\": \"\",\n \"corrected_routing_number\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_guid\": \"\",\n \"investigation_notes\": \"\",\n \"member_guid\": \"\",\n \"processing_errors\": \"\",\n \"resolution_code\": \"\",\n \"resolution_detail\": \"\",\n \"resolved_status_at\": \"\",\n \"return_code\": \"\",\n \"return_notes\": \"\",\n \"return_account_number\": \"\",\n \"return_routing_number\": \"\",\n \"return_status\": \"\",\n \"returned_at\": \"\",\n \"sec_code\": \"\",\n \"started_processing_at\": \"\",\n \"submitted_at\": \"\",\n \"transaction_amount\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-1b86aaf8-12fc-4fab-b5cf-35225f2e6ee7" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6d0c0d85-be49-4f7f-b16f-a2470358e37e" } ], "id": "33882f94-5e96-495f-bc51-0f0e078d1556", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-33882f94-5e96-495f-bc51-0f0e078d1556" }, { "name": "categories", "item": [ { "name": "default", "item": [ { "name": "List default categories", "id": "d38f83a3-24bd-48c7-ba19-b1e4e0a957d5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories/default?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "categories", "default" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ] }, "description": "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." }, "response": [ { "id": "687e312e-a633-470e-b599-31b3a71f0cb9", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/categories/default?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "categories", "default" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"categories\": [\n {\n \"created_at\": \"\",\n \"guid\": \"\",\n \"is_default\": \"\",\n \"is_income\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"parent_guid\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"created_at\": \"\",\n \"guid\": \"\",\n \"is_default\": \"\",\n \"is_income\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"parent_guid\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-687e312e-a633-470e-b599-31b3a71f0cb9" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d38f83a3-24bd-48c7-ba19-b1e4e0a957d5" } ], "id": "c7a4e032-dbca-4d35-be2d-6230611c00f9", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-c7a4e032-dbca-4d35-be2d-6230611c00f9" }, { "name": "{category_guid}", "item": [ { "name": "Read a default category", "id": "152d6147-aa1a-40c7-bd22-7c7e080149bc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories/:category_guid", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":category_guid" ], "variable": [ { "id": "9a6f8fd6-67ff-416c-8ef8-d76354686aa4", "key": "category_guid", "value": "", "description": "(Required) The unique id for a `category`." } ] }, "description": "Use this endpoint to read the attributes of a default category." }, "response": [ { "id": "ecd14aff-e456-413e-a795-d12016fd1b8a", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/categories/:category_guid", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":category_guid" ], "variable": [ { "key": "category_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"category\": {\n \"created_at\": \"\",\n \"guid\": \"\",\n \"is_default\": \"\",\n \"is_income\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"parent_guid\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-ecd14aff-e456-413e-a795-d12016fd1b8a" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-152d6147-aa1a-40c7-bd22-7c7e080149bc" } ], "id": "e1405b58-ef46-4932-8391-a4e7a4f3eeb1", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e1405b58-ef46-4932-8391-a4e7a4f3eeb1" } ], "id": "af4ae6b0-53ae-4000-ab7c-d21dbc44661e", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-af4ae6b0-53ae-4000-ab7c-d21dbc44661e" }, { "name": "institutions", "item": [ { "name": "favorites", "item": [ { "name": "List favorite institutions", "id": "e2fef9dd-71c2-4f50-9abd-91ae6a776459", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/institutions/favorites?iso_country_code=&iso_country_code=&page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "institutions", "favorites" ], "query": [ { "description": "An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico).", "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).", "key": "iso_country_code", "value": "" }, { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ] }, "description": "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." }, "response": [ { "id": "d975f09b-d83c-4410-9b48-66f3413b44bb", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/institutions/favorites?iso_country_code=&page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "institutions", "favorites" ], "query": [ { "description": "An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico).", "key": "iso_country_code", "value": "" }, { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"institutions\": [\n {\n \"client_status\": \"PREVENT_ALL\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"forgot_password_url\": \"\",\n \"forgot_username_url\": \"\",\n \"guid\": \"\",\n \"instructional_text\": \"\",\n \"instructional_text_steps\": [\n \"\",\n \"\"\n ],\n \"is_disabled_by_client\": \"\",\n \"is_hidden\": \"\",\n \"iso_country_code\": \"US\",\n \"medium_logo_url\": \"\",\n \"name\": \"\",\n \"small_logo_url\": \"\",\n \"status\": \"MAINTENANCE\",\n \"supports_oauth\": \"\",\n \"supports_tax_document\": \"\",\n \"trouble_signing_in_url\": \"\",\n \"url\": \"\"\n },\n {\n \"client_status\": \"PREVENT_VERIFICATION\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"forgot_password_url\": \"\",\n \"forgot_username_url\": \"\",\n \"guid\": \"\",\n \"instructional_text\": \"\",\n \"instructional_text_steps\": [\n \"\",\n \"\"\n ],\n \"is_disabled_by_client\": \"\",\n \"is_hidden\": \"\",\n \"iso_country_code\": \"US\",\n \"medium_logo_url\": \"\",\n \"name\": \"\",\n \"small_logo_url\": \"\",\n \"status\": \"DEGRADED\",\n \"supports_oauth\": \"\",\n \"supports_tax_document\": \"\",\n \"trouble_signing_in_url\": \"\",\n \"url\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d975f09b-d83c-4410-9b48-66f3413b44bb" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e2fef9dd-71c2-4f50-9abd-91ae6a776459" } ], "id": "71e0ac8a-1f50-4b7d-83a9-292a5007ab77", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-71e0ac8a-1f50-4b7d-83a9-292a5007ab77" }, { "name": "{institution_code}", "item": [ { "name": "Read institution", "id": "76163ee2-9198-4bf0-aff4-42a9034b1472", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/institutions/:institution_code", "host": [ "{{baseUrl}}" ], "path": [ "institutions", ":institution_code" ], "variable": [ { "id": "f2f7c8f2-0c9e-42e2-8c74-38d7be898128", "key": "institution_code", "value": "", "description": "(Required) A unique identifier for each institution, defined by MX." } ] }, "description": "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." }, "response": [ { "id": "17829bc7-5099-443a-bccd-afce6dc58de4", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/institutions/:institution_code", "host": [ "{{baseUrl}}" ], "path": [ "institutions", ":institution_code" ], "variable": [ { "key": "institution_code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"institution\": {\n \"client_status\": \"PREVENT_ALL_AND_DISCONNECT\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"forgot_password_url\": \"\",\n \"forgot_username_url\": \"\",\n \"guid\": \"\",\n \"instructional_text\": \"\",\n \"instructional_text_steps\": [\n \"\",\n \"\"\n ],\n \"is_disabled_by_client\": \"\",\n \"is_hidden\": \"\",\n \"iso_country_code\": \"CA\",\n \"medium_logo_url\": \"\",\n \"name\": \"\",\n \"small_logo_url\": \"\",\n \"status\": \"UNAVAILABLE\",\n \"supports_oauth\": \"\",\n \"supports_tax_document\": \"\",\n \"trouble_signing_in_url\": \"\",\n \"url\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-17829bc7-5099-443a-bccd-afce6dc58de4" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-76163ee2-9198-4bf0-aff4-42a9034b1472" } ], "id": "88f4ad50-1bce-4bcd-9f88-b257781557ea", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-88f4ad50-1bce-4bcd-9f88-b257781557ea" }, { "name": "{institution_identifier}", "item": [ { "name": "credentials", "item": [ { "name": "List institution credentials", "id": "7690846c-9c8d-4791-b1ee-51c3c8c6abc9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/institutions/:institution_identifier/credentials?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "institutions", ":institution_identifier", "credentials" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "a476297e-d477-452d-a63b-d85564b224f1", "key": "institution_identifier", "value": "", "description": "(Required) The identifier for the institution. For this identifier, use either the `institution_code` or the institution `guid`." } ] }, "description": "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" }, "response": [ { "id": "445980b3-357b-44eb-8efd-676de23fec9c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/institutions/:institution_identifier/credentials?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "institutions", ":institution_identifier", "credentials" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "institution_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"credentials\": [\n {\n \"display_order\": \"\",\n \"field_name\": \"\",\n \"field_type\": \"\",\n \"guid\": \"\",\n \"label\": \"\",\n \"type\": \"\"\n },\n {\n \"display_order\": \"\",\n \"field_name\": \"\",\n \"field_type\": \"\",\n \"guid\": \"\",\n \"label\": \"\",\n \"type\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-445980b3-357b-44eb-8efd-676de23fec9c" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-7690846c-9c8d-4791-b1ee-51c3c8c6abc9" } ], "id": "6bb1bdb5-7ec7-4eb8-977e-22223dfe47a3", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6bb1bdb5-7ec7-4eb8-977e-22223dfe47a3" } ], "id": "50f5e049-d0b8-4ca2-b22e-d06382f9cafb", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-50f5e049-d0b8-4ca2-b22e-d06382f9cafb" }, { "name": "List institutions", "id": "69c32f66-8284-4bf3-a1d6-7f4336d3fb46", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/institutions?name=&iso_country_code=&iso_country_code=&include_blocked_institutions=false&page=&records_per_page=&supported_products[]=transactions&supported_products[]=identity_verification", "host": [ "{{baseUrl}}" ], "path": [ "institutions" ], "query": [ { "description": "This will list only institutions in which the appended string appears.", "key": "name", "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).", "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).", "key": "iso_country_code", "value": "" }, { "description": "When set to `true`, returns all institutions regardless of their operational status. When `false` or omitted, only returns institutions that are currently operational.", "key": "include_blocked_institutions", "value": "false" }, { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "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`.", "key": "supported_products[]", "value": "transactions" }, { "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`.", "key": "supported_products[]", "value": "identity_verification" } ] }, "description": "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." }, "response": [ { "id": "8c60a83b-1021-49ed-a3d3-5230a49dc2c3", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/institutions?name=&iso_country_code=&include_blocked_institutions=false&page=&records_per_page=&supported_products[]=identity_verification", "host": [ "{{baseUrl}}" ], "path": [ "institutions" ], "query": [ { "description": "This will list only institutions in which the appended string appears.", "key": "name", "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).", "key": "iso_country_code", "value": "" }, { "description": "When set to `true`, returns all institutions regardless of their operational status. When `false` or omitted, only returns institutions that are currently operational.", "key": "include_blocked_institutions", "value": "false" }, { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "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`.", "key": "supported_products[]", "value": "identity_verification" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"institutions\": [\n {\n \"client_status\": \"PREVENT_ALL\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"forgot_password_url\": \"\",\n \"forgot_username_url\": \"\",\n \"guid\": \"\",\n \"instructional_text\": \"\",\n \"instructional_text_steps\": [\n \"\",\n \"\"\n ],\n \"is_disabled_by_client\": \"\",\n \"is_hidden\": \"\",\n \"iso_country_code\": \"US\",\n \"medium_logo_url\": \"\",\n \"name\": \"\",\n \"small_logo_url\": \"\",\n \"status\": \"MAINTENANCE\",\n \"supports_oauth\": \"\",\n \"supports_tax_document\": \"\",\n \"trouble_signing_in_url\": \"\",\n \"url\": \"\"\n },\n {\n \"client_status\": \"PREVENT_VERIFICATION\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"forgot_password_url\": \"\",\n \"forgot_username_url\": \"\",\n \"guid\": \"\",\n \"instructional_text\": \"\",\n \"instructional_text_steps\": [\n \"\",\n \"\"\n ],\n \"is_disabled_by_client\": \"\",\n \"is_hidden\": \"\",\n \"iso_country_code\": \"US\",\n \"medium_logo_url\": \"\",\n \"name\": \"\",\n \"small_logo_url\": \"\",\n \"status\": \"DEGRADED\",\n \"supports_oauth\": \"\",\n \"supports_tax_document\": \"\",\n \"trouble_signing_in_url\": \"\",\n \"url\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-8c60a83b-1021-49ed-a3d3-5230a49dc2c3" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-69c32f66-8284-4bf3-a1d6-7f4336d3fb46" } ], "id": "b26dfe7a-aac2-49a6-8b7b-2494ec0b22bb", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b26dfe7a-aac2-49a6-8b7b-2494ec0b22bb" }, { "name": "managed_institutions", "item": [ { "name": "List managed institutions", "id": "07a73e84-54ed-4c2a-86b7-0daf2bb67431", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/managed_institutions?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "managed_institutions" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ] }, "description": "This endpoint returns a list of institutions which can be used to create partner-managed members.\n\nThis endpoint has been deprecated. For more information, reference the [Migration guide](/api-reference/platform-api/overview/migration)\n\n" }, "response": [ { "id": "b9213b76-2499-48e3-9e45-a1bdc1cf3ddc", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/managed_institutions?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "managed_institutions" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"institutions\": [\n {\n \"client_status\": \"PREVENT_ALL\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"forgot_password_url\": \"\",\n \"forgot_username_url\": \"\",\n \"guid\": \"\",\n \"instructional_text\": \"\",\n \"instructional_text_steps\": [\n \"\",\n \"\"\n ],\n \"is_disabled_by_client\": \"\",\n \"is_hidden\": \"\",\n \"iso_country_code\": \"US\",\n \"medium_logo_url\": \"\",\n \"name\": \"\",\n \"small_logo_url\": \"\",\n \"status\": \"MAINTENANCE\",\n \"supports_oauth\": \"\",\n \"supports_tax_document\": \"\",\n \"trouble_signing_in_url\": \"\",\n \"url\": \"\"\n },\n {\n \"client_status\": \"PREVENT_VERIFICATION\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"forgot_password_url\": \"\",\n \"forgot_username_url\": \"\",\n \"guid\": \"\",\n \"instructional_text\": \"\",\n \"instructional_text_steps\": [\n \"\",\n \"\"\n ],\n \"is_disabled_by_client\": \"\",\n \"is_hidden\": \"\",\n \"iso_country_code\": \"US\",\n \"medium_logo_url\": \"\",\n \"name\": \"\",\n \"small_logo_url\": \"\",\n \"status\": \"DEGRADED\",\n \"supports_oauth\": \"\",\n \"supports_tax_document\": \"\",\n \"trouble_signing_in_url\": \"\",\n \"url\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b9213b76-2499-48e3-9e45-a1bdc1cf3ddc" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-07a73e84-54ed-4c2a-86b7-0daf2bb67431" } ], "id": "7db2927e-a36e-4427-b065-bf712d0ad924", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-7db2927e-a36e-4427-b065-bf712d0ad924" }, { "name": "merchant_locations", "item": [ { "name": "{merchant_location_guid}", "item": [ { "name": "Read merchant location", "id": "02268b79-d8b6-4efe-a280-0975bf75b359", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/merchant_locations/:merchant_location_guid", "host": [ "{{baseUrl}}" ], "path": [ "merchant_locations", ":merchant_location_guid" ], "variable": [ { "id": "73bb5854-23d2-41ca-9ee9-5efe760ff770", "key": "merchant_location_guid", "value": "", "description": "(Required) The unique id for a `merchant_location`." } ] }, "description": "This endpoint returns the specified `merchant_location` resource. The `merchant_location_guid` can be found on `transaction` objects." }, "response": [ { "id": "d34a81a3-22cf-4646-b3bf-a01fcd90c1ee", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/merchant_locations/:merchant_location_guid", "host": [ "{{baseUrl}}" ], "path": [ "merchant_locations", ":merchant_location_guid" ], "variable": [ { "key": "merchant_location_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"merchant_location\": {\n \"city\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"merchant_guid\": \"\",\n \"phone_number\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\",\n \"street_address\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d34a81a3-22cf-4646-b3bf-a01fcd90c1ee" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-02268b79-d8b6-4efe-a280-0975bf75b359" } ], "id": "feaa70bf-4a2c-49fc-b315-f52a3ad6a934", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-feaa70bf-4a2c-49fc-b315-f52a3ad6a934" } ], "id": "8c33ed30-bda6-4bd1-afb6-2b6c0b672bb7", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-8c33ed30-bda6-4bd1-afb6-2b6c0b672bb7" }, { "name": "merchants", "item": [ { "name": "{merchant_guid}", "item": [ { "name": "Read merchant", "id": "0ffac28b-2d7f-4371-b00a-e4bcdc22fc8f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchant_guid", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchant_guid" ], "variable": [ { "id": "64d4e22c-5f8c-456a-a2c1-810bfd2cf613", "key": "merchant_guid", "value": "", "description": "(Required) The unique id for a `merchant`." } ] }, "description": "Returns information about a particular merchant, such as a logo, name, and website." }, "response": [ { "id": "28e52087-5acb-460a-95ca-2c8554ebbc36", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/merchants/:merchant_guid", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchant_guid" ], "variable": [ { "key": "merchant_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"merchant\": {\n \"created_at\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"name\": \"\",\n \"updated_at\": \"\",\n \"website_url\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-28e52087-5acb-460a-95ca-2c8554ebbc36" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-0ffac28b-2d7f-4371-b00a-e4bcdc22fc8f" } ], "id": "bfd9fbfc-6c62-481a-9451-31284f136af2", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-bfd9fbfc-6c62-481a-9451-31284f136af2" }, { "name": "List merchants", "id": "80340d3a-4009-47b8-a47f-5380c6c4467e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/merchants?name=&page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ], "query": [ { "description": "This will list only merchants in which the appended string appears.", "key": "name", "value": "" }, { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ] }, "description": "This endpoint returns a paginated list of all the merchants in the MX system." }, "response": [ { "id": "d54542b9-0737-4f01-b5d3-522de97a1e3c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/merchants?name=&page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ], "query": [ { "description": "This will list only merchants in which the appended string appears.", "key": "name", "value": "" }, { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"merchants\": [\n {\n \"created_at\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"name\": \"\",\n \"updated_at\": \"\",\n \"website_url\": \"\"\n },\n {\n \"created_at\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"name\": \"\",\n \"updated_at\": \"\",\n \"website_url\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d54542b9-0737-4f01-b5d3-522de97a1e3c" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-80340d3a-4009-47b8-a47f-5380c6c4467e" } ], "id": "c54fd1d2-22b0-458e-be52-5e5a25e249a6", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-c54fd1d2-22b0-458e-be52-5e5a25e249a6" }, { "name": "transactions", "item": [ { "name": "enhance", "item": [ { "name": "Enhance transactions", "id": "f48acebc-c612-4740-8747-6c6fc9a30f70", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "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\": \"DEBIT\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"amount\": \"\",\n \"extended_transaction_type\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"type\": \"CREDIT\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/enhance", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "enhance" ] }, "description": "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)." }, "response": [ { "id": "250510f4-e909-435c-8373-72d3e9eae81b", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "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\": \"DEBIT\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"amount\": \"\",\n \"extended_transaction_type\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"type\": \"CREDIT\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/enhance", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "enhance" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"amount\": \"\",\n \"categorized_by\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"described_by\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_subscription\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"original_description\": \"\",\n \"top_level_category_guid\": \"\",\n \"type\": \"DEBIT\",\n \"user_guid\": \"\"\n },\n {\n \"amount\": \"\",\n \"categorized_by\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"described_by\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_subscription\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"original_description\": \"\",\n \"top_level_category_guid\": \"\",\n \"type\": \"CREDIT\",\n \"user_guid\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-250510f4-e909-435c-8373-72d3e9eae81b" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-f48acebc-c612-4740-8747-6c6fc9a30f70" } ], "id": "981725f7-e0b5-4c38-bc9d-18b0bc0b198e", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-981725f7-e0b5-4c38-bc9d-18b0bc0b198e" } ], "id": "2efc7527-9b5d-4e84-9077-863f256b3ae0", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-2efc7527-9b5d-4e84-9077-863f256b3ae0" }, { "name": "users", "item": [ { "name": "{user_identifier}", "item": [ { "name": "accounts", "item": [ { "name": "{account_identifier}", "item": [ { "name": "account_numbers", "item": [ { "name": "List account numbers by account", "id": "773b13c9-fe3f-4411-8480-29fec8463c22", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/accounts/:account_identifier/account_numbers?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "accounts", ":account_identifier", "account_numbers" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "c5d7af34-2094-457b-8456-027304c851c8", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "cd596dba-593f-4b45-bf78-6cacdc89da1f", "key": "account_identifier", "value": "", "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)." } ] }, "description": "This endpoint returns a list of account numbers associated with the specified `account`." }, "response": [ { "id": "85f724b8-cd4e-4486-98f9-c498a5334b6f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/accounts/:account_identifier/account_numbers?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "accounts", ":account_identifier", "account_numbers" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_identifier" }, { "key": "account_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"account_numbers\": [\n {\n \"account_guid\": \"\",\n \"account_number\": \"\",\n \"guid\": \"\",\n \"institution_number\": \"\",\n \"loan_guarantor\": \"\",\n \"loan_reference_number\": \"\",\n \"member_guid\": \"\",\n \"passed_validation\": \"\",\n \"routing_number\": \"\",\n \"sequence_number\": \"\",\n \"transit_number\": \"\",\n \"user_guid\": \"\"\n },\n {\n \"account_guid\": \"\",\n \"account_number\": \"\",\n \"guid\": \"\",\n \"institution_number\": \"\",\n \"loan_guarantor\": \"\",\n \"loan_reference_number\": \"\",\n \"member_guid\": \"\",\n \"passed_validation\": \"\",\n \"routing_number\": \"\",\n \"sequence_number\": \"\",\n \"transit_number\": \"\",\n \"user_guid\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-85f724b8-cd4e-4486-98f9-c498a5334b6f" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-773b13c9-fe3f-4411-8480-29fec8463c22" } ], "id": "febcffbf-3dfe-4c29-926d-70328870fcd3", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-febcffbf-3dfe-4c29-926d-70328870fcd3" } ], "id": "244544ab-8155-4467-8656-45b9dcf7776f", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-244544ab-8155-4467-8656-45b9dcf7776f" }, { "name": "List accounts", "id": "7a9234b9-6206-4e05-a6c4-26a3b00acef9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/accounts?page=&member_is_managed_by_user=&is_manual=&records_per_page=&use_case=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "accounts" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "page", "value": "" }, { "description": "List only accounts whose member is managed by the user.", "key": "member_is_managed_by_user", "value": "" }, { "description": "List only accounts that were manually created.", "key": "is_manual", "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.", "key": "records_per_page", "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`.", "key": "use_case", "value": "" } ], "variable": [ { "id": "69da3b3f-40aa-4384-9191-7a95967d21fa", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "description": "This endpoint returns a list of all the accounts associated with the specified `user`.\n\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" }, "response": [ { "id": "eedd111c-f200-47f8-a5da-e1bbc058b99a", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/accounts?page=&member_is_managed_by_user=&is_manual=&records_per_page=&use_case=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "accounts" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "page", "value": "" }, { "description": "List only accounts whose member is managed by the user.", "key": "member_is_managed_by_user", "value": "" }, { "description": "List only accounts that were manually created.", "key": "is_manual", "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.", "key": "records_per_page", "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`.", "key": "use_case", "value": "" } ], "variable": [ { "key": "user_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"accounts\": [\n {\n \"account_number\": \"\",\n \"account_ownership\": \"JOINT\",\n \"annuity_policy_to_date\": \"\",\n \"annuity_provider\": \"\",\n \"annuity_term_year\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"available_credit\": \"\",\n \"balance\": \"\",\n \"cash_balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"created_at\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"day_payment_is_due\": \"\",\n \"death_benefit\": \"\",\n \"federal_insurance_status\": \"UNKNOWN_INSURED\",\n \"guid\": \"\",\n \"id\": \"\",\n \"imported_at\": \"\",\n \"interest_rate\": \"\",\n \"institution_code\": \"\",\n \"insured_name\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"is_manual\": \"\",\n \"last_payment\": \"\",\n \"last_payment_at\": \"\",\n \"loan_amount\": \"\",\n \"margin_balance\": \"\",\n \"matures_on\": \"\",\n \"member_guid\": \"\",\n \"member_id\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"metadata\": \"\",\n \"minimum_balance\": \"\",\n \"minimum_payment\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"pay_out_amount\": \"\",\n \"payment_due_at\": \"\",\n \"payoff_balance\": \"\",\n \"premium_amount\": \"\",\n \"property_type\": \"REAL_ESTATE\",\n \"routing_number\": \"\",\n \"started_on\": \"\",\n \"statement_balance\": \"\",\n \"subtype\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_account_value\": \"\",\n \"total_account_value_ugl\": \"\",\n \"type\": \"LOAN\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n },\n {\n \"account_number\": \"\",\n \"account_ownership\": \"MULTIPLE\",\n \"annuity_policy_to_date\": \"\",\n \"annuity_provider\": \"\",\n \"annuity_term_year\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"available_credit\": \"\",\n \"balance\": \"\",\n \"cash_balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"created_at\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"day_payment_is_due\": \"\",\n \"death_benefit\": \"\",\n \"federal_insurance_status\": \"NOT_INSURED\",\n \"guid\": \"\",\n \"id\": \"\",\n \"imported_at\": \"\",\n \"interest_rate\": \"\",\n \"institution_code\": \"\",\n \"insured_name\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"is_manual\": \"\",\n \"last_payment\": \"\",\n \"last_payment_at\": \"\",\n \"loan_amount\": \"\",\n \"margin_balance\": \"\",\n \"matures_on\": \"\",\n \"member_guid\": \"\",\n \"member_id\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"metadata\": \"\",\n \"minimum_balance\": \"\",\n \"minimum_payment\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"pay_out_amount\": \"\",\n \"payment_due_at\": \"\",\n \"payoff_balance\": \"\",\n \"premium_amount\": \"\",\n \"property_type\": \"SPORTS_EQUIPMENT\",\n \"routing_number\": \"\",\n \"started_on\": \"\",\n \"statement_balance\": \"\",\n \"subtype\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_account_value\": \"\",\n \"total_account_value_ugl\": \"\",\n \"type\": \"INSURANCE\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-eedd111c-f200-47f8-a5da-e1bbc058b99a" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-7a9234b9-6206-4e05-a6c4-26a3b00acef9" }, { "name": "Create manual account", "id": "da8b4f3c-f4f1-4c9a-9702-26a36143bdb4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"name\": \"\",\n \"account_type\": \"CASH\",\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\": \"REAL_ESTATE\",\n \"skip_webhook\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/accounts", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "accounts" ], "variable": [ { "id": "8e3bb273-398f-46a4-b638-04bfb38503f4", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "description": "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\nYou must use the user `guid` when setting `user_identifier` in the path.\n\n" }, "response": [ { "id": "169226f3-e278-4116-b6b4-dd1f2f7e23fa", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"name\": \"\",\n \"account_type\": \"CASH\",\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\": \"REAL_ESTATE\",\n \"skip_webhook\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/accounts", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "accounts" ], "variable": [ { "key": "user_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"account\": {\n \"account_number\": \"\",\n \"account_ownership\": null,\n \"annuity_policy_to_date\": \"\",\n \"annuity_provider\": \"\",\n \"annuity_term_year\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"available_credit\": \"\",\n \"balance\": \"\",\n \"cash_balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"created_at\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"day_payment_is_due\": \"\",\n \"death_benefit\": \"\",\n \"federal_insurance_status\": \"NOT_INSURED\",\n \"guid\": \"\",\n \"id\": \"\",\n \"imported_at\": \"\",\n \"interest_rate\": \"\",\n \"institution_code\": \"\",\n \"insured_name\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"is_manual\": \"\",\n \"last_payment\": \"\",\n \"last_payment_at\": \"\",\n \"loan_amount\": \"\",\n \"margin_balance\": \"\",\n \"matures_on\": \"\",\n \"member_guid\": \"\",\n \"member_id\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"metadata\": \"\",\n \"minimum_balance\": \"\",\n \"minimum_payment\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"pay_out_amount\": \"\",\n \"payment_due_at\": \"\",\n \"payoff_balance\": \"\",\n \"premium_amount\": \"\",\n \"property_type\": \"FURNITURE\",\n \"routing_number\": \"\",\n \"started_on\": \"\",\n \"statement_balance\": \"\",\n \"subtype\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_account_value\": \"\",\n \"total_account_value_ugl\": \"\",\n \"type\": \"PROPERTY\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-169226f3-e278-4116-b6b4-dd1f2f7e23fa" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-da8b4f3c-f4f1-4c9a-9702-26a36143bdb4" } ], "id": "43ddeea9-2c89-42fa-968c-1b262a53c02a", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-43ddeea9-2c89-42fa-968c-1b262a53c02a" }, { "name": "members", "item": [ { "name": "{member_identifier}", "item": [ { "name": "accounts", "item": [ { "name": "{account_identifier}", "item": [ { "name": "transactions", "item": [ { "name": "{transaction_identifier}", "item": [ { "name": "split", "item": [ { "name": "Delete split transactions by account", "id": "0b7ffe9f-5fcf-4b40-b188-f87db13fc488", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/accounts/:account_identifier/transactions/:transaction_identifier/split", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions", ":transaction_identifier", "split" ], "variable": [ { "id": "fa57736b-a73c-4f43-8247-a7fc7a3b6445", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "2d4c9922-c0a0-43a4-8b1a-90afc979d920", "key": "member_identifier", "value": "", "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)." }, { "id": "99a9d815-ec21-48f5-bce5-31d1cf8b5454", "key": "account_identifier", "value": "", "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)." }, { "id": "1fcd2e49-861a-4b07-93ba-4ac9fe24f7d6", "key": "transaction_identifier", "value": "", "description": "(Required) Use either the transaction `id` you defined or the MX-defined transaction `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "description": "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." }, "response": [ { "id": "91c27b8c-2b4f-415e-bf30-a2a62813064f", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/accounts/:account_identifier/transactions/:transaction_identifier/split", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions", ":transaction_identifier", "split" ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" }, { "key": "account_identifier" }, { "key": "transaction_identifier" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-91c27b8c-2b4f-415e-bf30-a2a62813064f" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-0b7ffe9f-5fcf-4b40-b188-f87db13fc488" }, { "name": "Create split transactions by account", "id": "513be90f-e874-4bab-a9ec-4321a274e631", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transactions\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"category_guid\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/accounts/:account_identifier/transactions/:transaction_identifier/split", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions", ":transaction_identifier", "split" ], "variable": [ { "id": "cd0605dc-310f-486a-8708-82bbf7ff3f5e", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "66e0ee29-824a-4878-ad95-615497bdb5b1", "key": "member_identifier", "value": "", "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)." }, { "id": "5be8cf80-4d13-4015-b2ab-ce3840c9f01b", "key": "account_identifier", "value": "", "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)." }, { "id": "58538162-95a8-41f3-b88a-2f4bb2f48af8", "key": "transaction_identifier", "value": "", "description": "(Required) Use either the transaction `id` you defined or the MX-defined transaction `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "description": "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" }, "response": [ { "id": "6552c6e6-bee6-4f47-a75c-0978c7ebd649", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transactions\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"category_guid\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/accounts/:account_identifier/transactions/:transaction_identifier/split", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions", ":transaction_identifier", "split" ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" }, { "key": "account_identifier" }, { "key": "transaction_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n },\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6552c6e6-bee6-4f47-a75c-0978c7ebd649" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-513be90f-e874-4bab-a9ec-4321a274e631" } ], "id": "be79ab15-2c94-437b-a08a-b06d7f7047a9", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-be79ab15-2c94-437b-a08a-b06d7f7047a9" }, { "name": "Read transaction by account", "id": "fe7313ad-9c13-47e0-a928-b7ce5ee8be05", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/accounts/:account_identifier/transactions/:transaction_identifier?includes=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions", ":transaction_identifier" ], "query": [ { "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", "key": "includes", "value": "" } ], "variable": [ { "id": "df07f222-ed5a-4c82-8021-cf4051b5855a", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "d8e42a45-fc53-4bfe-962a-61bccff082ee", "key": "member_identifier", "value": "", "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)." }, { "id": "9503a61c-bc6f-47b6-ac05-fb32169da424", "key": "account_identifier", "value": "", "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)." }, { "id": "63c3f65e-be19-427f-b12f-3adf6a0af17b", "key": "transaction_identifier", "value": "", "description": "(Required) Use either the transaction `id` you defined or the MX-defined transaction `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "description": "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)." }, "response": [ { "id": "e91f6822-b875-4168-ab51-7e83d2ee746e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/accounts/:account_identifier/transactions/:transaction_identifier?includes=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions", ":transaction_identifier" ], "query": [ { "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", "key": "includes", "value": "" } ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" }, { "key": "account_identifier" }, { "key": "transaction_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"PENDING\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\",\n \"classification\": {\n \"parent_class\": \"Expenses\",\n \"guid\": \"\"\n },\n \"geolocation\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"postal code\": \"\"\n },\n \"merchant\": {\n \"name\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"website_url\": \"\"\n },\n \"repeating_transaction\": {\n \"repeating_transaction_type\": \"UNKNOWN\",\n \"recurrence_type\": \"EVERY_OTHER_WEEK\",\n \"guid\": \"\"\n }\n },\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\",\n \"classification\": {\n \"parent_class\": \"Refunds\",\n \"guid\": \"\"\n },\n \"geolocation\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"postal code\": \"\"\n },\n \"merchant\": {\n \"name\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"website_url\": \"\"\n },\n \"repeating_transaction\": {\n \"repeating_transaction_type\": \"UNKNOWN\",\n \"recurrence_type\": \"EVERY_OTHER_WEEK\",\n \"guid\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e91f6822-b875-4168-ab51-7e83d2ee746e" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-fe7313ad-9c13-47e0-a928-b7ce5ee8be05" }, { "name": "Update transaction by account", "id": "94078c45-3408-4382-a590-030f39ac942a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/accounts/:account_identifier/transactions/:transaction_identifier", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions", ":transaction_identifier" ], "variable": [ { "id": "cfc4a624-d66f-4816-964d-c4d2f6e7278a", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "6da22510-8d59-4fe7-9dd7-0dd99113eee9", "key": "member_identifier", "value": "", "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)." }, { "id": "55f8cbfa-76ac-4ffa-a1b1-1ee3d018914e", "key": "account_identifier", "value": "", "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)." }, { "id": "aec3b88c-f3ff-4fdc-a450-bce076a553f3", "key": "transaction_identifier", "value": "", "description": "(Required) Use either the transaction `id` you defined or the MX-defined transaction `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "description": "Use this endpoint to update the `description` of a specific transaction according to its unique GUID." }, "response": [ { "id": "60de4eaf-bd08-412f-8333-a06c57f84df5", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/accounts/:account_identifier/transactions/:transaction_identifier", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions", ":transaction_identifier" ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" }, { "key": "account_identifier" }, { "key": "transaction_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"PENDING\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"DEBIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-60de4eaf-bd08-412f-8333-a06c57f84df5" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-94078c45-3408-4382-a590-030f39ac942a" } ], "id": "4de16f8a-1604-4e92-8613-33aeb89dead3", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-4de16f8a-1604-4e92-8613-33aeb89dead3" }, { "name": "List transactions by account per member", "id": "819b31be-84a3-43fb-8d4a-1ce13aed506b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/accounts/:account_identifier/transactions?page=&records_per_page=&from_date=&to_date=&from_created_at=&to_created_at=&from_updated_at=&to_updated_at=&includes=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" }, { "description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided.", "key": "from_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.", "key": "to_date", "value": "" }, { "description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format.", "key": "from_created_at", "value": "" }, { "description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format.", "key": "to_created_at", "value": "" }, { "description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format.", "key": "from_updated_at", "value": "" }, { "description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format.", "key": "to_updated_at", "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", "key": "includes", "value": "" } ], "variable": [ { "id": "38e1c66f-95ba-4e60-b45d-afc3e99d6a54", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "0fdc321d-322e-4937-b8d7-3991dc8a7567", "key": "member_identifier", "value": "", "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)." }, { "id": "0ff9efca-36da-4e46-8a37-4e1a1d81ce1f", "key": "account_identifier", "value": "", "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)." } ] }, "description": "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)." }, "response": [ { "id": "412fde6f-54de-4429-a722-e9d6a3fbb3c7", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/accounts/:account_identifier/transactions?page=&records_per_page=&from_date=&to_date=&from_created_at=&to_created_at=&from_updated_at=&to_updated_at=&includes=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier", "transactions" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" }, { "description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided.", "key": "from_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.", "key": "to_date", "value": "" }, { "description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format.", "key": "from_created_at", "value": "" }, { "description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format.", "key": "to_created_at", "value": "" }, { "description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format.", "key": "from_updated_at", "value": "" }, { "description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format.", "key": "to_updated_at", "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", "key": "includes", "value": "" } ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" }, { "key": "account_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"PENDING\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\",\n \"classification\": {\n \"parent_class\": \"Expenses\",\n \"guid\": \"\"\n },\n \"geolocation\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"postal code\": \"\"\n },\n \"merchant\": {\n \"name\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"website_url\": \"\"\n },\n \"repeating_transaction\": {\n \"repeating_transaction_type\": \"UNKNOWN\",\n \"recurrence_type\": \"EVERY_OTHER_WEEK\",\n \"guid\": \"\"\n }\n },\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\",\n \"classification\": {\n \"parent_class\": \"Refunds\",\n \"guid\": \"\"\n },\n \"geolocation\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"postal code\": \"\"\n },\n \"merchant\": {\n \"name\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"website_url\": \"\"\n },\n \"repeating_transaction\": {\n \"repeating_transaction_type\": \"UNKNOWN\",\n \"recurrence_type\": \"EVERY_OTHER_WEEK\",\n \"guid\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-412fde6f-54de-4429-a722-e9d6a3fbb3c7" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-819b31be-84a3-43fb-8d4a-1ce13aed506b" } ], "id": "8a723f0b-422d-4579-a792-305cdccb517f", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-8a723f0b-422d-4579-a792-305cdccb517f" }, { "name": "Read member account", "id": "265e2d39-e2e6-452e-9ae3-c707c4310614", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/accounts/:account_identifier", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier" ], "variable": [ { "id": "f9913517-94f6-4269-8b46-d1dd9ad16926", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "9ec1962a-807d-455a-a18d-2ea42e48d283", "key": "member_identifier", "value": "", "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)." }, { "id": "7ab9198e-51d8-4de7-b027-b82ae0441fc1", "key": "account_identifier", "value": "", "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)." } ] }, "description": "This endpoint allows you to read the attributes of an `account` resource." }, "response": [ { "id": "49a1eb1a-ff5d-41f9-b6dc-df6e84005bb6", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/accounts/:account_identifier", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier" ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" }, { "key": "account_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"account\": {\n \"account_number\": \"\",\n \"account_ownership\": null,\n \"annuity_policy_to_date\": \"\",\n \"annuity_provider\": \"\",\n \"annuity_term_year\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"available_credit\": \"\",\n \"balance\": \"\",\n \"cash_balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"created_at\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"day_payment_is_due\": \"\",\n \"death_benefit\": \"\",\n \"federal_insurance_status\": \"NOT_INSURED\",\n \"guid\": \"\",\n \"id\": \"\",\n \"imported_at\": \"\",\n \"interest_rate\": \"\",\n \"institution_code\": \"\",\n \"insured_name\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"is_manual\": \"\",\n \"last_payment\": \"\",\n \"last_payment_at\": \"\",\n \"loan_amount\": \"\",\n \"margin_balance\": \"\",\n \"matures_on\": \"\",\n \"member_guid\": \"\",\n \"member_id\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"metadata\": \"\",\n \"minimum_balance\": \"\",\n \"minimum_payment\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"pay_out_amount\": \"\",\n \"payment_due_at\": \"\",\n \"payoff_balance\": \"\",\n \"premium_amount\": \"\",\n \"property_type\": \"FURNITURE\",\n \"routing_number\": \"\",\n \"started_on\": \"\",\n \"statement_balance\": \"\",\n \"subtype\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_account_value\": \"\",\n \"total_account_value_ugl\": \"\",\n \"type\": \"PROPERTY\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-49a1eb1a-ff5d-41f9-b6dc-df6e84005bb6" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-265e2d39-e2e6-452e-9ae3-c707c4310614" }, { "name": "Update account by member", "id": "087c5d65-f8ab-4570-9051-457283262c5d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"account_subtype\": \"\",\n \"account_type\": \"INVESTMENT\",\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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/accounts/:account_identifier", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier" ], "variable": [ { "id": "20805668-192d-4936-aa9d-bd5a64dc5d31", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "5c1f98a3-c00b-4116-98e8-1fa84f22948e", "key": "member_identifier", "value": "", "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)." }, { "id": "31055067-bb6a-45a7-bcda-56cd6d9d3853", "key": "account_identifier", "value": "", "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)." } ] }, "description": "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`." }, "response": [ { "id": "71f5d777-f072-4997-a532-f02d740d2cfc", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"account_subtype\": \"\",\n \"account_type\": \"INVESTMENT\",\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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/accounts/:account_identifier", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts", ":account_identifier" ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" }, { "key": "account_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"account\": {\n \"account_number\": \"\",\n \"account_ownership\": null,\n \"annuity_policy_to_date\": \"\",\n \"annuity_provider\": \"\",\n \"annuity_term_year\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"available_credit\": \"\",\n \"balance\": \"\",\n \"cash_balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"created_at\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"day_payment_is_due\": \"\",\n \"death_benefit\": \"\",\n \"federal_insurance_status\": \"NOT_INSURED\",\n \"guid\": \"\",\n \"id\": \"\",\n \"imported_at\": \"\",\n \"interest_rate\": \"\",\n \"institution_code\": \"\",\n \"insured_name\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"is_manual\": \"\",\n \"last_payment\": \"\",\n \"last_payment_at\": \"\",\n \"loan_amount\": \"\",\n \"margin_balance\": \"\",\n \"matures_on\": \"\",\n \"member_guid\": \"\",\n \"member_id\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"metadata\": \"\",\n \"minimum_balance\": \"\",\n \"minimum_payment\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"pay_out_amount\": \"\",\n \"payment_due_at\": \"\",\n \"payoff_balance\": \"\",\n \"premium_amount\": \"\",\n \"property_type\": \"FURNITURE\",\n \"routing_number\": \"\",\n \"started_on\": \"\",\n \"statement_balance\": \"\",\n \"subtype\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_account_value\": \"\",\n \"total_account_value_ugl\": \"\",\n \"type\": \"PROPERTY\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-71f5d777-f072-4997-a532-f02d740d2cfc" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-087c5d65-f8ab-4570-9051-457283262c5d" } ], "id": "875d5e1f-1260-4003-addf-38eb17b32d43", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-875d5e1f-1260-4003-addf-38eb17b32d43" }, { "name": "List member accounts", "id": "753faf84-ddb1-451c-bc37-44babdd3225b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/accounts?member_is_managed_by_user=&page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts" ], "query": [ { "description": "List only accounts whose member is managed by the user.", "key": "member_is_managed_by_user", "value": "" }, { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "127fafce-8af3-4a01-af01-6891c513da5f", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "5c45cf97-d9f3-4cc6-b3a9-4379f3e1206b", "key": "member_identifier", "value": "", "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)." } ] }, "description": "This endpoint returns a list of all the accounts associated with the specified `member`." }, "response": [ { "id": "5626e1cf-45b9-4550-900f-bb39705c4492", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/accounts?member_is_managed_by_user=&page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "accounts" ], "query": [ { "description": "List only accounts whose member is managed by the user.", "key": "member_is_managed_by_user", "value": "" }, { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"accounts\": [\n {\n \"account_number\": \"\",\n \"account_ownership\": \"JOINT\",\n \"annuity_policy_to_date\": \"\",\n \"annuity_provider\": \"\",\n \"annuity_term_year\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"available_credit\": \"\",\n \"balance\": \"\",\n \"cash_balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"created_at\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"day_payment_is_due\": \"\",\n \"death_benefit\": \"\",\n \"federal_insurance_status\": \"UNKNOWN_INSURED\",\n \"guid\": \"\",\n \"id\": \"\",\n \"imported_at\": \"\",\n \"interest_rate\": \"\",\n \"institution_code\": \"\",\n \"insured_name\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"is_manual\": \"\",\n \"last_payment\": \"\",\n \"last_payment_at\": \"\",\n \"loan_amount\": \"\",\n \"margin_balance\": \"\",\n \"matures_on\": \"\",\n \"member_guid\": \"\",\n \"member_id\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"metadata\": \"\",\n \"minimum_balance\": \"\",\n \"minimum_payment\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"pay_out_amount\": \"\",\n \"payment_due_at\": \"\",\n \"payoff_balance\": \"\",\n \"premium_amount\": \"\",\n \"property_type\": \"REAL_ESTATE\",\n \"routing_number\": \"\",\n \"started_on\": \"\",\n \"statement_balance\": \"\",\n \"subtype\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_account_value\": \"\",\n \"total_account_value_ugl\": \"\",\n \"type\": \"LOAN\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n },\n {\n \"account_number\": \"\",\n \"account_ownership\": \"MULTIPLE\",\n \"annuity_policy_to_date\": \"\",\n \"annuity_provider\": \"\",\n \"annuity_term_year\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"available_credit\": \"\",\n \"balance\": \"\",\n \"cash_balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"created_at\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"day_payment_is_due\": \"\",\n \"death_benefit\": \"\",\n \"federal_insurance_status\": \"NOT_INSURED\",\n \"guid\": \"\",\n \"id\": \"\",\n \"imported_at\": \"\",\n \"interest_rate\": \"\",\n \"institution_code\": \"\",\n \"insured_name\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"is_manual\": \"\",\n \"last_payment\": \"\",\n \"last_payment_at\": \"\",\n \"loan_amount\": \"\",\n \"margin_balance\": \"\",\n \"matures_on\": \"\",\n \"member_guid\": \"\",\n \"member_id\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"metadata\": \"\",\n \"minimum_balance\": \"\",\n \"minimum_payment\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"pay_out_amount\": \"\",\n \"payment_due_at\": \"\",\n \"payoff_balance\": \"\",\n \"premium_amount\": \"\",\n \"property_type\": \"SPORTS_EQUIPMENT\",\n \"routing_number\": \"\",\n \"started_on\": \"\",\n \"statement_balance\": \"\",\n \"subtype\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_account_value\": \"\",\n \"total_account_value_ugl\": \"\",\n \"type\": \"INSURANCE\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-5626e1cf-45b9-4550-900f-bb39705c4492" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-753faf84-ddb1-451c-bc37-44babdd3225b" } ], "id": "d6258897-95c1-4224-b694-48ad7a8bbccd", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d6258897-95c1-4224-b694-48ad7a8bbccd" }, { "name": "account_owners", "item": [ { "name": "List account owners by member", "id": "672c611c-4b24-4b9c-a278-d10fa0180273", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/account_owners?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "account_owners" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "3921e18c-2ab7-4adb-9af9-a83accf567e3", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "87161ced-996f-41ab-adb8-9f3502a60c6c", "key": "member_identifier", "value": "", "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)." } ] }, "description": "This endpoint returns an array with information about every account associated with a particular member." }, "response": [ { "id": "6ae57545-055c-4d79-8bbe-be4e5fe0ad57", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/account_owners?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "account_owners" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"account_owners\": [\n {\n \"account_guid\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"guid\": \"\",\n \"last_name\": \"\",\n \"member_guid\": \"\",\n \"owner_name\": \"\",\n \"phone\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\",\n \"user_guid\": \"\"\n },\n {\n \"account_guid\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"guid\": \"\",\n \"last_name\": \"\",\n \"member_guid\": \"\",\n \"owner_name\": \"\",\n \"phone\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\",\n \"user_guid\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6ae57545-055c-4d79-8bbe-be4e5fe0ad57" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-672c611c-4b24-4b9c-a278-d10fa0180273" } ], "id": "1172604a-c971-48f6-a74b-12311b59137e", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-1172604a-c971-48f6-a74b-12311b59137e" }, { "name": "aggregate", "item": [ { "name": "Aggregate member", "id": "8fd8b85b-b9a6-49ed-9020-7782d60ae862", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "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" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/aggregate", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "aggregate" ], "variable": [ { "id": "af1573f7-af77-44f8-bc71-35235090fe45", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "48c60c90-4022-45cc-acb6-8866d776b3eb", "key": "member_identifier", "value": "", "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)." } ] }, "description": "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." }, "response": [ { "id": "11d710bc-388c-4b99-86d8-417e56a90c72", "name": "Accepted", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "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" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/aggregate", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "aggregate" ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"PREVENTED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-11d710bc-388c-4b99-86d8-417e56a90c72" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-8fd8b85b-b9a6-49ed-9020-7782d60ae862" } ], "id": "7885ffc3-1187-4419-a654-9af1f8d5467e", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-7885ffc3-1187-4419-a654-9af1f8d5467e" }, { "name": "challenges", "item": [ { "name": "List member challenges", "id": "109ec0be-638e-4a70-b21a-c98850c5cc36", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/challenges?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "challenges" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "4a60f3da-6c23-4dbb-ab64-f51fefeac707", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "0f3282cd-1167-46a1-b143-5d3942c06fc6", "key": "member_identifier", "value": "", "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)." } ] }, "description": "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." }, "response": [ { "id": "44c55878-47f0-4524-a9d9-f3b7d28965eb", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/challenges?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "challenges" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"challenges\": [\n {\n \"field_name\": \"\",\n \"guid\": \"\",\n \"image_data\": \"\",\n \"image_options\": [\n {\n \"data_uri\": \"\",\n \"guid\": \"\",\n \"label\": \"\",\n \"value\": \"\"\n },\n {\n \"data_uri\": \"\",\n \"guid\": \"\",\n \"label\": \"\",\n \"value\": \"\"\n }\n ],\n \"label\": \"\",\n \"options\": [\n {\n \"guid\": \"\",\n \"label\": \"\",\n \"value\": \"\"\n },\n {\n \"guid\": \"\",\n \"label\": \"\",\n \"value\": \"\"\n }\n ],\n \"type\": \"\"\n },\n {\n \"field_name\": \"\",\n \"guid\": \"\",\n \"image_data\": \"\",\n \"image_options\": [\n {\n \"data_uri\": \"\",\n \"guid\": \"\",\n \"label\": \"\",\n \"value\": \"\"\n },\n {\n \"data_uri\": \"\",\n \"guid\": \"\",\n \"label\": \"\",\n \"value\": \"\"\n }\n ],\n \"label\": \"\",\n \"options\": [\n {\n \"guid\": \"\",\n \"label\": \"\",\n \"value\": \"\"\n },\n {\n \"guid\": \"\",\n \"label\": \"\",\n \"value\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-44c55878-47f0-4524-a9d9-f3b7d28965eb" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-109ec0be-638e-4a70-b21a-c98850c5cc36" } ], "id": "7fff3d9d-8d63-439d-8581-80985ed96494", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-7fff3d9d-8d63-439d-8581-80985ed96494" }, { "name": "check_balance", "item": [ { "name": "Check balances", "id": "345a5534-1bf0-4f6f-9a41-3bbb48e0a171", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/check_balance", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "check_balance" ], "variable": [ { "id": "495cae14-c06b-4290-a9f6-ae5a0e11207d", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "f84fc77e-e836-467b-a75b-f38a6ef73366", "key": "member_identifier", "value": "", "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)." } ] }, "description": "This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data." }, "response": [ { "id": "16d3971b-b4ce-4286-8331-4a6c15ab7cd4", "name": "Accepted", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/check_balance", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "check_balance" ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"PREVENTED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-16d3971b-b4ce-4286-8331-4a6c15ab7cd4" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-345a5534-1bf0-4f6f-9a41-3bbb48e0a171" } ], "id": "55667fce-39f6-46ba-ba05-ae241882d40f", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-55667fce-39f6-46ba-ba05-ae241882d40f" }, { "name": "credentials", "item": [ { "name": "List member credentials", "id": "e42d21c5-d740-498d-9c6c-b118ee5e58fc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/credentials?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "credentials" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "e5c1c9b6-45bf-4c11-bca1-ff21ea291d31", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "9a347c58-91d5-49e8-86a7-b6005747b9a3", "key": "member_identifier", "value": "", "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)." } ] }, "description": "This endpoint returns an array which contains information on every non-MFA credential associated with a specific member." }, "response": [ { "id": "8791b219-f7ad-4882-80ba-e7328a263c13", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/credentials?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "credentials" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"credentials\": [\n {\n \"display_order\": \"\",\n \"field_name\": \"\",\n \"field_type\": \"\",\n \"guid\": \"\",\n \"label\": \"\",\n \"type\": \"\"\n },\n {\n \"display_order\": \"\",\n \"field_name\": \"\",\n \"field_type\": \"\",\n \"guid\": \"\",\n \"label\": \"\",\n \"type\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-8791b219-f7ad-4882-80ba-e7328a263c13" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e42d21c5-d740-498d-9c6c-b118ee5e58fc" } ], "id": "40274d57-3d84-476b-af30-b1cb38a6ea0f", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-40274d57-3d84-476b-af30-b1cb38a6ea0f" }, { "name": "extend_history", "item": [ { "name": "Extend history", "id": "3ec7663d-87d8-436d-897e-9031c8b8684b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/extend_history", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "extend_history" ], "variable": [ { "id": "3921d08e-d1e6-4d4f-8809-a028e8ce92ae", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "ea058cb7-0161-41e9-8731-0b0ead2f0f0f", "key": "member_identifier", "value": "", "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)." } ] }, "description": "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." }, "response": [ { "id": "c5b9d222-c25e-445b-a206-ac490620c7c4", "name": "Accepted", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/extend_history", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "extend_history" ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"PREVENTED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-c5b9d222-c25e-445b-a206-ac490620c7c4" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-3ec7663d-87d8-436d-897e-9031c8b8684b" } ], "id": "b0ddc14b-3d51-4658-b427-cee5dad4f109", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b0ddc14b-3d51-4658-b427-cee5dad4f109" }, { "name": "fetch_statements", "item": [ { "name": "Fetch statements", "id": "7bfee22c-b4a6-49c6-bc99-3a865ddf7acb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/fetch_statements", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "fetch_statements" ], "variable": [ { "id": "1c0db9a0-b3bf-47a2-8c8e-4d95274506ce", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "b1454962-2dee-4859-942d-df9ad09d2220", "key": "member_identifier", "value": "", "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)." } ] }, "description": "Use this endpoint to fetch the statements associated with a particular member." }, "response": [ { "id": "41a31fee-7e62-470c-853a-9715f60e9bfd", "name": "Accepted", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/fetch_statements", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "fetch_statements" ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"PREVENTED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-41a31fee-7e62-470c-853a-9715f60e9bfd" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-7bfee22c-b4a6-49c6-bc99-3a865ddf7acb" } ], "id": "6d55dbb6-da7f-478c-9ae5-7096e1a0f151", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6d55dbb6-da7f-478c-9ae5-7096e1a0f151" }, { "name": "identify", "item": [ { "name": "Identify member", "id": "8f6e713d-c0bb-4fa7-a582-6987cfb6c87e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/identify", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "identify" ], "variable": [ { "id": "fe6aa788-ec0e-4a28-9817-24345f03c2cb", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "ab399a3e-8256-4f29-9266-dfaeba477d6f", "key": "member_identifier", "value": "", "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)." } ] }, "description": "The identify endpoint begins an identification process for an already-existing member." }, "response": [ { "id": "4dbbed2a-7cd9-4af9-8d6e-df009112f71a", "name": "Accepted", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/identify", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "identify" ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"PREVENTED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-4dbbed2a-7cd9-4af9-8d6e-df009112f71a" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-8f6e713d-c0bb-4fa7-a582-6987cfb6c87e" } ], "id": "6a60b69b-289e-43d8-b2cc-fb364c75b55e", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6a60b69b-289e-43d8-b2cc-fb364c75b55e" }, { "name": "oauth_window_uri", "item": [ { "name": "Request oauth window uri", "id": "bf556d5c-1e06-4315-83d2-8ac82a49df86", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/oauth_window_uri?client_redirect_url=&enable_app2app=&referral_source=&skip_aggregation=&ui_message_webview_url_scheme=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "oauth_window_uri" ], "query": [ { "description": "A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with `referral_source=APP`.", "key": "client_redirect_url", "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.", "key": "enable_app2app", "value": "" }, { "description": "Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`.", "key": "referral_source", "value": "" }, { "description": "Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page.", "key": "skip_aggregation", "value": "" }, { "description": "A scheme for routing the user back to the application state they were previously in. Only available with `referral_source=APP`.", "key": "ui_message_webview_url_scheme", "value": "" } ], "variable": [ { "id": "357d747d-1baa-48f3-be59-f2c2894943f9", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "62835a1a-fbaf-4ae3-b241-19ec496c2040", "key": "member_identifier", "value": "", "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)." } ] }, "description": "This endpoint will generate an `oauth_window_uri` for the specified `member`." }, "response": [ { "id": "87ed34c1-1af4-4c30-a7c2-e03632d5f081", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/oauth_window_uri?client_redirect_url=&enable_app2app=&referral_source=&skip_aggregation=&ui_message_webview_url_scheme=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "oauth_window_uri" ], "query": [ { "description": "A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with `referral_source=APP`.", "key": "client_redirect_url", "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.", "key": "enable_app2app", "value": "" }, { "description": "Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`.", "key": "referral_source", "value": "" }, { "description": "Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page.", "key": "skip_aggregation", "value": "" }, { "description": "A scheme for routing the user back to the application state they were previously in. Only available with `referral_source=APP`.", "key": "ui_message_webview_url_scheme", "value": "" } ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"guid\": \"\",\n \"oauth_window_uri\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-87ed34c1-1af4-4c30-a7c2-e03632d5f081" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-bf556d5c-1e06-4315-83d2-8ac82a49df86" } ], "id": "38edd257-b731-41db-bea0-7ef0385c1194", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-38edd257-b731-41db-bea0-7ef0385c1194" }, { "name": "resume", "item": [ { "name": "Resume aggregation", "id": "877ce3f4-0bd0-489d-9052-4d3183f9b554", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"member\": {\n \"challenges\": [\n {\n \"guid\": \"\",\n \"value\": \"\"\n },\n {\n \"guid\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/resume", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "resume" ], "variable": [ { "id": "468f0aa3-0b18-4b0f-9da8-679b3b998de5", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "41caeb3a-f949-40cd-b6c0-2c087056c86a", "key": "member_identifier", "value": "", "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)." } ] }, "description": "This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication." }, "response": [ { "id": "c9465291-68f7-47c0-98f6-cd28b8b37227", "name": "Accepted", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"member\": {\n \"challenges\": [\n {\n \"guid\": \"\",\n \"value\": \"\"\n },\n {\n \"guid\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/resume", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "resume" ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"PREVENTED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-c9465291-68f7-47c0-98f6-cd28b8b37227" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-877ce3f4-0bd0-489d-9052-4d3183f9b554" } ], "id": "f9a97ffd-8f72-4b66-a9a5-06a0a236b732", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-f9a97ffd-8f72-4b66-a9a5-06a0a236b732" }, { "name": "status", "item": [ { "name": "Read member status", "id": "6a0ee630-b9e6-4bd9-89f3-8d1050c8cbfe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/status", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "status" ], "variable": [ { "id": "11148140-53cb-4aee-97a9-f726ad46cc17", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "a27e6c85-2eb0-4ec4-ac33-6308432e6893", "key": "member_identifier", "value": "", "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)." } ] }, "description": "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." }, "response": [ { "id": "a39e9e2d-2d37-4f41-8405-f662f74c8861", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/status", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "status" ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"aggregated_at\": \"\",\n \"challenges\": [\n {\n \"field_name\": \"\",\n \"guid\": \"\",\n \"image_data\": \"\",\n \"image_options\": [\n {\n \"data_uri\": \"\",\n \"guid\": \"\",\n \"label\": \"\",\n \"value\": \"\"\n },\n {\n \"data_uri\": \"\",\n \"guid\": \"\",\n \"label\": \"\",\n \"value\": \"\"\n }\n ],\n \"label\": \"\",\n \"options\": [\n {\n \"guid\": \"\",\n \"label\": \"\",\n \"value\": \"\"\n },\n {\n \"guid\": \"\",\n \"label\": \"\",\n \"value\": \"\"\n }\n ],\n \"type\": \"\"\n },\n {\n \"field_name\": \"\",\n \"guid\": \"\",\n \"image_data\": \"\",\n \"image_options\": [\n {\n \"data_uri\": \"\",\n \"guid\": \"\",\n \"label\": \"\",\n \"value\": \"\"\n },\n {\n \"data_uri\": \"\",\n \"guid\": \"\",\n \"label\": \"\",\n \"value\": \"\"\n }\n ],\n \"label\": \"\",\n \"options\": [\n {\n \"guid\": \"\",\n \"label\": \"\",\n \"value\": \"\"\n },\n {\n \"guid\": \"\",\n \"label\": \"\",\n \"value\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"connection_status\": \"IMPAIRED\",\n \"guid\": \"\",\n \"has_processed_account_numbers\": \"\",\n \"has_processed_accounts\": \"\",\n \"has_processed_transactions\": \"\",\n \"is_authenticated\": \"\",\n \"is_being_aggregated\": \"\",\n \"successfully_aggregated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-a39e9e2d-2d37-4f41-8405-f662f74c8861" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6a0ee630-b9e6-4bd9-89f3-8d1050c8cbfe" } ], "id": "f8bcb863-c68d-44ad-9e0a-5017b8489570", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-f8bcb863-c68d-44ad-9e0a-5017b8489570" }, { "name": "transactions", "item": [ { "name": "List transactions by member", "id": "492e0836-d49e-4dbd-8244-9b04f7f1492a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/transactions?page=&records_per_page=&from_date=&to_date=&from_created_at=&to_created_at=&from_timestamp=&to_timestamp=&from_updated_at=&to_updated_at=&includes=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "transactions" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" }, { "description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided.", "key": "from_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.", "key": "to_date", "value": "" }, { "description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format.", "key": "from_created_at", "value": "" }, { "description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format.", "key": "to_created_at", "value": "" }, { "description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format.", "key": "from_timestamp", "value": "" }, { "description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format.", "key": "to_timestamp", "value": "" }, { "description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format.", "key": "from_updated_at", "value": "" }, { "description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format.", "key": "to_updated_at", "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", "key": "includes", "value": "" } ], "variable": [ { "id": "59296680-c39e-40dd-8615-032070347682", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "79b162a2-1828-4f84-a66a-5273c7e47b56", "key": "member_identifier", "value": "", "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)." } ] }, "description": "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)." }, "response": [ { "id": "1cf2cde0-b79d-49b1-be7c-a71b933a5b32", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/transactions?page=&records_per_page=&from_date=&to_date=&from_created_at=&to_created_at=&from_timestamp=&to_timestamp=&from_updated_at=&to_updated_at=&includes=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "transactions" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" }, { "description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided.", "key": "from_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.", "key": "to_date", "value": "" }, { "description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format.", "key": "from_created_at", "value": "" }, { "description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format.", "key": "to_created_at", "value": "" }, { "description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format.", "key": "from_timestamp", "value": "" }, { "description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format.", "key": "to_timestamp", "value": "" }, { "description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format.", "key": "from_updated_at", "value": "" }, { "description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format.", "key": "to_updated_at", "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", "key": "includes", "value": "" } ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"PENDING\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\",\n \"classification\": {\n \"parent_class\": \"Expenses\",\n \"guid\": \"\"\n },\n \"geolocation\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"postal code\": \"\"\n },\n \"merchant\": {\n \"name\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"website_url\": \"\"\n },\n \"repeating_transaction\": {\n \"repeating_transaction_type\": \"UNKNOWN\",\n \"recurrence_type\": \"EVERY_OTHER_WEEK\",\n \"guid\": \"\"\n }\n },\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\",\n \"classification\": {\n \"parent_class\": \"Refunds\",\n \"guid\": \"\"\n },\n \"geolocation\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"postal code\": \"\"\n },\n \"merchant\": {\n \"name\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"website_url\": \"\"\n },\n \"repeating_transaction\": {\n \"repeating_transaction_type\": \"UNKNOWN\",\n \"recurrence_type\": \"EVERY_OTHER_WEEK\",\n \"guid\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-1cf2cde0-b79d-49b1-be7c-a71b933a5b32" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-492e0836-d49e-4dbd-8244-9b04f7f1492a" } ], "id": "75aac585-055b-4790-8b2e-291e79f25783", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-75aac585-055b-4790-8b2e-291e79f25783" }, { "name": "verify", "item": [ { "name": "Verify member", "id": "0b1cb0c0-db5f-4b98-a240-59ad40d5f22e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "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" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/verify", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "verify" ], "variable": [ { "id": "e6d24d5c-2c25-4a03-a5be-eb9eadab67c6", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "4de16ec8-30b2-4666-9362-1f447bbbed96", "key": "member_identifier", "value": "", "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)." } ] }, "description": "The verify endpoint begins a verification process for a member." }, "response": [ { "id": "fbdaa871-ad87-462a-b803-321b8f699018", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "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" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/verify", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "verify" ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"PREVENTED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-fbdaa871-ad87-462a-b803-321b8f699018" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-0b1cb0c0-db5f-4b98-a240-59ad40d5f22e" } ], "id": "d7a728af-d585-421c-8540-acc6314cb93c", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d7a728af-d585-421c-8540-acc6314cb93c" }, { "name": "fetch_rewards", "item": [ { "name": "Fetch Rewards", "id": "8b5a490f-67e5-4d3f-9a80-77cae2deb0dc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/fetch_rewards", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "fetch_rewards" ], "variable": [ { "id": "e5c65ea0-91a6-46d7-83ab-59e306f610f1", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "7938d307-8ea0-4872-9c3e-c796a503bcb0", "key": "member_identifier", "value": "", "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)." } ] }, "description": "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." }, "response": [ { "id": "1960d646-e5e6-4997-a95e-d07266623f54", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier/fetch_rewards", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier", "fetch_rewards" ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"PREVENTED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-1960d646-e5e6-4997-a95e-d07266623f54" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-8b5a490f-67e5-4d3f-9a80-77cae2deb0dc" } ], "id": "0174af6f-2ef8-4c7a-9e26-f2cdc8497b6a", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-0174af6f-2ef8-4c7a-9e26-f2cdc8497b6a" }, { "name": "Delete member", "id": "28ceed54-1dc1-45e6-af98-8c26c5b682ab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier" ], "variable": [ { "id": "6248803f-3500-434d-ab4e-649d3efebd27", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "e534c2cd-9b7e-4ff8-af99-2f813956f525", "key": "member_identifier", "value": "", "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)." } ] }, "description": "Accessing this endpoint will permanently delete a member." }, "response": [ { "id": "2a62981a-31dc-44ac-9b4d-dacafaebe294", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier" ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-2a62981a-31dc-44ac-9b4d-dacafaebe294" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-28ceed54-1dc1-45e6-af98-8c26c5b682ab" }, { "name": "Read member", "id": "c518c0e8-1bc1-4e30-a22d-b3d23dcbe6fd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier" ], "variable": [ { "id": "dbf3cc39-1123-4882-9ae7-da6926a99409", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "2ac28f60-eff4-483a-bd4c-cb8f88535544", "key": "member_identifier", "value": "", "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)." } ] }, "description": "Use this endpoint to read the attributes of a specific member." }, "response": [ { "id": "432757eb-9291-4d20-973a-045bd0cb6127", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier" ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"PREVENTED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-432757eb-9291-4d20-973a-045bd0cb6127" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-c518c0e8-1bc1-4e30-a22d-b3d23dcbe6fd" }, { "name": "Update member", "id": "3011710c-c092-46c9-a536-5144d2934752", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "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" } ], "body": { "mode": "raw", "raw": "{\n \"member\": {\n \"background_aggregation_is_disabled\": \"\",\n \"credentials\": [\n {\n \"guid\": \"\",\n \"value\": \"\"\n },\n {\n \"guid\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\",\n \"metadata\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"MONEY_MOVEMENT\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier" ], "variable": [ { "id": "c2a6fd49-f102-4140-bc3d-f81c6c230c8b", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "b29a8502-eb16-4c83-8e97-6c6d1afde250", "key": "member_identifier", "value": "", "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)." } ] }, "description": "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." }, "response": [ { "id": "4f685eec-16ad-4c17-b3ae-10cab0ccd498", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "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" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"member\": {\n \"background_aggregation_is_disabled\": \"\",\n \"credentials\": [\n {\n \"guid\": \"\",\n \"value\": \"\"\n },\n {\n \"guid\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\",\n \"metadata\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"MONEY_MOVEMENT\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/:member_identifier", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", ":member_identifier" ], "variable": [ { "key": "user_identifier" }, { "key": "member_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"PREVENTED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-4f685eec-16ad-4c17-b3ae-10cab0ccd498" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-3011710c-c092-46c9-a536-5144d2934752" } ], "id": "6357838f-5bb4-445c-a0ba-a89d46bce74b", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6357838f-5bb4-445c-a0ba-a89d46bce74b" }, { "name": "aggregate_all", "item": [ { "name": "Aggregate all members", "id": "a2b35b17-48f1-4fd7-afe0-e80d2b84266e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/aggregate_all", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", "aggregate_all" ], "variable": [ { "id": "31db1b2f-a910-4936-a7db-3b4f1a6ce77e", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "description": "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" }, "response": [ { "id": "3edb4389-9359-4a9c-bf5f-bd5b7dd42f15", "name": "Accepted", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members/aggregate_all", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members", "aggregate_all" ], "variable": [ { "key": "user_identifier" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"members\": [\n {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"CREATED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n },\n {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"FAILED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"MONEY_MOVEMENT\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-3edb4389-9359-4a9c-bf5f-bd5b7dd42f15" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-a2b35b17-48f1-4fd7-afe0-e80d2b84266e" } ], "id": "026aa2a4-dca4-4a0d-b291-128e1e954c1b", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-026aa2a4-dca4-4a0d-b291-128e1e954c1b" }, { "name": "List members", "id": "939af253-9c29-465a-93af-b12c331a47d3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members?page=&records_per_page=&use_case=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "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`.", "key": "use_case", "value": "" } ], "variable": [ { "id": "a0d08ced-7360-40bf-8e46-f9ea42933e96", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "description": "This endpoint returns an array which contains information on every member associated with a specific user." }, "response": [ { "id": "a51509aa-28d6-42a5-875d-646cb7468f0c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/members?page=&records_per_page=&use_case=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "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`.", "key": "use_case", "value": "" } ], "variable": [ { "key": "user_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"members\": [\n {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"CREATED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n },\n {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"FAILED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"MONEY_MOVEMENT\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-a51509aa-28d6-42a5-875d-646cb7468f0c" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-939af253-9c29-465a-93af-b12c331a47d3" }, { "name": "Create member", "id": "e8625454-d6d6-49a8-bb34-0950b1cea9f8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "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" } ], "body": { "mode": "raw", "raw": "{\n \"client_redirect_url\": \"\",\n \"data_request\": {\n \"products\": [\n \"account_verification\",\n \"investments\"\n ]\n },\n \"enable_app2app\": \"\",\n \"member\": {\n \"credentials\": [\n {\n \"guid\": \"\",\n \"value\": \"\"\n },\n {\n \"guid\": \"\",\n \"value\": \"\"\n }\n ],\n \"institution_code\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"id\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"MONEY_MOVEMENT\"\n ]\n },\n \"referral_source\": \"\",\n \"ui_message_webview_url_scheme\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/members", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members" ], "variable": [ { "id": "8eb0cee8-b951-40b2-a455-b19bddf8864b", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "description": "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. Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data. A status of 200 indicates the member was created successfully, and no aggregation was requested. A status of 201 indicates the member was created, but a product within `data_request` failed to aggregate. A status of 202 indicates the member was successfully created, and standard aggregation (no `data_request`) was requested (does not indicate success or failure)." }, "response": [ { "id": "e3d92d80-1ec1-4987-8646-2ca0c93b5481", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "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" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"client_redirect_url\": \"\",\n \"data_request\": {\n \"products\": [\n \"account_verification\",\n \"investments\"\n ]\n },\n \"enable_app2app\": \"\",\n \"member\": {\n \"credentials\": [\n {\n \"guid\": \"\",\n \"value\": \"\"\n },\n {\n \"guid\": \"\",\n \"value\": \"\"\n }\n ],\n \"institution_code\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"id\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"MONEY_MOVEMENT\"\n ]\n },\n \"referral_source\": \"\",\n \"ui_message_webview_url_scheme\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/members", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members" ], "variable": [ { "key": "user_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"PREVENTED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e3d92d80-1ec1-4987-8646-2ca0c93b5481" }, { "id": "7a442308-a59f-4e03-8c9d-f0bb037eea5a", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "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" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"client_redirect_url\": \"\",\n \"data_request\": {\n \"products\": [\n \"account_verification\",\n \"investments\"\n ]\n },\n \"enable_app2app\": \"\",\n \"member\": {\n \"credentials\": [\n {\n \"guid\": \"\",\n \"value\": \"\"\n },\n {\n \"guid\": \"\",\n \"value\": \"\"\n }\n ],\n \"institution_code\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"id\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"MONEY_MOVEMENT\"\n ]\n },\n \"referral_source\": \"\",\n \"ui_message_webview_url_scheme\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/members", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members" ], "variable": [ { "key": "user_identifier" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"IMPEDED\",\n \"connection_status_message\": \"\",\n \"error\": {\n \"error_type\": \"\",\n \"error_code\": \"\",\n \"error_message\": \"\",\n \"user_message\": \"\"\n },\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"MONEY_MOVEMENT\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-7a442308-a59f-4e03-8c9d-f0bb037eea5a" }, { "id": "08fd1587-dad8-4b8d-bf57-9c8de197a747", "name": "Accepted", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "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" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"client_redirect_url\": \"\",\n \"data_request\": {\n \"products\": [\n \"account_verification\",\n \"investments\"\n ]\n },\n \"enable_app2app\": \"\",\n \"member\": {\n \"credentials\": [\n {\n \"guid\": \"\",\n \"value\": \"\"\n },\n {\n \"guid\": \"\",\n \"value\": \"\"\n }\n ],\n \"institution_code\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"id\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"MONEY_MOVEMENT\"\n ]\n },\n \"referral_source\": \"\",\n \"ui_message_webview_url_scheme\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/members", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "members" ], "variable": [ { "key": "user_identifier" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"PREVENTED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-08fd1587-dad8-4b8d-bf57-9c8de197a747" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e8625454-d6d6-49a8-bb34-0950b1cea9f8" } ], "id": "fd23954d-67eb-41ad-b580-11920a9a8f9b", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-fd23954d-67eb-41ad-b580-11920a9a8f9b" }, { "name": "jobs", "item": [ { "name": "{job_guid}", "item": [ { "name": "Read job", "id": "fa250f07-55a1-4871-8e99-c3365a2cf924", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/jobs/:job_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "jobs", ":job_guid" ], "variable": [ { "id": "4861b92f-9070-4659-892f-9b0eb89a6d17", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "02a1fc70-39d6-4efc-9051-bd917e758858", "key": "job_guid", "value": "", "description": "(Required) The unique identifier for the job. Defined by MX." } ] }, "description": "Use this endpoint to read the attributes of a specific job.\n> **Warning:** New implementations shouldn't use this endpoint. It is maintained for compatibility with our Nexus API only.\n" }, "response": [ { "id": "1d9985a7-d23f-4574-a216-33b6e5edbe20", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/jobs/:job_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "jobs", ":job_guid" ], "variable": [ { "key": "user_identifier" }, { "key": "job_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"job\": {\n \"created_at\": \"\",\n \"error_message\": \"\",\n \"error_message_code\": \"\",\n \"finished_at\": \"\",\n \"institution_guid\": \"\",\n \"is_authenticated\": \"\",\n \"member_guid\": \"\",\n \"started_at\": \"\",\n \"status\": \"\",\n \"status_name\": {\n \"example\": \"COMPLETED\",\n \"description\": \"The name of the status.\"\n },\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-1d9985a7-d23f-4574-a216-33b6e5edbe20" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-fa250f07-55a1-4871-8e99-c3365a2cf924" } ], "id": "afb5ce1a-df7c-4782-a7ad-96686353b9da", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-afb5ce1a-df7c-4782-a7ad-96686353b9da" } ], "id": "e2928501-25c0-4f0d-a667-114aacbf4bac", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e2928501-25c0-4f0d-a667-114aacbf4bac" }, { "name": "tags", "item": [ { "name": "{tag_guid}", "item": [ { "name": "transactions", "item": [ { "name": "List transactions by tag", "id": "d64a12ee-be9c-4ad4-bf4b-5e26f7eeccb5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/tags/:tag_guid/transactions?page=&records_per_page=&from_date=&to_date=&from_created_at=&to_created_at=&from_updated_at=&to_updated_at=&includes=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "tags", ":tag_guid", "transactions" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" }, { "description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided.", "key": "from_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.", "key": "to_date", "value": "" }, { "description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format.", "key": "from_created_at", "value": "" }, { "description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format.", "key": "to_created_at", "value": "" }, { "description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format.", "key": "from_updated_at", "value": "" }, { "description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format.", "key": "to_updated_at", "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", "key": "includes", "value": "" } ], "variable": [ { "id": "6982f363-78ca-4d98-8f17-2be6ec2fd243", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." }, { "id": "42159bfb-599f-47de-b7a0-b1ea4996a880", "key": "tag_guid", "value": "", "description": "(Required) The unique id for a `tag`." } ] }, "description": "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)." }, "response": [ { "id": "a4f1d87e-0af4-4831-9f76-a4bb9faa6ec9", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/tags/:tag_guid/transactions?page=&records_per_page=&from_date=&to_date=&from_created_at=&to_created_at=&from_updated_at=&to_updated_at=&includes=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "tags", ":tag_guid", "transactions" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" }, { "description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided.", "key": "from_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.", "key": "to_date", "value": "" }, { "description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format.", "key": "from_created_at", "value": "" }, { "description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format.", "key": "to_created_at", "value": "" }, { "description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format.", "key": "from_updated_at", "value": "" }, { "description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format.", "key": "to_updated_at", "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", "key": "includes", "value": "" } ], "variable": [ { "key": "user_identifier" }, { "key": "tag_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"PENDING\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\",\n \"classification\": {\n \"parent_class\": \"Expenses\",\n \"guid\": \"\"\n },\n \"geolocation\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"postal code\": \"\"\n },\n \"merchant\": {\n \"name\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"website_url\": \"\"\n },\n \"repeating_transaction\": {\n \"repeating_transaction_type\": \"UNKNOWN\",\n \"recurrence_type\": \"EVERY_OTHER_WEEK\",\n \"guid\": \"\"\n }\n },\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\",\n \"classification\": {\n \"parent_class\": \"Refunds\",\n \"guid\": \"\"\n },\n \"geolocation\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"postal code\": \"\"\n },\n \"merchant\": {\n \"name\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"website_url\": \"\"\n },\n \"repeating_transaction\": {\n \"repeating_transaction_type\": \"UNKNOWN\",\n \"recurrence_type\": \"EVERY_OTHER_WEEK\",\n \"guid\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-a4f1d87e-0af4-4831-9f76-a4bb9faa6ec9" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d64a12ee-be9c-4ad4-bf4b-5e26f7eeccb5" } ], "id": "baa39139-f718-49f9-a043-42055f6912cb", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-baa39139-f718-49f9-a043-42055f6912cb" } ], "id": "3501fbfe-bc8e-4c9e-9074-56fcdb298cff", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-3501fbfe-bc8e-4c9e-9074-56fcdb298cff" } ], "id": "9ecb07e2-9376-4466-b8a5-5a1fad0fcb68", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-9ecb07e2-9376-4466-b8a5-5a1fad0fcb68" }, { "name": "transactions", "item": [ { "name": "List transactions", "id": "f28bbb76-97c4-428f-a89f-f94cdc773eca", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/transactions?page=&records_per_page=&from_date=&to_date=&from_created_at=&to_created_at=&from_updated_at=&to_updated_at=&use_case=&includes=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "transactions" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" }, { "description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided.", "key": "from_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.", "key": "to_date", "value": "" }, { "description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format.", "key": "from_created_at", "value": "" }, { "description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format.", "key": "to_created_at", "value": "" }, { "description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format.", "key": "from_updated_at", "value": "" }, { "description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format.", "key": "to_updated_at", "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`.", "key": "use_case", "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", "key": "includes", "value": "" } ], "variable": [ { "id": "8762e450-8b5a-4ad2-ba91-5e95f7c14947", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "description": "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)." }, "response": [ { "id": "7613b9b9-671a-4654-afc4-2c82f48ee8a5", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/transactions?page=&records_per_page=&from_date=&to_date=&from_created_at=&to_created_at=&from_updated_at=&to_updated_at=&use_case=&includes=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "transactions" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" }, { "description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided.", "key": "from_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.", "key": "to_date", "value": "" }, { "description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format.", "key": "from_created_at", "value": "" }, { "description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format.", "key": "to_created_at", "value": "" }, { "description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format.", "key": "from_updated_at", "value": "" }, { "description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format.", "key": "to_updated_at", "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`.", "key": "use_case", "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", "key": "includes", "value": "" } ], "variable": [ { "key": "user_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"PENDING\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\",\n \"classification\": {\n \"parent_class\": \"Expenses\",\n \"guid\": \"\"\n },\n \"geolocation\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"postal code\": \"\"\n },\n \"merchant\": {\n \"name\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"website_url\": \"\"\n },\n \"repeating_transaction\": {\n \"repeating_transaction_type\": \"UNKNOWN\",\n \"recurrence_type\": \"EVERY_OTHER_WEEK\",\n \"guid\": \"\"\n }\n },\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\",\n \"classification\": {\n \"parent_class\": \"Refunds\",\n \"guid\": \"\"\n },\n \"geolocation\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"postal code\": \"\"\n },\n \"merchant\": {\n \"name\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"website_url\": \"\"\n },\n \"repeating_transaction\": {\n \"repeating_transaction_type\": \"UNKNOWN\",\n \"recurrence_type\": \"EVERY_OTHER_WEEK\",\n \"guid\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-7613b9b9-671a-4654-afc4-2c82f48ee8a5" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-f28bbb76-97c4-428f-a89f-f94cdc773eca" } ], "id": "6afcbecb-eb84-4a12-8bca-4bb6f9f33565", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6afcbecb-eb84-4a12-8bca-4bb6f9f33565" }, { "name": "widget_urls", "item": [ { "name": "Request widget URL", "id": "704df735-758a-4360-8743-b814500580a6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "The desired language of the widget.", "key": "Accept-Language", "value": "" }, { "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" } ], "body": { "mode": "raw", "raw": "{\n \"widget_url\": {\n \"widget_type\": \"\",\n \"client_redirect_url\": \"\",\n \"color_scheme\": \"light\",\n \"current_institution_code\": \"\",\n \"current_institution_guid\": \"\",\n \"current_member_guid\": \"\",\n \"current_microdeposit_guid\": \"\",\n \"data_request\": {\n \"products\": [\n \"rewards\",\n \"transaction_history\"\n ]\n },\n \"deep_link_params\": {\n \"account_guid\": \"\",\n \"date_range\": {\n \"start_date\": \"\",\n \"end_date\": \"\"\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 \"MONEY_MOVEMENT\",\n \"PFM\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/widget_urls", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "widget_urls" ], "variable": [ { "id": "9ca16c3b-43f8-489c-bf4d-dc0ac1edc3be", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "description": "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\u2014the 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" }, "response": [ { "id": "184869fd-3226-450c-badf-33d6643e77e2", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "The desired language of the widget.", "key": "Accept-Language", "value": "" }, { "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" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"widget_url\": {\n \"widget_type\": \"\",\n \"client_redirect_url\": \"\",\n \"color_scheme\": \"light\",\n \"current_institution_code\": \"\",\n \"current_institution_guid\": \"\",\n \"current_member_guid\": \"\",\n \"current_microdeposit_guid\": \"\",\n \"data_request\": {\n \"products\": [\n \"rewards\",\n \"transaction_history\"\n ]\n },\n \"deep_link_params\": {\n \"account_guid\": \"\",\n \"date_range\": {\n \"start_date\": \"\",\n \"end_date\": \"\"\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 \"MONEY_MOVEMENT\",\n \"PFM\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/widget_urls", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "widget_urls" ], "variable": [ { "key": "user_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"widget_url\": {\n \"type\": \"help_widget\",\n \"url\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-184869fd-3226-450c-badf-33d6643e77e2" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-704df735-758a-4360-8743-b814500580a6" } ], "id": "4bd2718f-a292-4170-b4ca-ff5192053b7c", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-4bd2718f-a292-4170-b4ca-ff5192053b7c" }, { "name": "monthly_cash_flow_profile", "item": [ { "name": "Read monthly cash flow profile", "id": "28a94a8c-63da-417d-9432-1815b310e50e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/monthly_cash_flow_profile", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "monthly_cash_flow_profile" ], "variable": [ { "id": "2cf5b827-7730-4fde-b2fa-1917150d28f2", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "description": "Read monthly cash flow profile." }, "response": [ { "id": "bc6a1a51-e213-47ca-8a2c-1510fd9f694f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier/monthly_cash_flow_profile", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "monthly_cash_flow_profile" ], "variable": [ { "key": "user_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"monthly_cash_flow_profile\": {\n \"guid\": \"\",\n \"user_guid\": \"\",\n \"budgeted_income\": \"\",\n \"budgeted_expenses\": \"\",\n \"goals_contribution\": \"\",\n \"estimated_goals_contribution\": \"\",\n \"uses_estimated_goals_contribution\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-bc6a1a51-e213-47ca-8a2c-1510fd9f694f" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-28a94a8c-63da-417d-9432-1815b310e50e" }, { "name": "Update monthly cash flow profile", "id": "1218f201-b90d-47f2-866c-ab9c1bcba68b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"monthly_cash_flow_profile\": {\n \"goals_contribution\": \"\",\n \"uses_estimated_goals_contribution\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/monthly_cash_flow_profile", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "monthly_cash_flow_profile" ], "variable": [ { "id": "1a58380e-7478-4c21-a68f-067b4ab421a5", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "description": "Use this endpoint to update the attributes of a `monthly_cash_flow_profile`." }, "response": [ { "id": "81963b5d-def0-4635-9e6c-f75541a78530", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"monthly_cash_flow_profile\": {\n \"goals_contribution\": \"\",\n \"uses_estimated_goals_contribution\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier/monthly_cash_flow_profile", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier", "monthly_cash_flow_profile" ], "variable": [ { "key": "user_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"monthly_cash_flow_profile\": {\n \"guid\": \"\",\n \"user_guid\": \"\",\n \"budgeted_income\": \"\",\n \"budgeted_expenses\": \"\",\n \"goals_contribution\": \"\",\n \"estimated_goals_contribution\": \"\",\n \"uses_estimated_goals_contribution\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-81963b5d-def0-4635-9e6c-f75541a78530" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-1218f201-b90d-47f2-866c-ab9c1bcba68b" } ], "id": "3fff91dc-34c5-4367-b33a-a667e9339d31", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-3fff91dc-34c5-4367-b33a-a667e9339d31" }, { "name": "Delete user", "id": "1796717a-9cef-48dd-a35e-72139434ec4f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier" ], "variable": [ { "id": "a1a453ce-8769-4ad8-8906-65e47388f4c4", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "description": "Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object.\n\n\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" }, "response": [ { "id": "c6927143-aa43-4d29-bed9-bcf1a38b5a51", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier" ], "variable": [ { "key": "user_identifier" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-c6927143-aa43-4d29-bed9-bcf1a38b5a51" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-1796717a-9cef-48dd-a35e-72139434ec4f" }, { "name": "Read user", "id": "f0f4bc78-565a-4d94-8bb7-e1d454ace342", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier" ], "variable": [ { "id": "6d0a443e-0982-4af8-af74-c5dd695ec1f6", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "description": "Use this endpoint to read the attributes of a specific user." }, "response": [ { "id": "a6bba6a8-30e7-4032-81e4-e6d5309f8b25", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_identifier", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier" ], "variable": [ { "key": "user_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"user\": {\n \"email\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_disabled\": \"\",\n \"metadata\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-a6bba6a8-30e7-4032-81e4-e6d5309f8b25" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-f0f4bc78-565a-4d94-8bb7-e1d454ace342" }, { "name": "Update user", "id": "3ed6387b-e48d-496e-93f6-336566422adb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"email\": \"\",\n \"id\": \"\",\n \"is_disabled\": \"\",\n \"metadata\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier" ], "variable": [ { "id": "eb614b91-9d07-4ab7-a705-a6457140bd68", "key": "user_identifier", "value": "", "description": "(Required) Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You\u200b](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)." } ] }, "description": "Use this endpoint to update the attributes of the specified user." }, "response": [ { "id": "417041be-916c-434a-a42f-bc2b3ea1f4ed", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"email\": \"\",\n \"id\": \"\",\n \"is_disabled\": \"\",\n \"metadata\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_identifier", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_identifier" ], "variable": [ { "key": "user_identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"user\": {\n \"email\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_disabled\": \"\",\n \"metadata\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-417041be-916c-434a-a42f-bc2b3ea1f4ed" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-3ed6387b-e48d-496e-93f6-336566422adb" } ], "id": "f106ec11-874a-4974-a126-547dadb97501", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-f106ec11-874a-4974-a126-547dadb97501" }, { "name": "{user_guid}", "item": [ { "name": "accounts", "item": [ { "name": "{account_guid}", "item": [ { "name": "date_range_category_totals", "item": [ { "name": "List category totals by account", "id": "87ce5053-a855-4eec-abb2-9ee727893690", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/:account_guid/date_range_category_totals?from_date=&to_date=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", ":account_guid", "date_range_category_totals" ], "query": [ { "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.", "key": "from_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.", "key": "to_date", "value": "" } ], "variable": [ { "id": "134ddd23-83a9-4db8-b5e6-d122a50a17bf", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "ac07d0d2-1167-4a59-b34d-48edc4663b58", "key": "account_guid", "value": "", "description": "(Required) The unique id for an `account`." } ] }, "description": "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." }, "response": [ { "id": "becf9790-44c6-4cd5-8db4-2c0ccece6072", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/:account_guid/date_range_category_totals?from_date=&to_date=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", ":account_guid", "date_range_category_totals" ], "query": [ { "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.", "key": "from_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.", "key": "to_date", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "account_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"date_range_category_totals\": [\n {\n \"category_guid\": \"\",\n \"end_date\": \"\",\n \"start_date\": \"\",\n \"total\": \"\",\n \"user_guid\": \"\"\n },\n {\n \"category_guid\": \"\",\n \"end_date\": \"\",\n \"start_date\": \"\",\n \"total\": \"\",\n \"user_guid\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-becf9790-44c6-4cd5-8db4-2c0ccece6072" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-87ce5053-a855-4eec-abb2-9ee727893690" } ], "id": "33f8c578-6d7b-4295-86cb-1a0151a11827", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-33f8c578-6d7b-4295-86cb-1a0151a11827" }, { "name": "block", "item": [ { "name": "Block an account", "id": "46bd696e-ece0-40a4-8a53-5acccdb52a0a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/:account_guid/block", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", ":account_guid", "block" ], "variable": [ { "id": "d164007b-bc8d-4c7b-bfa2-2207532215d1", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "a9511d91-2e1e-4399-a657-7e5450c15361", "key": "account_guid", "value": "", "description": "(Required) The unique id for an `account`." } ] }, "description": "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" }, "response": [ { "id": "16ac47c3-2cfb-4949-85df-a9b796215adc", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/:account_guid/block", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", ":account_guid", "block" ], "variable": [ { "key": "user_guid" }, { "key": "account_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-16ac47c3-2cfb-4949-85df-a9b796215adc" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-46bd696e-ece0-40a4-8a53-5acccdb52a0a" } ], "id": "db4e0a73-de8a-4817-ba07-d34ddd08e431", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-db4e0a73-de8a-4817-ba07-d34ddd08e431" }, { "name": "insights", "item": [ { "name": "List insights by account", "id": "744b0748-3433-4a95-b603-bcb1858d12bf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/:account_guid/insights?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", ":account_guid", "insights" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "315294c2-af0e-44f5-95d8-67e88844a731", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "c71ca550-a226-4b69-be52-f5f7b1ed74d6", "key": "account_guid", "value": "", "description": "(Required) The unique id for an `account`." } ] }, "description": "Use this endpoint to list all insights associated with an account GUID." }, "response": [ { "id": "e71867d5-ec12-49ea-a9c8-8d523c00f17f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/:account_guid/insights?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", ":account_guid", "insights" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "account_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"insights\": [\n {\n \"active_at\": \"\",\n \"client_guid\": \"\",\n \"created_at\": \"\",\n \"cta_clicked_at\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"has_associated_accounts\": \"\",\n \"has_associated_categories\": \"\",\n \"has_associated_merchants\": \"\",\n \"has_associated_scheduled_payments\": \"\",\n \"has_associated_transactions\": \"\",\n \"has_been_displayed\": \"\",\n \"is_dismissed\": \"\",\n \"micro_call_to_action\": \"\",\n \"micro_description\": \"\",\n \"micro_title\": \"\",\n \"template\": \"\",\n \"title\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n },\n {\n \"active_at\": \"\",\n \"client_guid\": \"\",\n \"created_at\": \"\",\n \"cta_clicked_at\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"has_associated_accounts\": \"\",\n \"has_associated_categories\": \"\",\n \"has_associated_merchants\": \"\",\n \"has_associated_scheduled_payments\": \"\",\n \"has_associated_transactions\": \"\",\n \"has_been_displayed\": \"\",\n \"is_dismissed\": \"\",\n \"micro_call_to_action\": \"\",\n \"micro_description\": \"\",\n \"micro_title\": \"\",\n \"template\": \"\",\n \"title\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e71867d5-ec12-49ea-a9c8-8d523c00f17f" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-744b0748-3433-4a95-b603-bcb1858d12bf" } ], "id": "ffdeb0e5-c4eb-4123-a8af-3411ee37fd67", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-ffdeb0e5-c4eb-4123-a8af-3411ee37fd67" }, { "name": "monthly_account_balances", "item": [ { "name": "List account balances by month", "id": "d2fb32f6-c2d4-4412-bef9-f65201ad4211", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/:account_guid/monthly_account_balances?from_date=&to_date=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", ":account_guid", "monthly_account_balances" ], "query": [ { "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.", "key": "from_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.", "key": "to_date", "value": "" } ], "variable": [ { "id": "e06ba0f4-7373-4308-956b-168b5e0aff90", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "887fe2af-e669-497a-8296-0a146c4866a7", "key": "account_guid", "value": "", "description": "(Required) The unique id for an `account`." } ] }, "description": "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." }, "response": [ { "id": "97376bab-3881-48ae-b19c-2a61b3f48d71", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/:account_guid/monthly_account_balances?from_date=&to_date=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", ":account_guid", "monthly_account_balances" ], "query": [ { "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.", "key": "from_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.", "key": "to_date", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "account_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"monthly_account_balances\": [\n {\n \"account_guid\": \"\",\n \"balance\": \"\",\n \"month\": \"\",\n \"user_guid\": \"\",\n \"year\": \"\"\n },\n {\n \"account_guid\": \"\",\n \"balance\": \"\",\n \"month\": \"\",\n \"user_guid\": \"\",\n \"year\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-97376bab-3881-48ae-b19c-2a61b3f48d71" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d2fb32f6-c2d4-4412-bef9-f65201ad4211" } ], "id": "b331e195-71e3-4edc-97c5-d2faf4929643", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b331e195-71e3-4edc-97c5-d2faf4929643" }, { "name": "transactions", "item": [ { "name": "Create manual transaction", "id": "33d4676d-21ed-4f18-8987-c53e2a9bd7b0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"type\": \"CREDIT\",\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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/:account_guid/transactions", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", ":account_guid", "transactions" ], "variable": [ { "id": "630b2b41-31bb-40e9-a02a-df5cc6d63466", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "8199245e-28c4-4f3e-9666-adcd53bc024d", "key": "account_guid", "value": "", "description": "(Required) The unique id for an `account`." } ] }, "description": "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" }, "response": [ { "id": "201836be-ef03-4814-ace3-911496717c47", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"type\": \"CREDIT\",\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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/:account_guid/transactions", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", ":account_guid", "transactions" ], "variable": [ { "key": "user_guid" }, { "key": "account_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-201836be-ef03-4814-ace3-911496717c47" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-33d4676d-21ed-4f18-8987-c53e2a9bd7b0" }, { "name": "List transactions by account", "id": "285359f6-e20f-4c3c-bb29-922713b52558", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/:account_guid/transactions?page=&records_per_page=&from_date=&to_date=&from_created_at=&to_created_at=&from_updated_at=&to_updated_at=&includes=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", ":account_guid", "transactions" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" }, { "description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided.", "key": "from_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.", "key": "to_date", "value": "" }, { "description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format.", "key": "from_created_at", "value": "" }, { "description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format.", "key": "to_created_at", "value": "" }, { "description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format.", "key": "from_updated_at", "value": "" }, { "description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format.", "key": "to_updated_at", "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", "key": "includes", "value": "" } ], "variable": [ { "id": "bddb3b0b-b4ad-4652-a977-fc6292b835db", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "d01973d7-52f4-4f39-abcc-cf0bb5929d27", "key": "account_guid", "value": "", "description": "(Required) The unique id for an `account`." } ] }, "description": "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)." }, "response": [ { "id": "1a384f61-8d5c-4363-b4ff-e1fa9ff45b3f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/:account_guid/transactions?page=&records_per_page=&from_date=&to_date=&from_created_at=&to_created_at=&from_updated_at=&to_updated_at=&includes=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", ":account_guid", "transactions" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" }, { "description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided.", "key": "from_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.", "key": "to_date", "value": "" }, { "description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format.", "key": "from_created_at", "value": "" }, { "description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format.", "key": "to_created_at", "value": "" }, { "description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format.", "key": "from_updated_at", "value": "" }, { "description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format.", "key": "to_updated_at", "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", "key": "includes", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "account_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"PENDING\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\",\n \"classification\": {\n \"parent_class\": \"Expenses\",\n \"guid\": \"\"\n },\n \"geolocation\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"postal code\": \"\"\n },\n \"merchant\": {\n \"name\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"website_url\": \"\"\n },\n \"repeating_transaction\": {\n \"repeating_transaction_type\": \"UNKNOWN\",\n \"recurrence_type\": \"EVERY_OTHER_WEEK\",\n \"guid\": \"\"\n }\n },\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\",\n \"classification\": {\n \"parent_class\": \"Refunds\",\n \"guid\": \"\"\n },\n \"geolocation\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"postal code\": \"\"\n },\n \"merchant\": {\n \"name\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"website_url\": \"\"\n },\n \"repeating_transaction\": {\n \"repeating_transaction_type\": \"UNKNOWN\",\n \"recurrence_type\": \"EVERY_OTHER_WEEK\",\n \"guid\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-1a384f61-8d5c-4363-b4ff-e1fa9ff45b3f" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-285359f6-e20f-4c3c-bb29-922713b52558" } ], "id": "d24ed283-8eb4-4e06-83a1-b1dac0d7baa1", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d24ed283-8eb4-4e06-83a1-b1dac0d7baa1" }, { "name": "investment_holdings", "item": [ { "name": "List holdings by account", "id": "1a37c5bd-be57-48a6-9a48-393c5c88349d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/:account_guid/investment_holdings?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", ":account_guid", "investment_holdings" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "77c6ecff-8cb6-469d-aea4-54fed05cc5ad", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "45e80365-e3ce-403e-bf5a-e9703f205f9f", "key": "account_guid", "value": "", "description": "(Required) The unique id for an `account`." } ] }, "description": "This endpoint lists all holdings associated with the particular account defined." }, "response": [ { "id": "665e787c-824d-44fb-8afa-b9ae132b49fb", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/:account_guid/investment_holdings?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", ":account_guid", "investment_holdings" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "account_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"investment_holdings\": [\n {\n \"account_guid\": \"\",\n \"cost_basis\": \"\",\n \"coupon_yield\": \"\",\n \"currency_code\": \"\",\n \"current_price\": \"\",\n \"daily_change\": \"\",\n \"description\": \"\",\n \"expiration\": \"\",\n \"face_value\": \"\",\n \"frequency\": \"\",\n \"guid\": \"\",\n \"market_value\": \"\",\n \"maturity_date\": \"\",\n \"percentage_change\": \"\",\n \"purchase_price\": \"\",\n \"quantity\": \"\",\n \"rate\": \"\",\n \"strike_price\": \"\",\n \"symbol\": \"\",\n \"term\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_ugl_amount\": \"\",\n \"total_ugl_percentage\": \"\",\n \"unvested_quantity\": \"\",\n \"unvested_value\": \"\",\n \"user_guid\": \"\",\n \"vested_quantity\": \"\",\n \"vested_value\": \"\",\n \"created_at\": \"\",\n \"current_price_as_of\": \"\",\n \"issue_date\": \"\",\n \"vesting_start_date\": \"\",\n \"vesting_end_date\": \"\",\n \"put_or_call\": \"\",\n \"holding_type\": \"\",\n \"term_unit\": \"\"\n },\n {\n \"account_guid\": \"\",\n \"cost_basis\": \"\",\n \"coupon_yield\": \"\",\n \"currency_code\": \"\",\n \"current_price\": \"\",\n \"daily_change\": \"\",\n \"description\": \"\",\n \"expiration\": \"\",\n \"face_value\": \"\",\n \"frequency\": \"\",\n \"guid\": \"\",\n \"market_value\": \"\",\n \"maturity_date\": \"\",\n \"percentage_change\": \"\",\n \"purchase_price\": \"\",\n \"quantity\": \"\",\n \"rate\": \"\",\n \"strike_price\": \"\",\n \"symbol\": \"\",\n \"term\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_ugl_amount\": \"\",\n \"total_ugl_percentage\": \"\",\n \"unvested_quantity\": \"\",\n \"unvested_value\": \"\",\n \"user_guid\": \"\",\n \"vested_quantity\": \"\",\n \"vested_value\": \"\",\n \"created_at\": \"\",\n \"current_price_as_of\": \"\",\n \"issue_date\": \"\",\n \"vesting_start_date\": \"\",\n \"vesting_end_date\": \"\",\n \"put_or_call\": \"\",\n \"holding_type\": \"\",\n \"term_unit\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-665e787c-824d-44fb-8afa-b9ae132b49fb" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-1a37c5bd-be57-48a6-9a48-393c5c88349d" } ], "id": "be1f928f-a1a2-46d4-b45f-e4f18b546f0a", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-be1f928f-a1a2-46d4-b45f-e4f18b546f0a" }, { "name": "Read account", "id": "1ad4b804-b6ff-4717-a0b4-778b497243bb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/:account_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", ":account_guid" ], "variable": [ { "id": "40350a36-7bd2-43ce-b646-104237b6d9e7", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "812905d9-203a-49af-9d81-cc1e903c3edc", "key": "account_guid", "value": "", "description": "(Required) The unique id for an `account`." } ] }, "description": "This endpoint returns the specified `account` resource." }, "response": [ { "id": "2f7f1530-e973-41ef-ba72-63d95a73a228", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/:account_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", ":account_guid" ], "variable": [ { "key": "user_guid" }, { "key": "account_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"account\": {\n \"account_number\": \"\",\n \"account_ownership\": null,\n \"annuity_policy_to_date\": \"\",\n \"annuity_provider\": \"\",\n \"annuity_term_year\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"available_credit\": \"\",\n \"balance\": \"\",\n \"cash_balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"created_at\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"day_payment_is_due\": \"\",\n \"death_benefit\": \"\",\n \"federal_insurance_status\": \"NOT_INSURED\",\n \"guid\": \"\",\n \"id\": \"\",\n \"imported_at\": \"\",\n \"interest_rate\": \"\",\n \"institution_code\": \"\",\n \"insured_name\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"is_manual\": \"\",\n \"last_payment\": \"\",\n \"last_payment_at\": \"\",\n \"loan_amount\": \"\",\n \"margin_balance\": \"\",\n \"matures_on\": \"\",\n \"member_guid\": \"\",\n \"member_id\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"metadata\": \"\",\n \"minimum_balance\": \"\",\n \"minimum_payment\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"pay_out_amount\": \"\",\n \"payment_due_at\": \"\",\n \"payoff_balance\": \"\",\n \"premium_amount\": \"\",\n \"property_type\": \"FURNITURE\",\n \"routing_number\": \"\",\n \"started_on\": \"\",\n \"statement_balance\": \"\",\n \"subtype\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_account_value\": \"\",\n \"total_account_value_ugl\": \"\",\n \"type\": \"PROPERTY\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-2f7f1530-e973-41ef-ba72-63d95a73a228" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-1ad4b804-b6ff-4717-a0b4-778b497243bb" }, { "name": "Delete manual account", "id": "79892c14-f15f-4d5c-8365-f1b45bbf8a41", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/:account_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", ":account_guid" ], "variable": [ { "id": "53a7d6c2-bdb3-491f-b643-8918a585b4b8", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "2256964c-72b7-4f7f-8d2f-612edb3b0d00", "key": "account_guid", "value": "", "description": "(Required) The unique id for an `account`." } ] }, "description": "This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of `204 No Content`." }, "response": [ { "id": "c1814331-3fa5-4fb4-91a5-87b53872f1d2", "name": "No content.", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/:account_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", ":account_guid" ], "variable": [ { "key": "user_guid" }, { "key": "account_guid" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-c1814331-3fa5-4fb4-91a5-87b53872f1d2" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-79892c14-f15f-4d5c-8365-f1b45bbf8a41" } ], "id": "53a3dc31-8ced-4a31-9aa5-d76323a2fa67", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-53a3dc31-8ced-4a31-9aa5-d76323a2fa67" }, { "name": "merge", "item": [ { "name": "Merge accounts", "id": "2afb6fd8-674f-4d2d-b71d-129fa71cc25e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"account_guids\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/merge", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", "merge" ], "variable": [ { "id": "276d0cbf-d526-4e82-bf2c-b77c8585942b", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "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\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" }, "response": [ { "id": "afe99b47-5ca3-42a7-a0a8-d708c1c93b56", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"account_guids\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/accounts/merge", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "accounts", "merge" ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"account\": {\n \"account_number\": \"\",\n \"account_ownership\": null,\n \"annuity_policy_to_date\": \"\",\n \"annuity_provider\": \"\",\n \"annuity_term_year\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"available_credit\": \"\",\n \"balance\": \"\",\n \"cash_balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"created_at\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"day_payment_is_due\": \"\",\n \"death_benefit\": \"\",\n \"federal_insurance_status\": \"NOT_INSURED\",\n \"guid\": \"\",\n \"id\": \"\",\n \"imported_at\": \"\",\n \"interest_rate\": \"\",\n \"institution_code\": \"\",\n \"insured_name\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"is_manual\": \"\",\n \"last_payment\": \"\",\n \"last_payment_at\": \"\",\n \"loan_amount\": \"\",\n \"margin_balance\": \"\",\n \"matures_on\": \"\",\n \"member_guid\": \"\",\n \"member_id\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"metadata\": \"\",\n \"minimum_balance\": \"\",\n \"minimum_payment\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"pay_out_amount\": \"\",\n \"payment_due_at\": \"\",\n \"payoff_balance\": \"\",\n \"premium_amount\": \"\",\n \"property_type\": \"FURNITURE\",\n \"routing_number\": \"\",\n \"started_on\": \"\",\n \"statement_balance\": \"\",\n \"subtype\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_account_value\": \"\",\n \"total_account_value_ugl\": \"\",\n \"type\": \"PROPERTY\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-afe99b47-5ca3-42a7-a0a8-d708c1c93b56" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-2afb6fd8-674f-4d2d-b71d-129fa71cc25e" } ], "id": "f5e0910b-7245-4c26-9fda-20b6a0d15b61", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-f5e0910b-7245-4c26-9fda-20b6a0d15b61" } ], "id": "9402ba07-a88f-483c-b1ac-4d0471ad3531", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-9402ba07-a88f-483c-b1ac-4d0471ad3531" }, { "name": "date_range_category_totals", "item": [ { "name": "List category totals by user", "id": "875bbc6e-f514-4dfd-b534-fa2db3ed2666", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/date_range_category_totals?from_date=&to_date=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "date_range_category_totals" ], "query": [ { "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.", "key": "from_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.", "key": "to_date", "value": "" } ], "variable": [ { "id": "ffc10c4c-02b2-4b03-8086-59745b2c3e0a", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "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." }, "response": [ { "id": "6733747e-bb7f-47e7-bebe-a17716bbfa47", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/date_range_category_totals?from_date=&to_date=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "date_range_category_totals" ], "query": [ { "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.", "key": "from_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.", "key": "to_date", "value": "" } ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"date_range_category_totals\": [\n {\n \"category_guid\": \"\",\n \"end_date\": \"\",\n \"start_date\": \"\",\n \"total\": \"\",\n \"user_guid\": \"\"\n },\n {\n \"category_guid\": \"\",\n \"end_date\": \"\",\n \"start_date\": \"\",\n \"total\": \"\",\n \"user_guid\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6733747e-bb7f-47e7-bebe-a17716bbfa47" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-875bbc6e-f514-4dfd-b534-fa2db3ed2666" } ], "id": "f1d3845e-c71b-4dba-a0b6-84fb89c43f28", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-f1d3845e-c71b-4dba-a0b6-84fb89c43f28" }, { "name": "categories", "item": [ { "name": "default", "item": [ { "name": "List default categories by user", "id": "23628439-0c59-4307-9030-b6eff7078b1b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/categories/default?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "categories", "default" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "f1abd560-f6c2-4f8f-b51f-1b6a0589f32d", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "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." }, "response": [ { "id": "920121b7-5593-458c-8c55-8911f4eba02b", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/categories/default?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "categories", "default" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"categories\": [\n {\n \"created_at\": \"\",\n \"guid\": \"\",\n \"is_default\": \"\",\n \"is_income\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"parent_guid\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"created_at\": \"\",\n \"guid\": \"\",\n \"is_default\": \"\",\n \"is_income\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"parent_guid\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-920121b7-5593-458c-8c55-8911f4eba02b" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-23628439-0c59-4307-9030-b6eff7078b1b" } ], "id": "a22ef1c2-9567-46d0-a7e2-44e98c7a6f31", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-a22ef1c2-9567-46d0-a7e2-44e98c7a6f31" }, { "name": "{category_guid}", "item": [ { "name": "Delete category", "id": "aac52cf3-ca91-432d-898e-e2e55ddc7ce9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/categories/:category_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "categories", ":category_guid" ], "variable": [ { "id": "86d14dac-f45c-4ee3-a9a7-96553dc23cee", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "de33519c-b0a8-47f0-9bbb-62a1839a683d", "key": "category_guid", "value": "", "description": "(Required) The unique id for a `category`." } ] }, "description": "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`." }, "response": [ { "id": "9317b520-1104-4c4f-88ad-387412cb1a0d", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/categories/:category_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "categories", ":category_guid" ], "variable": [ { "key": "user_guid" }, { "key": "category_guid" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-9317b520-1104-4c4f-88ad-387412cb1a0d" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-aac52cf3-ca91-432d-898e-e2e55ddc7ce9" }, { "name": "Read a custom category", "id": "5615be23-ef70-45fb-97c2-bd30ec396e3e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/categories/:category_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "categories", ":category_guid" ], "variable": [ { "id": "12900ca1-e094-4bb0-87d8-ed72d21843ad", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "3fa5ea76-3f89-4af0-bf15-8f93f7739026", "key": "category_guid", "value": "", "description": "(Required) The unique id for a `category`." } ] }, "description": "Use this endpoint to read the attributes of either a default category or a custom category." }, "response": [ { "id": "fe37490b-04ba-4035-953e-22ed6de4116a", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/categories/:category_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "categories", ":category_guid" ], "variable": [ { "key": "user_guid" }, { "key": "category_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"category\": {\n \"created_at\": \"\",\n \"guid\": \"\",\n \"is_default\": \"\",\n \"is_income\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"parent_guid\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-fe37490b-04ba-4035-953e-22ed6de4116a" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-5615be23-ef70-45fb-97c2-bd30ec396e3e" }, { "name": "Update category", "id": "8ef6374c-a7fe-465a-a478-b53457174c9e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"category\": {\n \"metadata\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/categories/:category_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "categories", ":category_guid" ], "variable": [ { "id": "1f0d1826-02fe-42c3-a3ff-96612b498f4f", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "38f0a963-1db2-4ab5-97aa-dbc2489d72ea", "key": "category_guid", "value": "", "description": "(Required) The unique id for a `category`." } ] }, "description": "Use this endpoint to update the attributes of a custom category according to its unique GUID." }, "response": [ { "id": "14baa89e-ad05-422d-9d8c-95630eb781e7", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"category\": {\n \"metadata\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/categories/:category_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "categories", ":category_guid" ], "variable": [ { "key": "user_guid" }, { "key": "category_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"category\": {\n \"created_at\": \"\",\n \"guid\": \"\",\n \"is_default\": \"\",\n \"is_income\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"parent_guid\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-14baa89e-ad05-422d-9d8c-95630eb781e7" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-8ef6374c-a7fe-465a-a478-b53457174c9e" } ], "id": "66f119b1-b4f6-406f-b54c-e272f7a8a7d2", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-66f119b1-b4f6-406f-b54c-e272f7a8a7d2" }, { "name": "List categories", "id": "a59d212b-6dd8-4368-8560-c7d53379acd2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/categories?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "categories" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "664ceb4d-cf61-4680-ac45-60c6728103a5", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "Use this endpoint to list all categories associated with a `user`, including both default and custom categories." }, "response": [ { "id": "0557df55-b9c2-48b1-88da-1ff97ec8d7ff", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/categories?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "categories" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"categories\": [\n {\n \"created_at\": \"\",\n \"guid\": \"\",\n \"is_default\": \"\",\n \"is_income\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"parent_guid\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"created_at\": \"\",\n \"guid\": \"\",\n \"is_default\": \"\",\n \"is_income\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"parent_guid\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-0557df55-b9c2-48b1-88da-1ff97ec8d7ff" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-a59d212b-6dd8-4368-8560-c7d53379acd2" }, { "name": "Create category", "id": "fb4ba904-80d5-4689-966b-20620220b575", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"category\": {\n \"name\": \"\",\n \"parent_guid\": \"\",\n \"metadata\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/categories", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "categories" ], "variable": [ { "id": "680a4666-7fd2-4586-8fe0-978727f5de73", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "Use this endpoint to create a new custom category for a specific `user`." }, "response": [ { "id": "25c53cb4-75ea-4aa8-8148-bc12df9c2390", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"category\": {\n \"name\": \"\",\n \"parent_guid\": \"\",\n \"metadata\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/categories", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "categories" ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"category\": {\n \"created_at\": \"\",\n \"guid\": \"\",\n \"is_default\": \"\",\n \"is_income\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"parent_guid\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-25c53cb4-75ea-4aa8-8148-bc12df9c2390" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-fb4ba904-80d5-4689-966b-20620220b575" } ], "id": "093a7d11-1140-488c-9740-8cd0732ca85a", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-093a7d11-1140-488c-9740-8cd0732ca85a" }, { "name": "insights", "item": [ { "name": "{insight_guid}", "item": [ { "name": "categories", "item": [ { "name": "List all categories associated with an insight", "id": "05f1d1b4-2cb5-4ee8-8b3d-7eb0877ffb0e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/insights/:insight_guid/categories?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "insights", ":insight_guid", "categories" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "72618e51-d818-4d07-8b71-3cc9c711a24a", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "2b677aeb-32c4-49db-9057-0308a6023454", "key": "insight_guid", "value": "", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "description": "Use this endpoint to list all the categories associated with the insight." }, "response": [ { "id": "69025566-c2ce-41d6-98c2-5da897badaf1", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/insights/:insight_guid/categories?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "insights", ":insight_guid", "categories" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "insight_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"categories\": [\n {\n \"created_at\": \"\",\n \"guid\": \"\",\n \"is_default\": \"\",\n \"is_income\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"parent_guid\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"created_at\": \"\",\n \"guid\": \"\",\n \"is_default\": \"\",\n \"is_income\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"parent_guid\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-69025566-c2ce-41d6-98c2-5da897badaf1" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-05f1d1b4-2cb5-4ee8-8b3d-7eb0877ffb0e" } ], "id": "05cc2fcf-40ea-4b71-bee3-615febb06df6", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-05cc2fcf-40ea-4b71-bee3-615febb06df6" }, { "name": "accounts", "item": [ { "name": "List all accounts associated with an insight", "id": "d52b58a7-55b3-4797-a37e-845b7781fb0a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/insights/:insight_guid/accounts?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "insights", ":insight_guid", "accounts" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "6fd8dc0c-d49f-4c07-a716-ffc040b7d3ff", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "7a0a3eb9-a36c-4330-a6a9-cf475ffe6c54", "key": "insight_guid", "value": "", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "description": "Use this endpoint to list all the accounts associated with the insight." }, "response": [ { "id": "e6eebe2a-f776-44eb-83e0-742dca09e108", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/insights/:insight_guid/accounts?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "insights", ":insight_guid", "accounts" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "insight_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"accounts\": [\n {\n \"account_number\": \"\",\n \"account_ownership\": \"JOINT\",\n \"annuity_policy_to_date\": \"\",\n \"annuity_provider\": \"\",\n \"annuity_term_year\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"available_credit\": \"\",\n \"balance\": \"\",\n \"cash_balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"created_at\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"day_payment_is_due\": \"\",\n \"death_benefit\": \"\",\n \"federal_insurance_status\": \"UNKNOWN_INSURED\",\n \"guid\": \"\",\n \"id\": \"\",\n \"imported_at\": \"\",\n \"interest_rate\": \"\",\n \"institution_code\": \"\",\n \"insured_name\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"is_manual\": \"\",\n \"last_payment\": \"\",\n \"last_payment_at\": \"\",\n \"loan_amount\": \"\",\n \"margin_balance\": \"\",\n \"matures_on\": \"\",\n \"member_guid\": \"\",\n \"member_id\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"metadata\": \"\",\n \"minimum_balance\": \"\",\n \"minimum_payment\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"pay_out_amount\": \"\",\n \"payment_due_at\": \"\",\n \"payoff_balance\": \"\",\n \"premium_amount\": \"\",\n \"property_type\": \"REAL_ESTATE\",\n \"routing_number\": \"\",\n \"started_on\": \"\",\n \"statement_balance\": \"\",\n \"subtype\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_account_value\": \"\",\n \"total_account_value_ugl\": \"\",\n \"type\": \"LOAN\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n },\n {\n \"account_number\": \"\",\n \"account_ownership\": \"MULTIPLE\",\n \"annuity_policy_to_date\": \"\",\n \"annuity_provider\": \"\",\n \"annuity_term_year\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"available_credit\": \"\",\n \"balance\": \"\",\n \"cash_balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"created_at\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"day_payment_is_due\": \"\",\n \"death_benefit\": \"\",\n \"federal_insurance_status\": \"NOT_INSURED\",\n \"guid\": \"\",\n \"id\": \"\",\n \"imported_at\": \"\",\n \"interest_rate\": \"\",\n \"institution_code\": \"\",\n \"insured_name\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"is_manual\": \"\",\n \"last_payment\": \"\",\n \"last_payment_at\": \"\",\n \"loan_amount\": \"\",\n \"margin_balance\": \"\",\n \"matures_on\": \"\",\n \"member_guid\": \"\",\n \"member_id\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"metadata\": \"\",\n \"minimum_balance\": \"\",\n \"minimum_payment\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"pay_out_amount\": \"\",\n \"payment_due_at\": \"\",\n \"payoff_balance\": \"\",\n \"premium_amount\": \"\",\n \"property_type\": \"SPORTS_EQUIPMENT\",\n \"routing_number\": \"\",\n \"started_on\": \"\",\n \"statement_balance\": \"\",\n \"subtype\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_account_value\": \"\",\n \"total_account_value_ugl\": \"\",\n \"type\": \"INSURANCE\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e6eebe2a-f776-44eb-83e0-742dca09e108" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d52b58a7-55b3-4797-a37e-845b7781fb0a" } ], "id": "8c6bb7d6-ba6e-44b3-8687-19707b481e27", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-8c6bb7d6-ba6e-44b3-8687-19707b481e27" }, { "name": "merchants", "item": [ { "name": "List all merchants associated with an insight", "id": "d415a6c7-7fb9-448c-8203-7fabdc103e03", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/insights/:insight_guid/merchants?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "insights", ":insight_guid", "merchants" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "578cde00-2659-48f3-aba9-af3131ec62e3", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "cc7f1ee7-5409-4017-a43d-ce49fa9654b2", "key": "insight_guid", "value": "", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "description": "Use this endpoint to list all the merchants associated with the insight." }, "response": [ { "id": "23cc4c08-d8e8-49d6-874c-640f16106eed", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/insights/:insight_guid/merchants?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "insights", ":insight_guid", "merchants" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "insight_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"merchants\": [\n {\n \"created_at\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"name\": \"\",\n \"updated_at\": \"\",\n \"website_url\": \"\"\n },\n {\n \"created_at\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"name\": \"\",\n \"updated_at\": \"\",\n \"website_url\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-23cc4c08-d8e8-49d6-874c-640f16106eed" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d415a6c7-7fb9-448c-8203-7fabdc103e03" } ], "id": "ce2fc059-949b-4de5-a086-85c117d3bc24", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-ce2fc059-949b-4de5-a086-85c117d3bc24" }, { "name": "scheduled_payments", "item": [ { "name": "List all scheduled payments associated with an insight", "id": "7b610f6a-5793-4559-99ce-a10f88c6e3f8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/insights/:insight_guid/scheduled_payments?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "insights", ":insight_guid", "scheduled_payments" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "dfe2bf31-5aa6-4d8f-a5d8-4857650d59eb", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "e3e01185-d5a9-44af-8db9-cbcf13c5044a", "key": "insight_guid", "value": "", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "description": "Use this endpoint to list all the scheduled payments associated with the insight." }, "response": [ { "id": "62484a8e-b4ca-44dc-824c-a38c2f8fc569", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/insights/:insight_guid/scheduled_payments?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "insights", ":insight_guid", "scheduled_payments" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "insight_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"scheduled_payments\": [\n {\n \"amount\": \"\",\n \"created_at\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"is_completed\": \"\",\n \"is_recurring\": \"\",\n \"merchant_guid\": \"\",\n \"occurs_on\": \"\",\n \"recurrence_day\": \"\",\n \"recurrence_type\": \"\",\n \"transaction_type\": \"DEBIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n },\n {\n \"amount\": \"\",\n \"created_at\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"is_completed\": \"\",\n \"is_recurring\": \"\",\n \"merchant_guid\": \"\",\n \"occurs_on\": \"\",\n \"recurrence_day\": \"\",\n \"recurrence_type\": \"\",\n \"transaction_type\": \"DEBIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-62484a8e-b4ca-44dc-824c-a38c2f8fc569" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-7b610f6a-5793-4559-99ce-a10f88c6e3f8" } ], "id": "1ba1c651-66e7-4f76-962d-81f0f786a699", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-1ba1c651-66e7-4f76-962d-81f0f786a699" }, { "name": "transactions", "item": [ { "name": "List all transactions associated with an insight", "id": "6c697740-0bb0-4e8c-bb29-61ee120ad64c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/insights/:insight_guid/transactions?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "insights", ":insight_guid", "transactions" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "829a64dd-bd41-437c-8ea9-679f9cfd39e0", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "fca944cf-b480-40bb-9a5f-fb3e129e0557", "key": "insight_guid", "value": "", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "description": "Use this endpoint to list all the transactions associated with the insight." }, "response": [ { "id": "8e4c703c-45bd-443a-b419-58864a64f926", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/insights/:insight_guid/transactions?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "insights", ":insight_guid", "transactions" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "insight_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"PENDING\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n },\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"PENDING\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-8e4c703c-45bd-443a-b419-58864a64f926" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6c697740-0bb0-4e8c-bb29-61ee120ad64c" } ], "id": "d9d1b896-363b-4813-b6be-93fc4b9252fe", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d9d1b896-363b-4813-b6be-93fc4b9252fe" }, { "name": "Read insight", "id": "464027c4-a8bf-4230-a95a-b66b8c8aaea2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/insights/:insight_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "insights", ":insight_guid" ], "variable": [ { "id": "02872ab2-311b-4a62-864b-df5e5e45dffc", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "a7e30030-e910-4c6b-bd5c-ee3ba6e5fbec", "key": "insight_guid", "value": "", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "description": "Use this endpoint to read the attributes of an insight according to its unique GUID." }, "response": [ { "id": "d1bff86c-b57a-425b-a142-c0e0d52276cc", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/insights/:insight_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "insights", ":insight_guid" ], "variable": [ { "key": "user_guid" }, { "key": "insight_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"insight\": {\n \"active_at\": \"\",\n \"client_guid\": \"\",\n \"created_at\": \"\",\n \"cta_clicked_at\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"has_associated_accounts\": \"\",\n \"has_associated_categories\": \"\",\n \"has_associated_merchants\": \"\",\n \"has_associated_scheduled_payments\": \"\",\n \"has_associated_transactions\": \"\",\n \"has_been_displayed\": \"\",\n \"is_dismissed\": \"\",\n \"micro_call_to_action\": \"\",\n \"micro_description\": \"\",\n \"micro_title\": \"\",\n \"template\": \"\",\n \"title\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d1bff86c-b57a-425b-a142-c0e0d52276cc" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-464027c4-a8bf-4230-a95a-b66b8c8aaea2" }, { "name": "Update insight", "id": "d7cc586e-1922-4a9d-bafe-a44a4794f1c0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"insight\": {\n \"has_been_displayed\": \"\",\n \"is_dismissed\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/insights/:insight_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "insights", ":insight_guid" ], "variable": [ { "id": "471e2dc0-e182-411b-a125-e8eade761e2c", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "42f15bcd-e5c9-4457-aef2-187bc3daf32f", "key": "insight_guid", "value": "", "description": "(Required) The unique identifier for the insight. Defined by MX." } ] }, "description": "Use this endpoint to update the attributes of an insight according to its unique GUID." }, "response": [ { "id": "1a3e08d6-4771-4eab-826f-d55d4d9a25e7", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"insight\": {\n \"has_been_displayed\": \"\",\n \"is_dismissed\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/insights/:insight_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "insights", ":insight_guid" ], "variable": [ { "key": "user_guid" }, { "key": "insight_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"active_at\": \"\",\n \"client_guid\": \"\",\n \"created_at\": \"\",\n \"cta_clicked_at\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"has_associated_accounts\": \"\",\n \"has_associated_categories\": \"\",\n \"has_associated_merchants\": \"\",\n \"has_associated_scheduled_payments\": \"\",\n \"has_associated_transactions\": \"\",\n \"has_been_displayed\": \"\",\n \"is_dismissed\": \"\",\n \"micro_call_to_action\": \"\",\n \"micro_description\": \"\",\n \"micro_title\": \"\",\n \"template\": \"\",\n \"title\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-1a3e08d6-4771-4eab-826f-d55d4d9a25e7" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d7cc586e-1922-4a9d-bafe-a44a4794f1c0" } ], "id": "08c8b219-d106-4dfc-ac4b-bb2b17db76b4", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-08c8b219-d106-4dfc-ac4b-bb2b17db76b4" }, { "name": "List all insights for a user", "id": "1a1a0162-a5d8-4585-83f7-63c42cd8d5cb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/insights?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "insights" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "4fccb941-6883-46c7-bdba-ad289af50c69", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "Use this endpoint to list all the insights associated with the user." }, "response": [ { "id": "e0461f34-2cad-41d9-8fc5-c8467087a1ab", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/insights?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "insights" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"insights\": [\n {\n \"active_at\": \"\",\n \"client_guid\": \"\",\n \"created_at\": \"\",\n \"cta_clicked_at\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"has_associated_accounts\": \"\",\n \"has_associated_categories\": \"\",\n \"has_associated_merchants\": \"\",\n \"has_associated_scheduled_payments\": \"\",\n \"has_associated_transactions\": \"\",\n \"has_been_displayed\": \"\",\n \"is_dismissed\": \"\",\n \"micro_call_to_action\": \"\",\n \"micro_description\": \"\",\n \"micro_title\": \"\",\n \"template\": \"\",\n \"title\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n },\n {\n \"active_at\": \"\",\n \"client_guid\": \"\",\n \"created_at\": \"\",\n \"cta_clicked_at\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"has_associated_accounts\": \"\",\n \"has_associated_categories\": \"\",\n \"has_associated_merchants\": \"\",\n \"has_associated_scheduled_payments\": \"\",\n \"has_associated_transactions\": \"\",\n \"has_been_displayed\": \"\",\n \"is_dismissed\": \"\",\n \"micro_call_to_action\": \"\",\n \"micro_description\": \"\",\n \"micro_title\": \"\",\n \"template\": \"\",\n \"title\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e0461f34-2cad-41d9-8fc5-c8467087a1ab" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-1a1a0162-a5d8-4585-83f7-63c42cd8d5cb" } ], "id": "e616c71d-dd64-4120-9c48-857accd6399e", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e616c71d-dd64-4120-9c48-857accd6399e" }, { "name": "managed_members", "item": [ { "name": "{member_guid}", "item": [ { "name": "accounts", "item": [ { "name": "{account_guid}", "item": [ { "name": "transactions", "item": [ { "name": "{transaction_guid}", "item": [ { "name": "Delete managed transaction", "id": "a5c98ba5-1adf-4f3c-b999-e55e386b972f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions/:transaction_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions", ":transaction_guid" ], "variable": [ { "id": "26761d90-5ca3-49db-936e-e94ecc40e0b8", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "7c7ad8a6-d4a6-4863-a9a4-79b1033df68e", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." }, { "id": "6444e110-ddbe-4241-b1a3-a268e69d4c37", "key": "account_guid", "value": "", "description": "(Required) The unique id for an `account`." }, { "id": "818c0a63-4258-41f1-bbef-6fec33b3acf1", "key": "transaction_guid", "value": "", "description": "(Required) The unique id for a `transaction`." } ] }, "description": "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\nThis endpoint has been deprecated. For more information, reference the [Migration guide](/api-reference/platform-api/overview/migration).\n\n" }, "response": [ { "id": "97fc9ea1-821a-4fa3-ae27-8fc04f93093e", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions/:transaction_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions", ":transaction_guid" ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" }, { "key": "account_guid" }, { "key": "transaction_guid" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-97fc9ea1-821a-4fa3-ae27-8fc04f93093e" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-a5c98ba5-1adf-4f3c-b999-e55e386b972f" }, { "name": "Read managed transaction", "id": "7ea0ec79-0d57-430b-b894-0e7409f088f3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions/:transaction_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions", ":transaction_guid" ], "variable": [ { "id": "663d2520-c8f8-4503-9beb-0aa3c9f904ac", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "2ded7db6-ad3c-444e-9197-617a332b138a", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." }, { "id": "1996f5e8-4c04-437d-91e4-f99bcaf6b9a3", "key": "account_guid", "value": "", "description": "(Required) The unique id for an `account`." }, { "id": "ffdb6a57-c15e-4f00-8538-faed903e57f5", "key": "transaction_guid", "value": "", "description": "(Required) The unique id for a `transaction`." } ] }, "description": "Requests to this endpoint will return the attributes of the specified partner-managed `transaction`.\n\nThis endpoint has been deprecated. For more information, reference the [Migration guide](/api-reference/platform-api/overview/migration).\n\n" }, "response": [ { "id": "54f99c9f-99be-427e-9d78-bd1a9b887a6a", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions/:transaction_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions", ":transaction_guid" ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" }, { "key": "account_guid" }, { "key": "transaction_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"PENDING\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"DEBIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-54f99c9f-99be-427e-9d78-bd1a9b887a6a" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-7ea0ec79-0d57-430b-b894-0e7409f088f3" }, { "name": "Update managed transaction", "id": "b0b50359-741b-43ca-82bc-02784c37272a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "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\": \"POSTED\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions/:transaction_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions", ":transaction_guid" ], "variable": [ { "id": "44da8348-c904-41d2-a3d2-f237fa3a3350", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "05bf6a9e-55ee-4edb-97e5-4aca36cb40bb", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." }, { "id": "e716fb56-804c-4b91-9b89-6b334348ae93", "key": "account_guid", "value": "", "description": "(Required) The unique id for an `account`." }, { "id": "2b4f2416-e85e-4470-a698-4c7eef12b446", "key": "transaction_guid", "value": "", "description": "(Required) The unique id for a `transaction`." } ] }, "description": "Use this endpoint to update the attributes of the specified partner_managed `transaction`.\n\nThis endpoint has been deprecated. For more information, reference the [Migration guide](/api-reference/platform-api/overview/migration).\n\n" }, "response": [ { "id": "eb66e7c8-5627-40e8-8097-16e4f5a568b8", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "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\": \"POSTED\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions/:transaction_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions", ":transaction_guid" ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" }, { "key": "account_guid" }, { "key": "transaction_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"PENDING\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"DEBIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-eb66e7c8-5627-40e8-8097-16e4f5a568b8" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b0b50359-741b-43ca-82bc-02784c37272a" } ], "id": "3bdde164-22d5-4890-a0fa-4f02594d2b14", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-3bdde164-22d5-4890-a0fa-4f02594d2b14" }, { "name": "List managed transactions", "id": "28807eb5-e823-4103-8e08-e0c08f169b77", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions?page=&from_date=&to_date=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "page", "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.", "key": "from_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.", "key": "to_date", "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "0f4fc3c3-427a-45c8-b688-da6f31182246", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "dc9bd0a2-c600-4312-8544-5a0db7aff5cd", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." }, { "id": "f215bfb5-b67f-4773-b2b2-e02a965bff0f", "key": "account_guid", "value": "", "description": "(Required) The unique id for an `account`." } ] }, "description": "This endpoint returns a list of all the partner-managed transactions associated with the specified `account`, scoped through a `user` and a `member`.\n\nThis endpoint has been deprecated. For more information, reference the [Migration guide](/api-reference/platform-api/overview/migration).\n\n" }, "response": [ { "id": "6aa3ae11-462d-47d7-91ed-78dab423b42c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions?page=&from_date=&to_date=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "page", "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.", "key": "from_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.", "key": "to_date", "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" }, { "key": "account_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"PENDING\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n },\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"PENDING\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6aa3ae11-462d-47d7-91ed-78dab423b42c" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-28807eb5-e823-4103-8e08-e0c08f169b77" }, { "name": "Create managed transaction", "id": "1d1fc833-f712-4c08-aba8-53332f1171e7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"status\": \"PENDING\",\n \"posted_at\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"DEBIT\",\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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions" ], "variable": [ { "id": "0b472d64-9f0b-40f7-ab75-863578008adf", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "a0a10a69-2142-4cef-be73-d55f9aeb36e0", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." }, { "id": "a5d3168a-d8e2-4667-9db6-5ecec10bd53a", "key": "account_guid", "value": "", "description": "(Required) The unique id for an `account`." } ] }, "description": "Use this endpoint to create a new partner-managed `transaction`.\n\nThis endpoint has been deprecated. For more information, reference the [Migration guide](/api-reference/platform-api/overview/migration).\n\n" }, "response": [ { "id": "62f296ef-06c3-46fe-9091-3e8d96da02c4", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"status\": \"PENDING\",\n \"posted_at\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"DEBIT\",\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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid", "transactions" ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" }, { "key": "account_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"PENDING\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"DEBIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-62f296ef-06c3-46fe-9091-3e8d96da02c4" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-1d1fc833-f712-4c08-aba8-53332f1171e7" } ], "id": "296cd854-de5f-4351-9a45-cb369cfd2431", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-296cd854-de5f-4351-9a45-cb369cfd2431" }, { "name": "Delete managed account", "id": "c668263b-14f4-41ab-8fff-6985f4582f82", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts/:account_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid" ], "variable": [ { "id": "dbd51059-8d98-430a-9b19-683e85f3bbf0", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "bac2f7c9-920b-4dd4-8ffb-b25e9100f8c9", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." }, { "id": "53dd4ac0-837b-40c1-8cdd-1b20c156f3ce", "key": "account_guid", "value": "", "description": "(Required) The unique id for an `account`." } ] }, "description": "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\nThis endpoint has been deprecated. For more information, reference the [Migration guide](/api-reference/platform-api/overview/migration).\n\n" }, "response": [ { "id": "159a7187-bec8-4f25-bd82-11454e94731f", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts/:account_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid" ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" }, { "key": "account_guid" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-159a7187-bec8-4f25-bd82-11454e94731f" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-c668263b-14f4-41ab-8fff-6985f4582f82" }, { "name": "Read managed account", "id": "5f41f39e-932c-45cc-80b2-8d24b3293465", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts/:account_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid" ], "variable": [ { "id": "44d5765f-959e-4cd3-a665-170960c9f030", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "cfedd175-18ef-45d5-b725-64625d9afb27", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." }, { "id": "27c44c00-ecdb-4f07-9fd5-a2d31731fdd9", "key": "account_guid", "value": "", "description": "(Required) The unique id for an `account`." } ] }, "description": "Use this endpoint to read the attributes of a partner-managed account according to its unique guid.\n\nThis endpoint has been deprecated. For more information, reference the [Migration guide](/api-reference/platform-api/overview/migration).\n\n" }, "response": [ { "id": "b7f98f4d-f333-4b55-8cd2-77f1f7f56810", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts/:account_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid" ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" }, { "key": "account_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"account\": {\n \"account_number\": \"\",\n \"account_ownership\": null,\n \"annuity_policy_to_date\": \"\",\n \"annuity_provider\": \"\",\n \"annuity_term_year\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"available_credit\": \"\",\n \"balance\": \"\",\n \"cash_balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"created_at\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"day_payment_is_due\": \"\",\n \"death_benefit\": \"\",\n \"federal_insurance_status\": \"NOT_INSURED\",\n \"guid\": \"\",\n \"id\": \"\",\n \"imported_at\": \"\",\n \"interest_rate\": \"\",\n \"institution_code\": \"\",\n \"insured_name\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"is_manual\": \"\",\n \"last_payment\": \"\",\n \"last_payment_at\": \"\",\n \"loan_amount\": \"\",\n \"margin_balance\": \"\",\n \"matures_on\": \"\",\n \"member_guid\": \"\",\n \"member_id\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"metadata\": \"\",\n \"minimum_balance\": \"\",\n \"minimum_payment\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"pay_out_amount\": \"\",\n \"payment_due_at\": \"\",\n \"payoff_balance\": \"\",\n \"premium_amount\": \"\",\n \"property_type\": \"FURNITURE\",\n \"routing_number\": \"\",\n \"started_on\": \"\",\n \"statement_balance\": \"\",\n \"subtype\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_account_value\": \"\",\n \"total_account_value_ugl\": \"\",\n \"type\": \"PROPERTY\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b7f98f4d-f333-4b55-8cd2-77f1f7f56810" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-5f41f39e-932c-45cc-80b2-8d24b3293465" }, { "name": "Update managed account", "id": "c1d357c0-d612-4fca-a0cb-3e9a117ffe38", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts/:account_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid" ], "variable": [ { "id": "9a0fea1e-01b1-4005-ace5-c00e57169d5f", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "7f7fc284-1369-47a8-8d28-3f15c2e159dc", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." }, { "id": "0a2b1d8b-4fbe-4a25-bf10-584eccddd26b", "key": "account_guid", "value": "", "description": "(Required) The unique id for an `account`." } ] }, "description": "Use this endpoint to update the attributes of a partner-managed account according to its unique GUID.\n\nThis endpoint has been deprecated. For more information, reference the [Migration guide](/api-reference/platform-api/overview/migration).\n\n" }, "response": [ { "id": "a19e32a7-dddd-4ec2-b910-29a893553d34", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts/:account_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts", ":account_guid" ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" }, { "key": "account_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"account\": {\n \"account_number\": \"\",\n \"account_ownership\": null,\n \"annuity_policy_to_date\": \"\",\n \"annuity_provider\": \"\",\n \"annuity_term_year\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"available_credit\": \"\",\n \"balance\": \"\",\n \"cash_balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"created_at\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"day_payment_is_due\": \"\",\n \"death_benefit\": \"\",\n \"federal_insurance_status\": \"NOT_INSURED\",\n \"guid\": \"\",\n \"id\": \"\",\n \"imported_at\": \"\",\n \"interest_rate\": \"\",\n \"institution_code\": \"\",\n \"insured_name\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"is_manual\": \"\",\n \"last_payment\": \"\",\n \"last_payment_at\": \"\",\n \"loan_amount\": \"\",\n \"margin_balance\": \"\",\n \"matures_on\": \"\",\n \"member_guid\": \"\",\n \"member_id\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"metadata\": \"\",\n \"minimum_balance\": \"\",\n \"minimum_payment\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"pay_out_amount\": \"\",\n \"payment_due_at\": \"\",\n \"payoff_balance\": \"\",\n \"premium_amount\": \"\",\n \"property_type\": \"FURNITURE\",\n \"routing_number\": \"\",\n \"started_on\": \"\",\n \"statement_balance\": \"\",\n \"subtype\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_account_value\": \"\",\n \"total_account_value_ugl\": \"\",\n \"type\": \"PROPERTY\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-a19e32a7-dddd-4ec2-b910-29a893553d34" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-c1d357c0-d612-4fca-a0cb-3e9a117ffe38" } ], "id": "6a4aa643-310d-4903-98ef-235102b0ea0a", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6a4aa643-310d-4903-98ef-235102b0ea0a" }, { "name": "List managed accounts", "id": "64cf7907-7e30-4506-a33e-0da439ccb001", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "bcd3cacf-7666-4d84-a9e0-b8df19c6bb83", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "f6c7ab6e-a04f-4d98-85f8-ba2f5f6e9e3f", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." } ] }, "description": "Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-managed member.\n\nThis endpoint has been deprecated. For more information, reference the [Migration guide](/api-reference/platform-api/overview/migration).\n\n" }, "response": [ { "id": "aea275ce-c47e-4e29-addf-ab3b79c7d899", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"accounts\": [\n {\n \"account_number\": \"\",\n \"account_ownership\": \"JOINT\",\n \"annuity_policy_to_date\": \"\",\n \"annuity_provider\": \"\",\n \"annuity_term_year\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"available_credit\": \"\",\n \"balance\": \"\",\n \"cash_balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"created_at\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"day_payment_is_due\": \"\",\n \"death_benefit\": \"\",\n \"federal_insurance_status\": \"UNKNOWN_INSURED\",\n \"guid\": \"\",\n \"id\": \"\",\n \"imported_at\": \"\",\n \"interest_rate\": \"\",\n \"institution_code\": \"\",\n \"insured_name\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"is_manual\": \"\",\n \"last_payment\": \"\",\n \"last_payment_at\": \"\",\n \"loan_amount\": \"\",\n \"margin_balance\": \"\",\n \"matures_on\": \"\",\n \"member_guid\": \"\",\n \"member_id\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"metadata\": \"\",\n \"minimum_balance\": \"\",\n \"minimum_payment\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"pay_out_amount\": \"\",\n \"payment_due_at\": \"\",\n \"payoff_balance\": \"\",\n \"premium_amount\": \"\",\n \"property_type\": \"REAL_ESTATE\",\n \"routing_number\": \"\",\n \"started_on\": \"\",\n \"statement_balance\": \"\",\n \"subtype\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_account_value\": \"\",\n \"total_account_value_ugl\": \"\",\n \"type\": \"LOAN\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n },\n {\n \"account_number\": \"\",\n \"account_ownership\": \"MULTIPLE\",\n \"annuity_policy_to_date\": \"\",\n \"annuity_provider\": \"\",\n \"annuity_term_year\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"available_credit\": \"\",\n \"balance\": \"\",\n \"cash_balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"created_at\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"day_payment_is_due\": \"\",\n \"death_benefit\": \"\",\n \"federal_insurance_status\": \"NOT_INSURED\",\n \"guid\": \"\",\n \"id\": \"\",\n \"imported_at\": \"\",\n \"interest_rate\": \"\",\n \"institution_code\": \"\",\n \"insured_name\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"is_manual\": \"\",\n \"last_payment\": \"\",\n \"last_payment_at\": \"\",\n \"loan_amount\": \"\",\n \"margin_balance\": \"\",\n \"matures_on\": \"\",\n \"member_guid\": \"\",\n \"member_id\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"metadata\": \"\",\n \"minimum_balance\": \"\",\n \"minimum_payment\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"pay_out_amount\": \"\",\n \"payment_due_at\": \"\",\n \"payoff_balance\": \"\",\n \"premium_amount\": \"\",\n \"property_type\": \"SPORTS_EQUIPMENT\",\n \"routing_number\": \"\",\n \"started_on\": \"\",\n \"statement_balance\": \"\",\n \"subtype\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_account_value\": \"\",\n \"total_account_value_ugl\": \"\",\n \"type\": \"INSURANCE\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-aea275ce-c47e-4e29-addf-ab3b79c7d899" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-64cf7907-7e30-4506-a33e-0da439ccb001" }, { "name": "Create managed account", "id": "18bb74e7-198c-4f71-a1f6-1ad993f44e1e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts" ], "variable": [ { "id": "31902b87-bbb3-4383-bbd5-b0bb7102bf25", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "c279c2ea-5ae6-428a-9622-8bf3f71223a9", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." } ] }, "description": "Use this endpoint to create a partner-managed account.\n\nThis endpoint has been deprecated. For more information, reference the [Migration guide](/api-reference/platform-api/overview/migration).\n\n" }, "response": [ { "id": "2b4439cb-c6b9-4eba-a96a-ad5f36bd3604", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid/accounts", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid", "accounts" ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"account\": {\n \"account_number\": \"\",\n \"account_ownership\": null,\n \"annuity_policy_to_date\": \"\",\n \"annuity_provider\": \"\",\n \"annuity_term_year\": \"\",\n \"apr\": \"\",\n \"apy\": \"\",\n \"available_balance\": \"\",\n \"available_credit\": \"\",\n \"balance\": \"\",\n \"cash_balance\": \"\",\n \"cash_surrender_value\": \"\",\n \"created_at\": \"\",\n \"credit_limit\": \"\",\n \"currency_code\": \"\",\n \"day_payment_is_due\": \"\",\n \"death_benefit\": \"\",\n \"federal_insurance_status\": \"NOT_INSURED\",\n \"guid\": \"\",\n \"id\": \"\",\n \"imported_at\": \"\",\n \"interest_rate\": \"\",\n \"institution_code\": \"\",\n \"insured_name\": \"\",\n \"is_closed\": \"\",\n \"is_hidden\": \"\",\n \"is_manual\": \"\",\n \"last_payment\": \"\",\n \"last_payment_at\": \"\",\n \"loan_amount\": \"\",\n \"margin_balance\": \"\",\n \"matures_on\": \"\",\n \"member_guid\": \"\",\n \"member_id\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"metadata\": \"\",\n \"minimum_balance\": \"\",\n \"minimum_payment\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"original_balance\": \"\",\n \"pay_out_amount\": \"\",\n \"payment_due_at\": \"\",\n \"payoff_balance\": \"\",\n \"premium_amount\": \"\",\n \"property_type\": \"FURNITURE\",\n \"routing_number\": \"\",\n \"started_on\": \"\",\n \"statement_balance\": \"\",\n \"subtype\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_account_value\": \"\",\n \"total_account_value_ugl\": \"\",\n \"type\": \"PROPERTY\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-2b4439cb-c6b9-4eba-a96a-ad5f36bd3604" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-18bb74e7-198c-4f71-a1f6-1ad993f44e1e" } ], "id": "40288f73-b80a-450d-a0f6-023d9fac9241", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-40288f73-b80a-450d-a0f6-023d9fac9241" }, { "name": "Delete managed member", "id": "ca9dd7a1-2014-48b2-92be-7f3276bdaaf7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid" ], "variable": [ { "id": "93b1dc51-051b-4976-b72f-5bee57464264", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "2355fb5b-995c-4224-94fa-99923619482c", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." } ] }, "description": "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\nThis endpoint has been deprecated. For more information, reference the [Migration guide](/api-reference/platform-api/overview/migration).\n\n" }, "response": [ { "id": "21776545-d12b-4ae1-bea7-17a1a21b52bc", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid" ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-21776545-d12b-4ae1-bea7-17a1a21b52bc" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-ca9dd7a1-2014-48b2-92be-7f3276bdaaf7" }, { "name": "Read managed member", "id": "0cbf0407-ef79-474d-a56c-40157affdf83", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid" ], "variable": [ { "id": "3e57885b-3eff-4ea1-9996-a8c64b34dd4d", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "09b66bdb-12fe-4f15-b6d4-723f2c3ce598", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." } ] }, "description": "This endpoint returns the attributes of the specified partner-managed`member`.\n\nThis endpoint has been deprecated. For more information, reference the [Migration guide](/api-reference/platform-api/overview/migration).\n\n" }, "response": [ { "id": "7a894533-64fa-4694-bf28-a4a32033b401", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid" ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"PREVENTED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-7a894533-64fa-4694-bf28-a4a32033b401" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-0cbf0407-ef79-474d-a56c-40157affdf83" }, { "name": "Update managed member", "id": "e32bde9e-ce0f-47e4-a6af-f85eefc05c17", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"member\": {\n \"id\": \"\",\n \"metadata\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid" ], "variable": [ { "id": "764cdd26-8ebb-4cf0-8a06-919401f5cc3c", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "e9ac759c-897c-4d23-a62f-5f09c1c8d260", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." } ] }, "description": "Use this endpoint to update the attributes of the specified partner_managed `member`.\n\nThis endpoint has been deprecated. For more information, reference the [Migration guide](/api-reference/platform-api/overview/migration).\n\n" }, "response": [ { "id": "60e22345-a7e3-4299-be77-34a030625af0", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"member\": {\n \"id\": \"\",\n \"metadata\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members/:member_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members", ":member_guid" ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"PREVENTED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-60e22345-a7e3-4299-be77-34a030625af0" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e32bde9e-ce0f-47e4-a6af-f85eefc05c17" } ], "id": "106c9386-e9d6-43c6-9595-5fcae5ed0590", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-106c9386-e9d6-43c6-9595-5fcae5ed0590" }, { "name": "List managed members", "id": "aa8656bd-33df-4b9e-b154-e1dc3bc6317f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "56febe53-7146-4f23-a609-94dccbd2b739", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "This endpoint returns a list of all the partner-managed members associated with the specified `user`.\n\nThis endpoint has been deprecated. For more information, reference the [Migration guide](/api-reference/platform-api/overview/migration).\n\n" }, "response": [ { "id": "cadbe531-3265-44d5-b3d6-333af27da3ff", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"members\": [\n {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"CREATED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n },\n {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"FAILED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"MONEY_MOVEMENT\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-cadbe531-3265-44d5-b3d6-333af27da3ff" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-aa8656bd-33df-4b9e-b154-e1dc3bc6317f" }, { "name": "Create managed member", "id": "47b51e0e-b114-4548-8c3c-2cd11d22ecb5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"member\": {\n \"institution_code\": \"\",\n \"id\": \"\",\n \"metadata\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members" ], "variable": [ { "id": "e3787e10-b4fe-4e9a-b258-e0a9e38cbd0e", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "Use this endpoint to create a new partner-managed `member`.\n\nThis endpoint has been deprecated. For more information, reference the [Migration guide](/api-reference/platform-api/overview/migration).\n\n" }, "response": [ { "id": "726c78c1-d3b2-4a88-a84b-6304545d085f", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"member\": {\n \"institution_code\": \"\",\n \"id\": \"\",\n \"metadata\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/managed_members", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "managed_members" ], "variable": [ { "key": "user_guid" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"PREVENTED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-726c78c1-d3b2-4a88-a84b-6304545d085f" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-47b51e0e-b114-4548-8c3c-2cd11d22ecb5" } ], "id": "bd5baeee-d4a7-49a5-8252-e0a4290f1959", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-bd5baeee-d4a7-49a5-8252-e0a4290f1959" }, { "name": "members", "item": [ { "name": "{member_guid}", "item": [ { "name": "account_numbers", "item": [ { "name": "List account numbers by member", "id": "571fb602-5b6b-43b8-a03f-faca5aba1692", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/members/:member_guid/account_numbers?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "members", ":member_guid", "account_numbers" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "f72f3853-49c7-4586-adae-5652ca9fb697", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "91a299d4-975b-468a-bd45-cbcf329bf664", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." } ] }, "description": "This endpoint returns a list of account numbers associated with the specified `member`." }, "response": [ { "id": "c342bd12-514a-4298-8351-dc3ab403bae2", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/members/:member_guid/account_numbers?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "members", ":member_guid", "account_numbers" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"account_numbers\": [\n {\n \"account_guid\": \"\",\n \"account_number\": \"\",\n \"guid\": \"\",\n \"institution_number\": \"\",\n \"loan_guarantor\": \"\",\n \"loan_reference_number\": \"\",\n \"member_guid\": \"\",\n \"passed_validation\": \"\",\n \"routing_number\": \"\",\n \"sequence_number\": \"\",\n \"transit_number\": \"\",\n \"user_guid\": \"\"\n },\n {\n \"account_guid\": \"\",\n \"account_number\": \"\",\n \"guid\": \"\",\n \"institution_number\": \"\",\n \"loan_guarantor\": \"\",\n \"loan_reference_number\": \"\",\n \"member_guid\": \"\",\n \"passed_validation\": \"\",\n \"routing_number\": \"\",\n \"sequence_number\": \"\",\n \"transit_number\": \"\",\n \"user_guid\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-c342bd12-514a-4298-8351-dc3ab403bae2" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-571fb602-5b6b-43b8-a03f-faca5aba1692" } ], "id": "46ad87a2-0ccd-4cad-a09f-370985a4558e", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-46ad87a2-0ccd-4cad-a09f-370985a4558e" }, { "name": "investment_holdings", "item": [ { "name": "List holdings by member", "id": "41337b92-1af5-4869-8597-4502b0544090", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/members/:member_guid/investment_holdings?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "members", ":member_guid", "investment_holdings" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "ce930846-33a4-4f29-9446-393ef8c3b942", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "1912b4d0-70a2-4c00-a09b-2b62ed8dc1ea", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." } ] }, "description": "This endpoint lists all holdings associated with the specified member." }, "response": [ { "id": "55bf0d79-168e-4ab5-89f0-1dc45f508e66", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/members/:member_guid/investment_holdings?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "members", ":member_guid", "investment_holdings" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"investment_holdings\": [\n {\n \"account_guid\": \"\",\n \"cost_basis\": \"\",\n \"coupon_yield\": \"\",\n \"currency_code\": \"\",\n \"current_price\": \"\",\n \"daily_change\": \"\",\n \"description\": \"\",\n \"expiration\": \"\",\n \"face_value\": \"\",\n \"frequency\": \"\",\n \"guid\": \"\",\n \"market_value\": \"\",\n \"maturity_date\": \"\",\n \"percentage_change\": \"\",\n \"purchase_price\": \"\",\n \"quantity\": \"\",\n \"rate\": \"\",\n \"strike_price\": \"\",\n \"symbol\": \"\",\n \"term\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_ugl_amount\": \"\",\n \"total_ugl_percentage\": \"\",\n \"unvested_quantity\": \"\",\n \"unvested_value\": \"\",\n \"user_guid\": \"\",\n \"vested_quantity\": \"\",\n \"vested_value\": \"\",\n \"created_at\": \"\",\n \"current_price_as_of\": \"\",\n \"issue_date\": \"\",\n \"vesting_start_date\": \"\",\n \"vesting_end_date\": \"\",\n \"put_or_call\": \"\",\n \"holding_type\": \"\",\n \"term_unit\": \"\"\n },\n {\n \"account_guid\": \"\",\n \"cost_basis\": \"\",\n \"coupon_yield\": \"\",\n \"currency_code\": \"\",\n \"current_price\": \"\",\n \"daily_change\": \"\",\n \"description\": \"\",\n \"expiration\": \"\",\n \"face_value\": \"\",\n \"frequency\": \"\",\n \"guid\": \"\",\n \"market_value\": \"\",\n \"maturity_date\": \"\",\n \"percentage_change\": \"\",\n \"purchase_price\": \"\",\n \"quantity\": \"\",\n \"rate\": \"\",\n \"strike_price\": \"\",\n \"symbol\": \"\",\n \"term\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_ugl_amount\": \"\",\n \"total_ugl_percentage\": \"\",\n \"unvested_quantity\": \"\",\n \"unvested_value\": \"\",\n \"user_guid\": \"\",\n \"vested_quantity\": \"\",\n \"vested_value\": \"\",\n \"created_at\": \"\",\n \"current_price_as_of\": \"\",\n \"issue_date\": \"\",\n \"vesting_start_date\": \"\",\n \"vesting_end_date\": \"\",\n \"put_or_call\": \"\",\n \"holding_type\": \"\",\n \"term_unit\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-55bf0d79-168e-4ab5-89f0-1dc45f508e66" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-41337b92-1af5-4869-8597-4502b0544090" } ], "id": "eae43967-5037-4ef8-a4a1-5adb77016b0f", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-eae43967-5037-4ef8-a4a1-5adb77016b0f" }, { "name": "statements", "item": [ { "name": "{statement_guid}", "item": [ { "name": "Read statement by member", "id": "bbc8b8b5-111a-4fea-afe6-20ac944e10d9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/members/:member_guid/statements/:statement_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "members", ":member_guid", "statements", ":statement_guid" ], "variable": [ { "id": "ddb403f4-7f37-44ef-9547-f9316f5843b0", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "0011427f-ede2-4b66-9963-135b8c74fe76", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." }, { "id": "7f5716de-ce2a-4da8-8b7e-c8290e85923b", "key": "statement_guid", "value": "", "description": "(Required) The unique id for a `statement`." } ] }, "description": "Use this endpoint to read a JSON representation of the statement." }, "response": [ { "id": "c71baa81-68d2-4a4f-81cc-b2a8b5a05230", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/members/:member_guid/statements/:statement_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "members", ":member_guid", "statements", ":statement_guid" ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" }, { "key": "statement_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statement\": {\n \"account_guid\": \"\",\n \"content_hash\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"member_guid\": \"\",\n \"updated_at\": \"\",\n \"uri\": \"\",\n \"user_guid\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-c71baa81-68d2-4a4f-81cc-b2a8b5a05230" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-bbc8b8b5-111a-4fea-afe6-20ac944e10d9" } ], "id": "75a946b9-33d8-4868-9f88-008b0c1b4e79", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-75a946b9-33d8-4868-9f88-008b0c1b4e79" }, { "name": "{statement_guid}.pdf", "item": [ { "name": "Download statement pdf", "id": "b8887bdd-61e8-4e3b-8fa1-1a617d388f86", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/vnd.mx.api.v1+pdf" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/members/:member_guid/statements/{{statement_guid}}.pdf", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "members", ":member_guid", "statements", "{{statement_guid}}.pdf" ], "variable": [ { "id": "61b5f191-9214-4b17-9bae-bb4f68dbfc19", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "61ab7451-7e5c-49f8-939b-65662eabaa46", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." } ] }, "description": "Use this endpoint to download a specified statement PDF." }, "response": [ { "id": "2ce0a5db-0a1c-417f-99b3-b0717dc6e80b", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/vnd.mx.api.v1+pdf" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/members/:member_guid/statements/{{statement_guid}}.pdf", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "members", ":member_guid", "statements", "{{statement_guid}}.pdf" ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/vnd.mx.api.v1+pdf" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-2ce0a5db-0a1c-417f-99b3-b0717dc6e80b" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b8887bdd-61e8-4e3b-8fa1-1a617d388f86" } ], "id": "628c68fc-79ef-4bd6-8547-b5d8ce9bc58c", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-628c68fc-79ef-4bd6-8547-b5d8ce9bc58c" }, { "name": "List statements by member", "id": "2f540671-2a43-40f3-a0e2-f01b44661890", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/members/:member_guid/statements?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "members", ":member_guid", "statements" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "2f2e3242-a910-4946-b0b2-9d1dfaf7f027", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "e69674e4-fc97-4c71-baf5-47270fef556c", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." } ] }, "description": "Use this endpoint to get an array of available statements." }, "response": [ { "id": "b7a4bc4d-cdc7-4f28-abaa-8fa4a1c2f896", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/members/:member_guid/statements?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "members", ":member_guid", "statements" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statements\": [\n {\n \"account_guid\": \"\",\n \"content_hash\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"member_guid\": \"\",\n \"updated_at\": \"\",\n \"uri\": \"\",\n \"user_guid\": \"\"\n },\n {\n \"account_guid\": \"\",\n \"content_hash\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"member_guid\": \"\",\n \"updated_at\": \"\",\n \"uri\": \"\",\n \"user_guid\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b7a4bc4d-cdc7-4f28-abaa-8fa4a1c2f896" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-2f540671-2a43-40f3-a0e2-f01b44661890" } ], "id": "3a000ebe-1204-4098-a833-010c61ab6ec0", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-3a000ebe-1204-4098-a833-010c61ab6ec0" }, { "name": "rewards", "item": [ { "name": "{reward_guid}", "item": [ { "name": "Read Reward", "id": "d6c7a742-438f-41f6-9da1-7cca6f896aeb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/members/:member_guid/rewards/:reward_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "members", ":member_guid", "rewards", ":reward_guid" ], "variable": [ { "id": "f93a6933-6e79-41ed-b849-cf64a3383c49", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "2b3bc4a1-0345-455f-81f2-a78e417fcdb9", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." }, { "id": "9377a59c-e410-4654-807a-305cda446dcf", "key": "reward_guid", "value": "", "description": "(Required) The unique identifier for the rewards. Defined by MX." } ] }, "description": "Use this endpoint to read a specific `reward` based on its unique GUID. Member and Rewards guids are defined by MX." }, "response": [ { "id": "21a6cd7d-89ab-472a-8a0c-0909615cde3b", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/members/:member_guid/rewards/:reward_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "members", ":member_guid", "rewards", ":reward_guid" ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" }, { "key": "reward_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"reward\": {\n \"account_guid\": \"\",\n \"member_guid\": \"\",\n \"user_guid\": \"\",\n \"balance_type\": \"\",\n \"balance\": \"\",\n \"created_at\": \"\",\n \"description\": \"\",\n \"expires_on\": \"\",\n \"guid\": \"\",\n \"unit_type\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-21a6cd7d-89ab-472a-8a0c-0909615cde3b" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d6c7a742-438f-41f6-9da1-7cca6f896aeb" } ], "id": "ec0be152-52e4-49fb-bad1-ea349257dd51", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-ec0be152-52e4-49fb-bad1-ea349257dd51" }, { "name": "List Rewards", "id": "e711dc9c-e66d-4f1f-856d-772fe0949888", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/members/:member_guid/rewards", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "members", ":member_guid", "rewards" ], "variable": [ { "id": "b6561af6-f46a-4a2e-bc41-4329b1d05247", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "86e05976-c97c-495e-8ed1-d9dd1f9c8971", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." } ] }, "description": "Use this endpoint to list all the `rewards` associated with a specified `member`. Member guids are defined by MX." }, "response": [ { "id": "b61c0180-3729-4bd5-a730-89bd89a84d08", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/members/:member_guid/rewards", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "members", ":member_guid", "rewards" ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"rewards\": [\n {\n \"account_guid\": \"\",\n \"member_guid\": \"\",\n \"user_guid\": \"\",\n \"balance_type\": \"\",\n \"balance\": \"\",\n \"created_at\": \"\",\n \"description\": \"\",\n \"expires_on\": \"\",\n \"guid\": \"\",\n \"unit_type\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"account_guid\": \"\",\n \"member_guid\": \"\",\n \"user_guid\": \"\",\n \"balance_type\": \"\",\n \"balance\": \"\",\n \"created_at\": \"\",\n \"description\": \"\",\n \"expires_on\": \"\",\n \"guid\": \"\",\n \"unit_type\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b61c0180-3729-4bd5-a730-89bd89a84d08" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e711dc9c-e66d-4f1f-856d-772fe0949888" } ], "id": "ad7643ec-fe5e-4dc4-bf72-64dd8283707a", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-ad7643ec-fe5e-4dc4-bf72-64dd8283707a" } ], "id": "ad0ff04e-e842-4c19-a24d-13ced1170fd2", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-ad0ff04e-e842-4c19-a24d-13ced1170fd2" } ], "id": "36bb34c9-2c67-4142-ae86-38a04e7a0e87", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-36bb34c9-2c67-4142-ae86-38a04e7a0e87" }, { "name": "investment_holdings", "item": [ { "name": "{holding_guid}", "item": [ { "name": "Read holding", "id": "32fbeaeb-b9ba-4ba3-ba46-4c66979d7acb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/investment_holdings/:holding_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "investment_holdings", ":holding_guid" ], "variable": [ { "id": "71e36824-7fdf-4617-ab9b-9057be7be30b", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "64a7991a-3dc7-471d-8abc-f5a5f85ac9b3", "key": "holding_guid", "value": "", "description": "(Required) The unique id for a `holding`." } ] }, "description": "Use this endpoint to read the attributes of a specific `holding`." }, "response": [ { "id": "01188a10-aaad-4629-a69c-97647e27e951", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/investment_holdings/:holding_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "investment_holdings", ":holding_guid" ], "variable": [ { "key": "user_guid" }, { "key": "holding_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"investment_holding\": {\n \"account_guid\": \"\",\n \"cost_basis\": \"\",\n \"coupon_yield\": \"\",\n \"currency_code\": \"\",\n \"current_price\": \"\",\n \"daily_change\": \"\",\n \"description\": \"\",\n \"expiration\": \"\",\n \"face_value\": \"\",\n \"frequency\": \"\",\n \"guid\": \"\",\n \"market_value\": \"\",\n \"maturity_date\": \"\",\n \"percentage_change\": \"\",\n \"purchase_price\": \"\",\n \"quantity\": \"\",\n \"rate\": \"\",\n \"strike_price\": \"\",\n \"symbol\": \"\",\n \"term\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_ugl_amount\": \"\",\n \"total_ugl_percentage\": \"\",\n \"unvested_quantity\": \"\",\n \"unvested_value\": \"\",\n \"user_guid\": \"\",\n \"vested_quantity\": \"\",\n \"vested_value\": \"\",\n \"created_at\": \"\",\n \"current_price_as_of\": \"\",\n \"issue_date\": \"\",\n \"vesting_start_date\": \"\",\n \"vesting_end_date\": \"\",\n \"put_or_call\": \"\",\n \"holding_type\": \"\",\n \"term_unit\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-01188a10-aaad-4629-a69c-97647e27e951" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-32fbeaeb-b9ba-4ba3-ba46-4c66979d7acb" } ], "id": "9ba3f590-dd47-4e47-891a-c3591ac5fd22", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-9ba3f590-dd47-4e47-891a-c3591ac5fd22" }, { "name": "List holdings by user", "id": "6ee6e06d-c2eb-4c0f-b542-63527156e039", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/investment_holdings?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "investment_holdings" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "1fb85701-e429-4efe-a3d0-4736e59ec0a7", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "This endpoint lists all holdings associated with the user across all accounts." }, "response": [ { "id": "9f172ced-413f-42fd-8048-7184545991f6", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/investment_holdings?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "investment_holdings" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"investment_holdings\": [\n {\n \"account_guid\": \"\",\n \"cost_basis\": \"\",\n \"coupon_yield\": \"\",\n \"currency_code\": \"\",\n \"current_price\": \"\",\n \"daily_change\": \"\",\n \"description\": \"\",\n \"expiration\": \"\",\n \"face_value\": \"\",\n \"frequency\": \"\",\n \"guid\": \"\",\n \"market_value\": \"\",\n \"maturity_date\": \"\",\n \"percentage_change\": \"\",\n \"purchase_price\": \"\",\n \"quantity\": \"\",\n \"rate\": \"\",\n \"strike_price\": \"\",\n \"symbol\": \"\",\n \"term\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_ugl_amount\": \"\",\n \"total_ugl_percentage\": \"\",\n \"unvested_quantity\": \"\",\n \"unvested_value\": \"\",\n \"user_guid\": \"\",\n \"vested_quantity\": \"\",\n \"vested_value\": \"\",\n \"created_at\": \"\",\n \"current_price_as_of\": \"\",\n \"issue_date\": \"\",\n \"vesting_start_date\": \"\",\n \"vesting_end_date\": \"\",\n \"put_or_call\": \"\",\n \"holding_type\": \"\",\n \"term_unit\": \"\"\n },\n {\n \"account_guid\": \"\",\n \"cost_basis\": \"\",\n \"coupon_yield\": \"\",\n \"currency_code\": \"\",\n \"current_price\": \"\",\n \"daily_change\": \"\",\n \"description\": \"\",\n \"expiration\": \"\",\n \"face_value\": \"\",\n \"frequency\": \"\",\n \"guid\": \"\",\n \"market_value\": \"\",\n \"maturity_date\": \"\",\n \"percentage_change\": \"\",\n \"purchase_price\": \"\",\n \"quantity\": \"\",\n \"rate\": \"\",\n \"strike_price\": \"\",\n \"symbol\": \"\",\n \"term\": \"\",\n \"today_ugl_amount\": \"\",\n \"today_ugl_percentage\": \"\",\n \"total_ugl_amount\": \"\",\n \"total_ugl_percentage\": \"\",\n \"unvested_quantity\": \"\",\n \"unvested_value\": \"\",\n \"user_guid\": \"\",\n \"vested_quantity\": \"\",\n \"vested_value\": \"\",\n \"created_at\": \"\",\n \"current_price_as_of\": \"\",\n \"issue_date\": \"\",\n \"vesting_start_date\": \"\",\n \"vesting_end_date\": \"\",\n \"put_or_call\": \"\",\n \"holding_type\": \"\",\n \"term_unit\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-9f172ced-413f-42fd-8048-7184545991f6" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6ee6e06d-c2eb-4c0f-b542-63527156e039" } ], "id": "f7281384-615d-40dc-815c-74d52f8e0487", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-f7281384-615d-40dc-815c-74d52f8e0487" }, { "name": "investment_holdings_deactivate", "item": [ { "name": "Deactivate user from Investment Holdings", "id": "fc7d2da0-0d96-439d-8f08-d4b31645404d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/investment_holdings_deactivate", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "investment_holdings_deactivate" ], "variable": [ { "id": "a7fe62de-dacf-41ea-8517-95d45c93be2e", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "This endpoint deactivates the specific user from the `/investment_holdings` product. To reactivate a user, use any of the current `/investment_holding` endpoints." }, "response": [ { "id": "e59b9c43-232b-47d0-bc20-b120e6d68a5a", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/investment_holdings_deactivate", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "investment_holdings_deactivate" ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": {\n \"example\": \"Successfully deactivated user from billing\"\n },\n \"status\": {\n \"example\": 200\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e59b9c43-232b-47d0-bc20-b120e6d68a5a" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-fc7d2da0-0d96-439d-8f08-d4b31645404d" } ], "id": "a02e2321-aa6a-4ccc-a719-208c2f691d22", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-a02e2321-aa6a-4ccc-a719-208c2f691d22" }, { "name": "spending_plans", "item": [ { "name": "{spending_plan_guid}", "item": [ { "name": "iterations", "item": [ { "name": "current", "item": [ { "name": "iteration_items", "item": [ { "name": "{iteration_item_guid}", "item": [ { "name": "Delete spending plan iteration item", "id": "0bf00cdb-27a2-4514-84cd-c773c0d0a160", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items/:iteration_item_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items", ":iteration_item_guid" ], "variable": [ { "id": "26629997-ecec-4dfb-b925-cad969acee8a", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "a24346ad-a8b5-4073-98d8-ec2a947ecf08", "key": "spending_plan_guid", "value": "", "description": "(Required) The unique ID for the `spending_plan`." }, { "id": "0f5703e1-5f75-4700-bc38-a5f7707ea251", "key": "iteration_item_guid", "value": "", "description": "(Required) The unique ID for the `iteration_item`." } ] }, "description": "Use this endpoint to delete a spending plan `iteration_item`." }, "response": [ { "id": "aa9e366e-e660-46dd-9a0c-a9f18da56531", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items/:iteration_item_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items", ":iteration_item_guid" ], "variable": [ { "key": "user_guid" }, { "key": "spending_plan_guid" }, { "key": "iteration_item_guid" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-aa9e366e-e660-46dd-9a0c-a9f18da56531" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-0bf00cdb-27a2-4514-84cd-c773c0d0a160" }, { "name": "Read a spending plan iteration item", "id": "5b64dcbd-44f0-4608-a719-b3f7eda1a228", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items/:iteration_item_guid?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items", ":iteration_item_guid" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "ec0e200c-eb8d-4e5b-957f-0b4f38f06688", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "aecf04bb-4c6d-45ff-bb47-068473de6077", "key": "spending_plan_guid", "value": "", "description": "(Required) The unique ID for the `spending_plan`." }, { "id": "4ec0bc74-d715-484f-b06a-9bbaee81f0d2", "key": "iteration_item_guid", "value": "", "description": "(Required) The unique ID for the `iteration_item`." } ] }, "description": "Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID." }, "response": [ { "id": "42a78318-cdd3-48cb-b276-b2aa7f6c7b21", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items/:iteration_item_guid?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items", ":iteration_item_guid" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "spending_plan_guid" }, { "key": "iteration_item_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"actual_amount\": \"\",\n \"category_guid\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"item_type\": 2,\n \"planned_amount\": \"\",\n \"scheduled_payment_guid\": \"\",\n \"spending_plan_iteration_guid\": \"\",\n \"top_level_category_guid\": \"\",\n \"transaction_guids\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-42a78318-cdd3-48cb-b276-b2aa7f6c7b21" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-5b64dcbd-44f0-4608-a719-b3f7eda1a228" }, { "name": "Update a spending plan iteration item", "id": "502eb0a2-2bf1-4445-ad52-82500df200d9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items/:iteration_item_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items", ":iteration_item_guid" ], "variable": [ { "id": "f8eb143c-d122-4c6a-ace2-18bf1f45c99e", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "b1ac8313-481f-45c5-a6dc-2ecce17f9bbe", "key": "spending_plan_guid", "value": "", "description": "(Required) The unique ID for the `spending_plan`." }, { "id": "c0c98e20-3349-4421-9281-936fcfa1ea37", "key": "iteration_item_guid", "value": "", "description": "(Required) The unique ID for the `iteration_item`." } ] }, "description": "Use this endpoint to update an existing `spending_plan_iteration_item`." }, "response": [ { "id": "b66f8034-306c-43ba-89e6-33aa11d813ae", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items/:iteration_item_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items", ":iteration_item_guid" ], "variable": [ { "key": "user_guid" }, { "key": "spending_plan_guid" }, { "key": "iteration_item_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"actual_amount\": \"\",\n \"category_guid\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"item_type\": 2,\n \"planned_amount\": \"\",\n \"scheduled_payment_guid\": \"\",\n \"spending_plan_iteration_guid\": \"\",\n \"top_level_category_guid\": \"\",\n \"transaction_guids\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b66f8034-306c-43ba-89e6-33aa11d813ae" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-502eb0a2-2bf1-4445-ad52-82500df200d9" } ], "id": "14f5b597-7ae9-46fa-b2cf-89cb950a3347", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-14f5b597-7ae9-46fa-b2cf-89cb950a3347" }, { "name": "Create spending plan iteration item", "id": "9f18993e-d44a-4615-b5fd-6fc434ee616e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items" ], "variable": [ { "id": "ee411a3f-5e3e-4322-ac37-29fc1c42b0d7", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "486b6c0e-2b2f-4b41-b16e-a82c105a8282", "key": "spending_plan_guid", "value": "", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "description": "This endpoint creates a new `spending_plan_iteration_item`." }, "response": [ { "id": "8abb2642-4dba-4d4c-830f-220a2a5dc5bf", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items" ], "variable": [ { "key": "user_guid" }, { "key": "spending_plan_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"actual_amount\": \"\",\n \"category_guid\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"item_type\": 2,\n \"planned_amount\": \"\",\n \"scheduled_payment_guid\": \"\",\n \"spending_plan_iteration_guid\": \"\",\n \"top_level_category_guid\": \"\",\n \"transaction_guids\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-8abb2642-4dba-4d4c-830f-220a2a5dc5bf" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-9f18993e-d44a-4615-b5fd-6fc434ee616e" }, { "name": "List spending plan iteration items", "id": "b0c524d0-4a03-468a-9429-bc9c4e77eb4b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "7b64875c-2321-4819-9522-a7b00c542477", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "8202b8b3-3f85-48cd-bc83-c6023145e389", "key": "spending_plan_guid", "value": "", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "description": "Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`." }, "response": [ { "id": "5a3d5455-4c98-41a5-b501-37792127fa09", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current", "iteration_items" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "spending_plan_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"iteration_items\": [\n {\n \"actual_amount\": \"\",\n \"category_guid\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"item_type\": 0,\n \"planned_amount\": \"\",\n \"scheduled_payment_guid\": \"\",\n \"spending_plan_iteration_guid\": \"\",\n \"top_level_category_guid\": \"\",\n \"transaction_guids\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n },\n {\n \"actual_amount\": \"\",\n \"category_guid\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"item_type\": 2,\n \"planned_amount\": \"\",\n \"scheduled_payment_guid\": \"\",\n \"spending_plan_iteration_guid\": \"\",\n \"top_level_category_guid\": \"\",\n \"transaction_guids\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-5a3d5455-4c98-41a5-b501-37792127fa09" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b0c524d0-4a03-468a-9429-bc9c4e77eb4b" } ], "id": "bb07e12f-b0fd-4244-8f7b-2312de7a86e7", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-bb07e12f-b0fd-4244-8f7b-2312de7a86e7" }, { "name": "Read current spending plan iteration", "id": "6500bf38-8064-4c8b-b1b7-557828d14e2b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "5b8ce32b-900d-4344-82f0-d746a10bb5fe", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "5bcbdacb-648a-4f9b-834e-982fa589c37d", "key": "spending_plan_guid", "value": "", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "description": "Use this endpoint to read the attributes of the current spending plan `iteration`." }, "response": [ { "id": "a00101df-861b-4dab-812d-f12ce4d9af26", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", "current" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "spending_plan_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created_at\": \"\",\n \"end_on\": \"\",\n \"guid\": \"\",\n \"iteration_number\": \"\",\n \"spending_plan_guid\": \"\",\n \"start_on\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-a00101df-861b-4dab-812d-f12ce4d9af26" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6500bf38-8064-4c8b-b1b7-557828d14e2b" } ], "id": "583b51b0-0112-4c56-84df-21465befaebe", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-583b51b0-0112-4c56-84df-21465befaebe" }, { "name": "{iteration_number}", "item": [ { "name": "Read a spending plan iteration", "id": "d10309e6-f3e3-489c-a4ec-f64fe176452c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/iterations/:iteration_number?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", ":iteration_number" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "69a2be35-22fe-4a2b-9b0e-e5f9f21d4fc4", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "9caadf24-466d-4c0e-8f02-700867b22ced", "key": "spending_plan_guid", "value": "", "description": "(Required) The unique ID for the `spending_plan`." }, { "id": "6f0d2d4c-134a-458b-9b08-d4968daf95b4", "key": "iteration_number", "value": "", "description": "(Required) The current iteration number for the spending plan `iteration`." } ] }, "description": "Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`." }, "response": [ { "id": "dd5862c9-5d7a-4d6a-b9c5-49a85dca7e6d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/iterations/:iteration_number?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations", ":iteration_number" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "spending_plan_guid" }, { "key": "iteration_number" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created_at\": \"\",\n \"end_on\": \"\",\n \"guid\": \"\",\n \"iteration_number\": \"\",\n \"spending_plan_guid\": \"\",\n \"start_on\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-dd5862c9-5d7a-4d6a-b9c5-49a85dca7e6d" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d10309e6-f3e3-489c-a4ec-f64fe176452c" } ], "id": "0233ab65-f578-4f88-93f4-927fcca2f31f", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-0233ab65-f578-4f88-93f4-927fcca2f31f" }, { "name": "List spending plan iterations", "id": "e354c724-f821-474d-a0c5-883c88e76ac6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/iterations?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "e2d8282b-dd7d-49c9-8a8b-6ae40e5b9a8b", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "19dbc078-e927-4964-b1ce-f84aafb57576", "key": "spending_plan_guid", "value": "", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "description": "Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`." }, "response": [ { "id": "24690cfb-ae2b-410a-8730-4019015f8151", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/iterations?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "iterations" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "spending_plan_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"iterations\": [\n {\n \"created_at\": \"\",\n \"end_on\": \"\",\n \"guid\": \"\",\n \"iteration_number\": \"\",\n \"spending_plan_guid\": \"\",\n \"start_on\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n },\n {\n \"created_at\": \"\",\n \"end_on\": \"\",\n \"guid\": \"\",\n \"iteration_number\": \"\",\n \"spending_plan_guid\": \"\",\n \"start_on\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-24690cfb-ae2b-410a-8730-4019015f8151" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e354c724-f821-474d-a0c5-883c88e76ac6" } ], "id": "c94e5489-8a8e-45cf-986a-c1df3c4516ce", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-c94e5489-8a8e-45cf-986a-c1df3c4516ce" }, { "name": "spending_plan_accounts", "item": [ { "name": "{spending_plan_account_guid}", "item": [ { "name": "Delete spending plan account", "id": "f4cc3b9e-4963-46be-8229-cd22e8c5161a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/spending_plan_accounts/:spending_plan_account_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "spending_plan_accounts", ":spending_plan_account_guid" ], "variable": [ { "id": "07162756-99ff-41df-8c81-c23023cbea3b", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "3540070d-e20d-4223-9de2-42dae3c6f7dc", "key": "spending_plan_guid", "value": "", "description": "(Required) The unique ID for the `spending_plan`." }, { "id": "b4217641-0299-40d2-9f42-3dfc1f329c54", "key": "spending_plan_account_guid", "value": "", "description": "(Required) The unique ID for the specified account." } ] }, "description": "Use this endpoint to delete a `spending_plan_account`." }, "response": [ { "id": "4378ce30-3349-4f21-8c7e-29c774f38f00", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/spending_plan_accounts/:spending_plan_account_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "spending_plan_accounts", ":spending_plan_account_guid" ], "variable": [ { "key": "user_guid" }, { "key": "spending_plan_guid" }, { "key": "spending_plan_account_guid" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-4378ce30-3349-4f21-8c7e-29c774f38f00" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-f4cc3b9e-4963-46be-8229-cd22e8c5161a" }, { "name": "Read spending plan account", "id": "d4ed83a4-673c-4fb5-805c-1d2973c1d881", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/spending_plan_accounts/:spending_plan_account_guid?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "spending_plan_accounts", ":spending_plan_account_guid" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "6ceec8fc-30f9-4d72-b6b8-67cbdde19fb8", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "2ba36a29-3a7d-4ee3-b767-6e1f5b8347c2", "key": "spending_plan_guid", "value": "", "description": "(Required) The unique ID for the `spending_plan`." }, { "id": "a2e1c28a-4df6-4954-8932-c241e9fcc9c3", "key": "spending_plan_account_guid", "value": "", "description": "(Required) The unique ID for the specified account." } ] }, "description": "Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID." }, "response": [ { "id": "b6f5a245-b083-45ee-babf-0d7155325aeb", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/spending_plan_accounts/:spending_plan_account_guid?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "spending_plan_accounts", ":spending_plan_account_guid" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "spending_plan_guid" }, { "key": "spending_plan_account_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"account_guid\": \"\",\n \"client_guid\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"spending_plan_guid\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b6f5a245-b083-45ee-babf-0d7155325aeb" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d4ed83a4-673c-4fb5-805c-1d2973c1d881" } ], "id": "cfc2b0fc-d8d0-46d4-980b-44232394954e", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-cfc2b0fc-d8d0-46d4-980b-44232394954e" }, { "name": "List spending plan accounts", "id": "5fc3b033-1438-4d73-bf23-1dc00377684a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/spending_plan_accounts?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "spending_plan_accounts" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "cd379033-1e60-46e0-8af7-ce1c9851dd91", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "6a73475d-bf78-4a52-b359-c248d6002ff2", "key": "spending_plan_guid", "value": "", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "description": "Use this endpoint to list all the spending plan accounts associated with the spending plan." }, "response": [ { "id": "b4e625e5-8d81-4e83-bb73-f75c0f395633", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid/spending_plan_accounts?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid", "spending_plan_accounts" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "spending_plan_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"spending_plan_accounts\": [\n {\n \"account_guid\": \"\",\n \"client_guid\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"spending_plan_guid\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n },\n {\n \"account_guid\": \"\",\n \"client_guid\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"spending_plan_guid\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b4e625e5-8d81-4e83-bb73-f75c0f395633" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-5fc3b033-1438-4d73-bf23-1dc00377684a" } ], "id": "6ceaac32-f9e8-4e03-bc7d-e391a8fbd000", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6ceaac32-f9e8-4e03-bc7d-e391a8fbd000" }, { "name": "Delete spending plan", "id": "b290d25f-21fc-4453-a22d-3004ef1a2a43", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid" ], "variable": [ { "id": "857bc051-6780-46b0-ade9-f21c232bc7d4", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "fccf19ed-1708-45c3-a1ba-ff00e74f37df", "key": "spending_plan_guid", "value": "", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "description": "Use this endpoint to delete a user's `spending_plan`." }, "response": [ { "id": "79233acd-3217-4047-a1f4-1911aef7a598", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid" ], "variable": [ { "key": "user_guid" }, { "key": "spending_plan_guid" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-79233acd-3217-4047-a1f4-1911aef7a598" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b290d25f-21fc-4453-a22d-3004ef1a2a43" }, { "name": "Read a spending plan for a user", "id": "eb59e0be-682d-416d-869b-aa58a07347e8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "797bfb4c-13c9-466f-a1f7-bb1835d3d80f", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "acad5148-633e-4894-8b9d-0971b3086d8b", "key": "spending_plan_guid", "value": "", "description": "(Required) The unique ID for the `spending_plan`." } ] }, "description": "Use this endpoint to read the attributes of a specific spending plan according to its unique GUID." }, "response": [ { "id": "e3838eb3-b759-45a5-b80a-ec85f8cf5f24", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans/:spending_plan_guid?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans", ":spending_plan_guid" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "spending_plan_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created_at\": \"\",\n \"current_iteration_number\": \"\",\n \"guid\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e3838eb3-b759-45a5-b80a-ec85f8cf5f24" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-eb59e0be-682d-416d-869b-aa58a07347e8" } ], "id": "29d6afa2-2736-4601-9e70-14c10e0294fe", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-29d6afa2-2736-4601-9e70-14c10e0294fe" }, { "name": "Create spending plan", "id": "0e92f82c-3d31-4d77-ad00-da7ddab3291f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans" ], "variable": [ { "id": "6d7ff01f-7e9d-495d-bb44-928a40e9ee97", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "This endpoint creates a new `spending_plan` for the user." }, "response": [ { "id": "cca7aee7-cff3-4fb2-88f6-c2df6da9e804", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans" ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created_at\": \"\",\n \"current_iteration_number\": \"\",\n \"guid\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-cca7aee7-cff3-4fb2-88f6-c2df6da9e804" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-0e92f82c-3d31-4d77-ad00-da7ddab3291f" }, { "name": "List spending plans", "id": "d8b7f315-f73e-4362-bed4-76e89eb265da", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "7c0fe64b-d57b-465c-8593-bf48439b76b6", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "Use this endpoint to list all the spending plans associated with the user." }, "response": [ { "id": "f9e54987-dfaa-4514-8bd0-3433a52ac767", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/spending_plans?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "spending_plans" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"spending_plans\": [\n {\n \"created_at\": \"\",\n \"current_iteration_number\": \"\",\n \"guid\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n },\n {\n \"created_at\": \"\",\n \"current_iteration_number\": \"\",\n \"guid\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-f9e54987-dfaa-4514-8bd0-3433a52ac767" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d8b7f315-f73e-4362-bed4-76e89eb265da" } ], "id": "41ef0483-e221-4367-ae1a-09b750b56fe1", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-41ef0483-e221-4367-ae1a-09b750b56fe1" }, { "name": "taggings", "item": [ { "name": "{tagging_guid}", "item": [ { "name": "Delete tagging", "id": "ca8255a3-d029-4a1c-abd4-69f81cab583e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/taggings/:tagging_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "taggings", ":tagging_guid" ], "variable": [ { "id": "55c1f439-bcf4-4bd6-ba2e-2cf851968f57", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "f022ef94-87d8-46ae-940c-c34b87441014", "key": "tagging_guid", "value": "", "description": "(Required) The unique id for a `tagging`." } ] }, "description": "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." }, "response": [ { "id": "bf1694bf-ce40-4689-b518-ef241ff1a8ac", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/taggings/:tagging_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "taggings", ":tagging_guid" ], "variable": [ { "key": "user_guid" }, { "key": "tagging_guid" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-bf1694bf-ce40-4689-b518-ef241ff1a8ac" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-ca8255a3-d029-4a1c-abd4-69f81cab583e" }, { "name": "Read tagging", "id": "ea24f666-d7f1-4749-8cf8-ada5cc33bc74", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/taggings/:tagging_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "taggings", ":tagging_guid" ], "variable": [ { "id": "b9c54e94-5a11-4c4b-a25f-90452242d2e1", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "084d2c36-9016-4818-bbc1-c6ea42ac41bf", "key": "tagging_guid", "value": "", "description": "(Required) The unique id for a `tagging`." } ] }, "description": "Use this endpoint to read the attributes of a `tagging` according to its unique GUID." }, "response": [ { "id": "d7af0695-e03b-4b46-8e5d-4adb05d65c63", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/taggings/:tagging_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "taggings", ":tagging_guid" ], "variable": [ { "key": "user_guid" }, { "key": "tagging_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"tagging\": {\n \"guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"tag_guid\": \"\",\n \"transaction_guid\": \"\",\n \"user_guid\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d7af0695-e03b-4b46-8e5d-4adb05d65c63" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-ea24f666-d7f1-4749-8cf8-ada5cc33bc74" }, { "name": "Update tagging", "id": "60f2c956-ca79-4c7c-a9d8-792c5c35bc1e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"tagging\": {\n \"tag_guid\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/taggings/:tagging_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "taggings", ":tagging_guid" ], "variable": [ { "id": "5c22761a-4d41-47a0-89fa-cd5c3ed408c9", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "047cfcf1-c209-45eb-889b-0ed0529d03f4", "key": "tagging_guid", "value": "", "description": "(Required) The unique id for a `tagging`." } ] }, "description": "Use this endpoint to update a tagging." }, "response": [ { "id": "7fc0f527-085e-4d52-8199-4c5367c694a0", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"tagging\": {\n \"tag_guid\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/taggings/:tagging_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "taggings", ":tagging_guid" ], "variable": [ { "key": "user_guid" }, { "key": "tagging_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"tagging\": {\n \"guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"tag_guid\": \"\",\n \"transaction_guid\": \"\",\n \"user_guid\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-7fc0f527-085e-4d52-8199-4c5367c694a0" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-60f2c956-ca79-4c7c-a9d8-792c5c35bc1e" } ], "id": "2b659562-8463-4644-b280-7b801d2c2a79", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-2b659562-8463-4644-b280-7b801d2c2a79" }, { "name": "List taggings", "id": "5812cf46-7932-4c1a-aad8-bb50b9495ffb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/taggings?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "taggings" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "625ca151-329a-4ebe-a60a-e00ba3945a77", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "Use this endpoint to retrieve a list of all the taggings associated with a specific user." }, "response": [ { "id": "5e9311c0-7a8a-427f-afec-5d68d4c7f31e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/taggings?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "taggings" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"taggings\": [\n {\n \"guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"tag_guid\": \"\",\n \"transaction_guid\": \"\",\n \"user_guid\": \"\"\n },\n {\n \"guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"tag_guid\": \"\",\n \"transaction_guid\": \"\",\n \"user_guid\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-5e9311c0-7a8a-427f-afec-5d68d4c7f31e" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-5812cf46-7932-4c1a-aad8-bb50b9495ffb" }, { "name": "Create tagging", "id": "697486fe-3c32-4d25-bb8e-7391a4e14f6a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"tagging\": {\n \"tag_guid\": \"\",\n \"transaction_guid\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/taggings", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "taggings" ], "variable": [ { "id": "5d56aead-2545-4122-910a-e6ff4243ec3f", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "Use this endpoint to create a new association between a tag and a particular transaction, according to their unique GUIDs." }, "response": [ { "id": "1b4e8162-c2a1-4b55-94f0-149d1cc85c20", "name": "Accepted", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"tagging\": {\n \"tag_guid\": \"\",\n \"transaction_guid\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/taggings", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "taggings" ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"tagging\": {\n \"guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"tag_guid\": \"\",\n \"transaction_guid\": \"\",\n \"user_guid\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-1b4e8162-c2a1-4b55-94f0-149d1cc85c20" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-697486fe-3c32-4d25-bb8e-7391a4e14f6a" } ], "id": "2df6802f-286c-4ba1-8456-ac112c9ef31c", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-2df6802f-286c-4ba1-8456-ac112c9ef31c" }, { "name": "tags", "item": [ { "name": "{tag_guid}", "item": [ { "name": "Delete tag", "id": "58a99865-df5a-49f1-aa4e-9e827de88c89", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/tags/:tag_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "tags", ":tag_guid" ], "variable": [ { "id": "43adaaa8-c068-467e-a4d3-57e19aff0aad", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "f5d8b84d-53ce-48e5-9b20-455f6dc2f297", "key": "tag_guid", "value": "", "description": "(Required) The unique id for a `tag`." } ] }, "description": "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`." }, "response": [ { "id": "ca79ecf9-2c5a-4928-ae3b-978a6885fdeb", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/tags/:tag_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "tags", ":tag_guid" ], "variable": [ { "key": "user_guid" }, { "key": "tag_guid" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-ca79ecf9-2c5a-4928-ae3b-978a6885fdeb" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-58a99865-df5a-49f1-aa4e-9e827de88c89" }, { "name": "Read tag", "id": "fdff1fc2-98ec-4aea-9775-764a611f962e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/tags/:tag_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "tags", ":tag_guid" ], "variable": [ { "id": "7df0b62a-ba29-44d0-8406-2cc5643c80f5", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "555327a4-ea00-46df-9bc6-c4a360990e9a", "key": "tag_guid", "value": "", "description": "(Required) The unique id for a `tag`." } ] }, "description": "Use this endpoint to read the attributes of a particular tag according to its unique GUID." }, "response": [ { "id": "e7afce13-b7ad-4ac7-b308-62513374f589", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/tags/:tag_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "tags", ":tag_guid" ], "variable": [ { "key": "user_guid" }, { "key": "tag_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"tag\": {\n \"guid\": \"\",\n \"name\": \"\",\n \"user_guid\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e7afce13-b7ad-4ac7-b308-62513374f589" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-fdff1fc2-98ec-4aea-9775-764a611f962e" }, { "name": "Update tag", "id": "9e197372-3770-48bc-90a1-76225f10a7a5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"tag\": {\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/tags/:tag_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "tags", ":tag_guid" ], "variable": [ { "id": "2ec34d1f-e1fb-4726-9f51-d0a4484bb5e3", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "e59b71b1-13e4-4fc4-9564-3638c42c6e1e", "key": "tag_guid", "value": "", "description": "(Required) The unique id for a `tag`." } ] }, "description": "Use this endpoint to update the name of a specific tag according to its unique GUID." }, "response": [ { "id": "95ee539c-ba48-4c5a-a8f5-fd5bfb921d02", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"tag\": {\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/tags/:tag_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "tags", ":tag_guid" ], "variable": [ { "key": "user_guid" }, { "key": "tag_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"tag\": {\n \"guid\": \"\",\n \"name\": \"\",\n \"user_guid\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-95ee539c-ba48-4c5a-a8f5-fd5bfb921d02" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-9e197372-3770-48bc-90a1-76225f10a7a5" } ], "id": "7c96b917-b131-4848-accb-3a9093098e64", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-7c96b917-b131-4848-accb-3a9093098e64" }, { "name": "List tags", "id": "f73cd2d0-754f-4822-8183-1de39d6ee70d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/tags?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "tags" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "b3494909-a4ba-4db4-937e-3917c9347bf3", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "Use this endpoint to list all tags associated with the specified `user`. Each user includes the `Business` tag by default." }, "response": [ { "id": "527ec32a-cd68-4ed7-8327-fe7c8ddd18fd", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/tags?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "tags" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"tags\": [\n {\n \"guid\": \"\",\n \"name\": \"\",\n \"user_guid\": \"\"\n },\n {\n \"guid\": \"\",\n \"name\": \"\",\n \"user_guid\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-527ec32a-cd68-4ed7-8327-fe7c8ddd18fd" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-f73cd2d0-754f-4822-8183-1de39d6ee70d" }, { "name": "Create tag", "id": "80a40377-c7c3-45c5-a050-5b8f6542e135", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"tag\": {\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/tags", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "tags" ], "variable": [ { "id": "0c9d6571-89d3-4165-a127-14995abbac06", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "Use this endpoint to create a new custom tag." }, "response": [ { "id": "936541b6-50b9-422f-bc31-c6c525642cb4", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"tag\": {\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/tags", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "tags" ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"tag\": {\n \"guid\": \"\",\n \"name\": \"\",\n \"user_guid\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-936541b6-50b9-422f-bc31-c6c525642cb4" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-80a40377-c7c3-45c5-a050-5b8f6542e135" } ], "id": "941a019d-3966-4d93-b61d-5eb85c7022d2", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-941a019d-3966-4d93-b61d-5eb85c7022d2" }, { "name": "transaction_rules", "item": [ { "name": "{transaction_rule_guid}", "item": [ { "name": "Delete transaction rule", "id": "6886a353-6247-4ea5-8c0c-f79c0791b6d3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/transaction_rules/:transaction_rule_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transaction_rules", ":transaction_rule_guid" ], "variable": [ { "id": "391fbbf2-1371-4b15-b45c-76b6deaf258c", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "ca74a5e7-3d20-4ff2-aacb-4af78a8d633a", "key": "transaction_rule_guid", "value": "", "description": "(Required) The unique id for a `transaction_rule`." } ] }, "description": "Use this endpoint to permanently delete a transaction rule based on its unique GUID." }, "response": [ { "id": "cec681ec-b35d-4871-b938-dc35164af5c6", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/transaction_rules/:transaction_rule_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transaction_rules", ":transaction_rule_guid" ], "variable": [ { "key": "user_guid" }, { "key": "transaction_rule_guid" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-cec681ec-b35d-4871-b938-dc35164af5c6" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6886a353-6247-4ea5-8c0c-f79c0791b6d3" }, { "name": "Read transaction rule", "id": "e8d16c0b-3c4c-4adc-8812-8a678b5d8c39", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/transaction_rules/:transaction_rule_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transaction_rules", ":transaction_rule_guid" ], "variable": [ { "id": "38275665-83b4-4b40-bac8-e9396517c1cd", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "164e17f5-9231-42b4-93c1-a0744c6e032e", "key": "transaction_rule_guid", "value": "", "description": "(Required) The unique id for a `transaction_rule`." } ] }, "description": "Use this endpoint to read the attributes of an existing transaction rule based on the rule\u2019s unique GUID." }, "response": [ { "id": "174fbe12-817c-44c8-a3e9-30cbcfd3b6d3", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/transaction_rules/:transaction_rule_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transaction_rules", ":transaction_rule_guid" ], "variable": [ { "key": "user_guid" }, { "key": "transaction_rule_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction_rule\": {\n \"category_guid\": \"\",\n \"created_at\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"match_description\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-174fbe12-817c-44c8-a3e9-30cbcfd3b6d3" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e8d16c0b-3c4c-4adc-8812-8a678b5d8c39" }, { "name": "Update transaction rule", "id": "44891cec-89b6-4730-a376-16e7454e38aa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction_rule\": {\n \"category_guid\": \"\",\n \"description\": \"\",\n \"match_description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/transaction_rules/:transaction_rule_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transaction_rules", ":transaction_rule_guid" ], "variable": [ { "id": "a97879ad-8832-4b76-bbd1-db20aaee25d2", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "99c33ff2-3cd8-4258-878c-9225a34adeeb", "key": "transaction_rule_guid", "value": "", "description": "(Required) The unique id for a `transaction_rule`." } ] }, "description": "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" }, "response": [ { "id": "3a86d281-3241-4457-bbb7-579b36917858", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction_rule\": {\n \"category_guid\": \"\",\n \"description\": \"\",\n \"match_description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/transaction_rules/:transaction_rule_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transaction_rules", ":transaction_rule_guid" ], "variable": [ { "key": "user_guid" }, { "key": "transaction_rule_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction_rule\": {\n \"category_guid\": \"\",\n \"created_at\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"match_description\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-3a86d281-3241-4457-bbb7-579b36917858" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-44891cec-89b6-4730-a376-16e7454e38aa" } ], "id": "a31ded00-7438-4930-b6a8-eef6f559dc2a", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-a31ded00-7438-4930-b6a8-eef6f559dc2a" }, { "name": "List transaction rules", "id": "70a7d6f0-b8c5-4906-8aa0-1858df9366af", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/transaction_rules?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transaction_rules" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "fa915e99-82fb-4d09-b07e-8b2a8ddb8b11", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "Use this endpoint to read the attributes of all existing transaction rules belonging to the user." }, "response": [ { "id": "91d9e27b-8b62-419a-95ae-2b2a3b464932", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/transaction_rules?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transaction_rules" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction_rules\": [\n {\n \"category_guid\": \"\",\n \"created_at\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"match_description\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n },\n {\n \"category_guid\": \"\",\n \"created_at\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"match_description\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-91d9e27b-8b62-419a-95ae-2b2a3b464932" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-70a7d6f0-b8c5-4906-8aa0-1858df9366af" }, { "name": "Create transaction rule", "id": "568dc6c8-6ca1-4c36-9c73-258a3fbd1fb1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction_rule\": {\n \"category_guid\": \"\",\n \"match_description\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/transaction_rules", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transaction_rules" ], "variable": [ { "id": "c250ce03-f106-4496-8275-29d781fd3808", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "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" }, "response": [ { "id": "6feb28b8-ed0b-4d25-858f-3c7f1a90f064", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction_rule\": {\n \"category_guid\": \"\",\n \"match_description\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/transaction_rules", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transaction_rules" ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction_rule\": {\n \"category_guid\": \"\",\n \"created_at\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"match_description\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6feb28b8-ed0b-4d25-858f-3c7f1a90f064" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-568dc6c8-6ca1-4c36-9c73-258a3fbd1fb1" } ], "id": "cf9f3970-7c45-480e-9c0d-0d4e6a856113", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-cf9f3970-7c45-480e-9c0d-0d4e6a856113" }, { "name": "transactions", "item": [ { "name": "{transaction_guid}", "item": [ { "name": "insights", "item": [ { "name": "List insights by transaction", "id": "8e343ffb-cdbc-407f-ac8c-3b25a7a35d7c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/transactions/:transaction_guid/insights?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transactions", ":transaction_guid", "insights" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "fa25f5a8-6bbd-4f7f-b35a-6cecc9930b28", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "1839cb84-f2e7-4a6d-9b68-32af6c4bdf6a", "key": "transaction_guid", "value": "", "description": "(Required) The unique id for a `transaction`." } ] }, "description": "Use this endpoint to list all insights associated with a transaction GUID." }, "response": [ { "id": "341aa25e-cb82-47df-af1e-ef73362d0ed3", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/transactions/:transaction_guid/insights?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transactions", ":transaction_guid", "insights" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "transaction_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"insights\": [\n {\n \"active_at\": \"\",\n \"client_guid\": \"\",\n \"created_at\": \"\",\n \"cta_clicked_at\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"has_associated_accounts\": \"\",\n \"has_associated_categories\": \"\",\n \"has_associated_merchants\": \"\",\n \"has_associated_scheduled_payments\": \"\",\n \"has_associated_transactions\": \"\",\n \"has_been_displayed\": \"\",\n \"is_dismissed\": \"\",\n \"micro_call_to_action\": \"\",\n \"micro_description\": \"\",\n \"micro_title\": \"\",\n \"template\": \"\",\n \"title\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n },\n {\n \"active_at\": \"\",\n \"client_guid\": \"\",\n \"created_at\": \"\",\n \"cta_clicked_at\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"has_associated_accounts\": \"\",\n \"has_associated_categories\": \"\",\n \"has_associated_merchants\": \"\",\n \"has_associated_scheduled_payments\": \"\",\n \"has_associated_transactions\": \"\",\n \"has_been_displayed\": \"\",\n \"is_dismissed\": \"\",\n \"micro_call_to_action\": \"\",\n \"micro_description\": \"\",\n \"micro_title\": \"\",\n \"template\": \"\",\n \"title\": \"\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-341aa25e-cb82-47df-af1e-ef73362d0ed3" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-8e343ffb-cdbc-407f-ac8c-3b25a7a35d7c" } ], "id": "e1447815-9792-4c46-a62a-b4130132a538", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e1447815-9792-4c46-a62a-b4130132a538" }, { "name": "split", "item": [ { "name": "Delete split transactions", "id": "9c1a6124-df97-4c22-8b25-d4290eac3027", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/transactions/:transaction_guid/split", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transactions", ":transaction_guid", "split" ], "variable": [ { "id": "5c824587-853c-4715-8fca-8ece9269e719", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "f97d817e-961a-4f4c-86be-02592e86aae9", "key": "transaction_guid", "value": "", "description": "(Required) The unique id for a `transaction`." } ] }, "description": "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." }, "response": [ { "id": "403fb43d-a2ed-4cc8-a811-494a8b01ea05", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/transactions/:transaction_guid/split", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transactions", ":transaction_guid", "split" ], "variable": [ { "key": "user_guid" }, { "key": "transaction_guid" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-403fb43d-a2ed-4cc8-a811-494a8b01ea05" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-9c1a6124-df97-4c22-8b25-d4290eac3027" }, { "name": "Create split transactions", "id": "c623751e-3936-4480-b873-8b8b58a4e2f1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transactions\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"category_guid\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/transactions/:transaction_guid/split", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transactions", ":transaction_guid", "split" ], "variable": [ { "id": "95e7664f-b76d-4bec-ae46-106ded2a4cf6", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "35002cb1-b031-4b91-965e-ec36f086585f", "key": "transaction_guid", "value": "", "description": "(Required) The unique id for a `transaction`." } ] }, "description": "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" }, "response": [ { "id": "f0cb375a-4a80-4d90-9547-627197d800e7", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transactions\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"category_guid\": \"\",\n \"memo\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/transactions/:transaction_guid/split", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transactions", ":transaction_guid", "split" ], "variable": [ { "key": "user_guid" }, { "key": "transaction_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n },\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-f0cb375a-4a80-4d90-9547-627197d800e7" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-c623751e-3936-4480-b873-8b8b58a4e2f1" } ], "id": "b101b7ca-f968-4d25-946f-65fdc0be0993", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b101b7ca-f968-4d25-946f-65fdc0be0993" }, { "name": "Read transaction", "id": "d7c4568c-c4eb-48d8-be27-308761ebfabd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/transactions/:transaction_guid?includes=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transactions", ":transaction_guid" ], "query": [ { "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", "key": "includes", "value": "" } ], "variable": [ { "id": "ce40b62a-25af-4b02-9243-ffeffe189f80", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "69a28e1f-2cb7-453e-85a6-f9a5a29522cc", "key": "transaction_guid", "value": "", "description": "(Required) The unique id for a `transaction`." } ] }, "description": "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)." }, "response": [ { "id": "903ea1a0-8f26-44e5-a788-a3a9e471022a", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/transactions/:transaction_guid?includes=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transactions", ":transaction_guid" ], "query": [ { "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", "key": "includes", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "transaction_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"PENDING\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\",\n \"classification\": {\n \"parent_class\": \"Expenses\",\n \"guid\": \"\"\n },\n \"geolocation\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"postal code\": \"\"\n },\n \"merchant\": {\n \"name\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"website_url\": \"\"\n },\n \"repeating_transaction\": {\n \"repeating_transaction_type\": \"UNKNOWN\",\n \"recurrence_type\": \"EVERY_OTHER_WEEK\",\n \"guid\": \"\"\n }\n },\n {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"POSTED\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"CREDIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\",\n \"classification\": {\n \"parent_class\": \"Refunds\",\n \"guid\": \"\"\n },\n \"geolocation\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"postal code\": \"\"\n },\n \"merchant\": {\n \"name\": \"\",\n \"guid\": \"\",\n \"logo_url\": \"\",\n \"website_url\": \"\"\n },\n \"repeating_transaction\": {\n \"repeating_transaction_type\": \"UNKNOWN\",\n \"recurrence_type\": \"EVERY_OTHER_WEEK\",\n \"guid\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-903ea1a0-8f26-44e5-a788-a3a9e471022a" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d7c4568c-c4eb-48d8-be27-308761ebfabd" }, { "name": "Update transaction", "id": "c75e3d8d-bed4-47b3-b9b6-3f962a555e31", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/transactions/:transaction_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transactions", ":transaction_guid" ], "variable": [ { "id": "eab87f68-b49f-40a6-9c58-12766bd2a22d", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "aaaa3ad3-91d4-4544-ae01-4b3a3c65b937", "key": "transaction_guid", "value": "", "description": "(Required) The unique id for a `transaction`." } ] }, "description": "Use this endpoint to update the `description` of a specific transaction according to its unique GUID." }, "response": [ { "id": "2eef75b9-d2fa-4211-bd22-73ebe33d3e87", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/transactions/:transaction_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transactions", ":transaction_guid" ], "variable": [ { "key": "user_guid" }, { "key": "transaction_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"account_guid\": \"\",\n \"account_id\": \"\",\n \"amount\": \"\",\n \"category\": \"\",\n \"category_guid\": \"\",\n \"check_number_string\": \"\",\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"extended_transaction_type\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_bill_pay\": \"\",\n \"is_direct_deposit\": \"\",\n \"is_expense\": \"\",\n \"is_fee\": \"\",\n \"is_income\": \"\",\n \"is_international\": \"\",\n \"is_manual\": \"\",\n \"is_overdraft_fee\": \"\",\n \"is_payroll_advance\": \"\",\n \"is_recurring\": \"\",\n \"is_subscription\": \"\",\n \"latitude\": \"\",\n \"localized_description\": \"\",\n \"localized_memo\": \"\",\n \"longitude\": \"\",\n \"member_guid\": \"\",\n \"member_is_managed_by_user\": \"\",\n \"memo\": \"\",\n \"merchant_category_code\": \"\",\n \"merchant_guid\": \"\",\n \"merchant_location_guid\": \"\",\n \"metadata\": \"\",\n \"original_description\": \"\",\n \"posted_at\": \"\",\n \"status\": \"PENDING\",\n \"top_level_category\": \"\",\n \"transacted_at\": \"\",\n \"type\": \"DEBIT\",\n \"updated_at\": \"\",\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-2eef75b9-d2fa-4211-bd22-73ebe33d3e87" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-c75e3d8d-bed4-47b3-b9b6-3f962a555e31" }, { "name": "Delete manual transactions", "id": "e18169a5-d2b2-47e4-960c-b3033278f0ae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/transactions/:transaction_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transactions", ":transaction_guid" ], "variable": [ { "id": "b186adc6-edc7-4917-85d0-2eead2764bde", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "83acfc61-ca5f-49ee-ba05-68b752cc597d", "key": "transaction_guid", "value": "", "description": "(Required) The unique id for a `transaction`." } ] }, "description": "Delete a manual transaction. In the path, use the manual transaction guid as the `transaction_guid`, such as `MAN-810828b0-5210-4878-9bd3-f4ce514f90c4`." }, "response": [ { "id": "fbe0c4cc-1088-4986-8cdc-5426b64a4f0a", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/transactions/:transaction_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "transactions", ":transaction_guid" ], "variable": [ { "key": "user_guid" }, { "key": "transaction_guid" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-fbe0c4cc-1088-4986-8cdc-5426b64a4f0a" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e18169a5-d2b2-47e4-960c-b3033278f0ae" } ], "id": "9809b483-96ec-4dba-965f-01f22bf6f558", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-9809b483-96ec-4dba-965f-01f22bf6f558" } ], "id": "82a24040-a061-4d95-84a3-32be786a0104", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-82a24040-a061-4d95-84a3-32be786a0104" }, { "name": "budgets", "item": [ { "name": "generate", "item": [ { "name": "Auto-generate budgets", "id": "2a5900db-ee1a-40e8-8896-ffebe704994f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/budgets/generate", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "budgets", "generate" ], "variable": [ { "id": "f2c3af3c-51ab-424c-a21f-800cb4ca8a6a", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "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`." }, "response": [ { "id": "5077ffca-5a07-4036-9b6b-9cb2d71fa0d5", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/budgets/generate", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "budgets", "generate" ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"budget\": {\n \"amount\": \"\",\n \"category_guid\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"is_exceeded\": \"\",\n \"is_off_track\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"off_track_percentage\": \"\",\n \"parent_guid\": \"\",\n \"percent_spent\": \"\",\n \"projected_spending\": \"\",\n \"revision\": \"\",\n \"transaction_total\": {\n \"description\": \"The cumulative amount of all transactions under the budget.\",\n \"example\": 1952.8\n },\n \"updated_at\": {\n \"description\": \"Date and time the budget was updated, represented in ISO 8601 format with timestamp.\",\n \"example\": \"2022-06-14T21:17:11+00:00\"\n },\n \"user_guid\": {\n \"description\": \"Unique identifier for the user. Defined by MX.\",\n \"example\": \"USR-11141024-90b3-1bce-cac9-c06ced52ab4c\"\n }\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-5077ffca-5a07-4036-9b6b-9cb2d71fa0d5" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-2a5900db-ee1a-40e8-8896-ffebe704994f" } ], "id": "6c62cb72-0984-4316-b71f-5b0a97b641cf", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6c62cb72-0984-4316-b71f-5b0a97b641cf" }, { "name": "{budget_guid}", "item": [ { "name": "Read a specific budget", "id": "72739e4f-4886-4347-82eb-5c72fc6fd04e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/budgets/:budget_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "budgets", ":budget_guid" ], "variable": [ { "id": "477bc6af-2eec-45ea-ba0e-d215fd2c763b", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "ed69d754-ecb3-43e8-ae00-d6ec12f74b1a", "key": "budget_guid", "value": "", "description": "(Required) The unique identifier for the budget. Defined by MX." } ] }, "description": "Read a specific budget." }, "response": [ { "id": "2d49b18d-61bd-4a59-904d-1b240b4b27ba", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/budgets/:budget_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "budgets", ":budget_guid" ], "variable": [ { "key": "user_guid" }, { "key": "budget_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"budget\": {\n \"amount\": \"\",\n \"category_guid\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"is_exceeded\": \"\",\n \"is_off_track\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"off_track_percentage\": \"\",\n \"parent_guid\": \"\",\n \"percent_spent\": \"\",\n \"projected_spending\": \"\",\n \"revision\": \"\",\n \"transaction_total\": {\n \"description\": \"The cumulative amount of all transactions under the budget.\",\n \"example\": 1952.8\n },\n \"updated_at\": {\n \"description\": \"Date and time the budget was updated, represented in ISO 8601 format with timestamp.\",\n \"example\": \"2022-06-14T21:17:11+00:00\"\n },\n \"user_guid\": {\n \"description\": \"Unique identifier for the user. Defined by MX.\",\n \"example\": \"USR-11141024-90b3-1bce-cac9-c06ced52ab4c\"\n }\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-2d49b18d-61bd-4a59-904d-1b240b4b27ba" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-72739e4f-4886-4347-82eb-5c72fc6fd04e" }, { "name": "Update a specific budget", "id": "ae222af4-ce2c-416f-8973-14e105392786", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"budget\": {\n \"amount\": \"\",\n \"metadata\": \"\",\n \"skip_webhook\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/budgets/:budget_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "budgets", ":budget_guid" ], "variable": [ { "id": "51389162-b895-4452-9c9a-ce461aaaea92", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "35d7578e-a45c-4efe-9e78-f8ab1de2637d", "key": "budget_guid", "value": "", "description": "(Required) The unique identifier for the budget. Defined by MX." } ] }, "description": "Update a specific budget." }, "response": [ { "id": "72ec5185-2426-4bb4-a31f-9b4bbe455445", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"budget\": {\n \"amount\": \"\",\n \"metadata\": \"\",\n \"skip_webhook\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/budgets/:budget_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "budgets", ":budget_guid" ], "variable": [ { "key": "user_guid" }, { "key": "budget_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"budget\": {\n \"amount\": \"\",\n \"category_guid\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"is_exceeded\": \"\",\n \"is_off_track\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"off_track_percentage\": \"\",\n \"parent_guid\": \"\",\n \"percent_spent\": \"\",\n \"projected_spending\": \"\",\n \"revision\": \"\",\n \"transaction_total\": {\n \"description\": \"The cumulative amount of all transactions under the budget.\",\n \"example\": 1952.8\n },\n \"updated_at\": {\n \"description\": \"Date and time the budget was updated, represented in ISO 8601 format with timestamp.\",\n \"example\": \"2022-06-14T21:17:11+00:00\"\n },\n \"user_guid\": {\n \"description\": \"Unique identifier for the user. Defined by MX.\",\n \"example\": \"USR-11141024-90b3-1bce-cac9-c06ced52ab4c\"\n }\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-72ec5185-2426-4bb4-a31f-9b4bbe455445" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-ae222af4-ce2c-416f-8973-14e105392786" }, { "name": "Delete a budget", "id": "5abf1456-082a-43e5-b407-a18871fb3947", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/budgets/:budget_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "budgets", ":budget_guid" ], "variable": [ { "id": "6a370d59-6592-4009-b6cd-3cf1b9393f5a", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "1a751ed8-8589-4829-84be-b5cf8658ceb2", "key": "budget_guid", "value": "", "description": "(Required) The unique identifier for the budget. Defined by MX." } ] }, "description": "Delete a budget." }, "response": [ { "id": "1ca39ef6-bdbc-4eb0-9a79-2d93eb12bc92", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/budgets/:budget_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "budgets", ":budget_guid" ], "variable": [ { "key": "user_guid" }, { "key": "budget_guid" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-1ca39ef6-bdbc-4eb0-9a79-2d93eb12bc92" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-5abf1456-082a-43e5-b407-a18871fb3947" } ], "id": "412e4822-fccd-49e5-9bb4-77d98da44161", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-412e4822-fccd-49e5-9bb4-77d98da44161" }, { "name": "Create a budget", "id": "170d6894-d30f-4541-9d2e-02aa7aa27edb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"budget\": {\n \"category_guid\": \"\",\n \"parent_guid\": \"\",\n \"amount\": \"\",\n \"metadata\": \"\",\n \"skip_webhook\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/budgets", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "budgets" ], "variable": [ { "id": "9a7fbc84-53ab-4f47-a2b4-c74651cd55e7", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "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." }, "response": [ { "id": "2a10134c-f41d-4e92-ad47-4151c0e0da67", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"budget\": {\n \"category_guid\": \"\",\n \"parent_guid\": \"\",\n \"amount\": \"\",\n \"metadata\": \"\",\n \"skip_webhook\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/budgets", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "budgets" ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"budget\": {\n \"amount\": \"\",\n \"category_guid\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"is_exceeded\": \"\",\n \"is_off_track\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"off_track_percentage\": \"\",\n \"parent_guid\": \"\",\n \"percent_spent\": \"\",\n \"projected_spending\": \"\",\n \"revision\": \"\",\n \"transaction_total\": {\n \"description\": \"The cumulative amount of all transactions under the budget.\",\n \"example\": 1952.8\n },\n \"updated_at\": {\n \"description\": \"Date and time the budget was updated, represented in ISO 8601 format with timestamp.\",\n \"example\": \"2022-06-14T21:17:11+00:00\"\n },\n \"user_guid\": {\n \"description\": \"Unique identifier for the user. Defined by MX.\",\n \"example\": \"USR-11141024-90b3-1bce-cac9-c06ced52ab4c\"\n }\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-2a10134c-f41d-4e92-ad47-4151c0e0da67" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-170d6894-d30f-4541-9d2e-02aa7aa27edb" }, { "name": "List all budgets", "id": "dce5045e-4225-41e2-9c38-443706450337", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/budgets", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "budgets" ], "variable": [ { "id": "17cae88b-d477-462f-b36b-b2f17aaba78a", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "List all budgets" }, "response": [ { "id": "0f73850d-9eec-4c52-b91d-6d94edd6e27c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/budgets", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "budgets" ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"budget\": {\n \"amount\": \"\",\n \"category_guid\": \"\",\n \"created_at\": \"\",\n \"guid\": \"\",\n \"is_exceeded\": \"\",\n \"is_off_track\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"off_track_percentage\": \"\",\n \"parent_guid\": \"\",\n \"percent_spent\": \"\",\n \"projected_spending\": \"\",\n \"revision\": \"\",\n \"transaction_total\": {\n \"description\": \"The cumulative amount of all transactions under the budget.\",\n \"example\": 1952.8\n },\n \"updated_at\": {\n \"description\": \"Date and time the budget was updated, represented in ISO 8601 format with timestamp.\",\n \"example\": \"2022-06-14T21:17:11+00:00\"\n },\n \"user_guid\": {\n \"description\": \"Unique identifier for the user. Defined by MX.\",\n \"example\": \"USR-11141024-90b3-1bce-cac9-c06ced52ab4c\"\n }\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-0f73850d-9eec-4c52-b91d-6d94edd6e27c" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-dce5045e-4225-41e2-9c38-443706450337" } ], "id": "b2d28da4-4bf3-41b9-8472-215306e4d3a0", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b2d28da4-4bf3-41b9-8472-215306e4d3a0" }, { "name": "goals", "item": [ { "name": "{goal_guid}", "item": [ { "name": "Delete a goal", "id": "63e7fc4d-8f26-472c-a8f7-b82f706f2ead", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/goals/:goal_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "goals", ":goal_guid" ], "variable": [ { "id": "9c200ae2-3ef6-4180-b325-089b9ad76738", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "92a269a0-a5f1-4515-8606-b772882bd44c", "key": "goal_guid", "value": "", "description": "(Required) The unique identifier for a goal. Defined by MX." } ] }, "description": "Delete a goal." }, "response": [ { "id": "af12b5f7-291e-4036-afa7-1fdaac4af0b3", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/goals/:goal_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "goals", ":goal_guid" ], "variable": [ { "key": "user_guid" }, { "key": "goal_guid" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-af12b5f7-291e-4036-afa7-1fdaac4af0b3" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-63e7fc4d-8f26-472c-a8f7-b82f706f2ead" }, { "name": "Read a goal", "id": "58463e96-0e10-48fd-9e7d-6861cf55fe62", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/goals/:goal_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "goals", ":goal_guid" ], "variable": [ { "id": "3980d0a8-fb39-4e52-943f-12c113db7fd8", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "f4e9c9c7-2bda-4228-85c5-29d60b7d506f", "key": "goal_guid", "value": "", "description": "(Required) The unique identifier for a goal. Defined by MX." } ] }, "description": "Read a specific goal." }, "response": [ { "id": "2334c06a-964f-4709-ab20-efe9fb5796d4", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/goals/:goal_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "goals", ":goal_guid" ], "variable": [ { "key": "user_guid" }, { "key": "goal_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"goal\": {\n \"account_guid\": \"\",\n \"amount\": \"\",\n \"completed_at\": \"\",\n \"current_amount\": \"\",\n \"goal_type_name\": \"PAYOFF\",\n \"guid\": \"\",\n \"has_been_spent\": \"\",\n \"is_complete\": \"\",\n \"metadata\": \"\",\n \"meta_type_name\": \"\",\n \"name\": \"\",\n \"position\": \"\",\n \"projected_to_complete_at\": \"\",\n \"targeted_to_complete_at\": \"\",\n \"track_type_name\": \"DEBT_TRACK\",\n \"user_guid\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-2334c06a-964f-4709-ab20-efe9fb5796d4" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-58463e96-0e10-48fd-9e7d-6861cf55fe62" }, { "name": "Update a goal", "id": "3c9092b9-22eb-4b3f-a58e-e668773671a9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"goal\": {\n \"account_guid\": \"\",\n \"amount\": \"\",\n \"goal_type_name\": \"SAVE_AMOUNT\",\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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/goals/:goal_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "goals", ":goal_guid" ], "variable": [ { "id": "7478bb71-3187-4476-92b6-0ce62e90f784", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "ee5573fd-60a1-4876-8fe3-91d2461b7269", "key": "goal_guid", "value": "", "description": "(Required) The unique identifier for a goal. Defined by MX." } ] }, "description": "This endpoint updates a specific goal." }, "response": [ { "id": "299d057f-e21b-41be-9375-91c548d4bd21", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"goal\": {\n \"account_guid\": \"\",\n \"amount\": \"\",\n \"goal_type_name\": \"SAVE_AMOUNT\",\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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/goals/:goal_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "goals", ":goal_guid" ], "variable": [ { "key": "user_guid" }, { "key": "goal_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"goal\": {\n \"account_guid\": \"\",\n \"amount\": \"\",\n \"completed_at\": \"\",\n \"current_amount\": \"\",\n \"goal_type_name\": \"PAYOFF\",\n \"guid\": \"\",\n \"has_been_spent\": \"\",\n \"is_complete\": \"\",\n \"metadata\": \"\",\n \"meta_type_name\": \"\",\n \"name\": \"\",\n \"position\": \"\",\n \"projected_to_complete_at\": \"\",\n \"targeted_to_complete_at\": \"\",\n \"track_type_name\": \"DEBT_TRACK\",\n \"user_guid\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-299d057f-e21b-41be-9375-91c548d4bd21" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-3c9092b9-22eb-4b3f-a58e-e668773671a9" } ], "id": "a98ef09d-4c69-4b63-9cbb-7533b44868dc", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-a98ef09d-4c69-4b63-9cbb-7533b44868dc" }, { "name": "reposition", "item": [ { "name": "Reposition goals", "id": "61269bde-2c9b-4135-afe7-d431cf794023", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"goals\": [\n {\n \"guid\": \"\",\n \"position\": \"\"\n },\n {\n \"guid\": \"\",\n \"position\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/goals/reposition", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "goals", "reposition" ], "variable": [ { "id": "af2d5d88-c53c-4802-a236-7b40c521bc82", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "This endpoint repositions goal priority levels. If one goal is set to a lower priority, then any other goals need to be adjusted accordingly." }, "response": [ { "id": "4a0f4579-32c9-4351-a829-882f369a4af0", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"goals\": [\n {\n \"guid\": \"\",\n \"position\": \"\"\n },\n {\n \"guid\": \"\",\n \"position\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/goals/reposition", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "goals", "reposition" ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"goals\": [\n {\n \"account_guid\": \"\",\n \"amount\": \"\",\n \"current_amount\": \"\",\n \"guid\": \"\",\n \"goal_type_name\": \"PAYOFF\",\n \"meta_type_name\": \"\",\n \"name\": \"\",\n \"completed_at\": \"\",\n \"has_been_spent\": \"\",\n \"is_complete\": \"\",\n \"metadata\": \"\",\n \"position\": \"\",\n \"projected_to_complete_at\": \"\",\n \"targeted_to_complete_at\": \"\",\n \"track_type_name\": \"EMERGENCY_FUND_TRACK\",\n \"user_guid\": \"\"\n },\n {\n \"account_guid\": \"\",\n \"amount\": \"\",\n \"current_amount\": \"\",\n \"guid\": \"\",\n \"goal_type_name\": \"SAVE_AMOUNT\",\n \"meta_type_name\": \"\",\n \"name\": \"\",\n \"completed_at\": \"\",\n \"has_been_spent\": \"\",\n \"is_complete\": \"\",\n \"metadata\": \"\",\n \"position\": \"\",\n \"projected_to_complete_at\": \"\",\n \"targeted_to_complete_at\": \"\",\n \"track_type_name\": \"RETIREMENT_TRACK\",\n \"user_guid\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-4a0f4579-32c9-4351-a829-882f369a4af0" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-61269bde-2c9b-4135-afe7-d431cf794023" } ], "id": "18fd0afb-01b5-4f39-87e6-1d6362ff8cab", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-18fd0afb-01b5-4f39-87e6-1d6362ff8cab" }, { "name": "Create a goal", "id": "77e9b994-e9eb-466d-bb57-722364b3c80c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"goal\": {\n \"account_guid\": \"\",\n \"amount\": \"\",\n \"goal_type_name\": \"SAVE_AMOUNT\",\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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/goals", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "goals" ], "variable": [ { "id": "82a4c361-318b-45ad-b00c-d5a98f9a3917", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "Create a goal. This endpoint accepts the optional `MX-Skip-Webhook` header and `skip_webhook` parameter." }, "response": [ { "id": "687185ce-7b50-4d8d-b5da-ea533b79bf1b", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"goal\": {\n \"account_guid\": \"\",\n \"amount\": \"\",\n \"goal_type_name\": \"SAVE_AMOUNT\",\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": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/goals", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "goals" ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"goal\": {\n \"account_guid\": \"\",\n \"amount\": \"\",\n \"completed_at\": \"\",\n \"current_amount\": \"\",\n \"goal_type_name\": \"PAYOFF\",\n \"guid\": \"\",\n \"has_been_spent\": \"\",\n \"is_complete\": \"\",\n \"metadata\": \"\",\n \"meta_type_name\": \"\",\n \"name\": \"\",\n \"position\": \"\",\n \"projected_to_complete_at\": \"\",\n \"targeted_to_complete_at\": \"\",\n \"track_type_name\": \"DEBT_TRACK\",\n \"user_guid\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-687185ce-7b50-4d8d-b5da-ea533b79bf1b" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-77e9b994-e9eb-466d-bb57-722364b3c80c" }, { "name": "List goals", "id": "f92671d8-fd00-4f53-83ab-8436026f2d35", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/goals?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "goals" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "6ccad4d0-8a1f-4fe1-9308-d0a2f076d314", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "List all goals a user can set." }, "response": [ { "id": "64e363a4-7f38-41de-a2fe-ef22de7e9756", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/goals?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "goals" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"goals\": [\n {\n \"account_guid\": \"\",\n \"amount\": \"\",\n \"current_amount\": \"\",\n \"guid\": \"\",\n \"goal_type_name\": \"PAYOFF\",\n \"meta_type_name\": \"\",\n \"name\": \"\",\n \"completed_at\": \"\",\n \"has_been_spent\": \"\",\n \"is_complete\": \"\",\n \"metadata\": \"\",\n \"position\": \"\",\n \"projected_to_complete_at\": \"\",\n \"targeted_to_complete_at\": \"\",\n \"track_type_name\": \"RETIREMENT_TRACK\",\n \"user_guid\": \"\"\n },\n {\n \"account_guid\": \"\",\n \"amount\": \"\",\n \"current_amount\": \"\",\n \"guid\": \"\",\n \"goal_type_name\": \"SAVE_AMOUNT\",\n \"meta_type_name\": \"\",\n \"name\": \"\",\n \"completed_at\": \"\",\n \"has_been_spent\": \"\",\n \"is_complete\": \"\",\n \"metadata\": \"\",\n \"position\": \"\",\n \"projected_to_complete_at\": \"\",\n \"targeted_to_complete_at\": \"\",\n \"track_type_name\": \"SAVINGS_TRACK\",\n \"user_guid\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-64e363a4-7f38-41de-a2fe-ef22de7e9756" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-f92671d8-fd00-4f53-83ab-8436026f2d35" } ], "id": "137df42f-d396-4b4b-802b-6832fd588740", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-137df42f-d396-4b4b-802b-6832fd588740" }, { "name": "notifications", "item": [ { "name": "{notification_guid}", "item": [ { "name": "Read notifications", "id": "9e4fda02-406d-4a21-98e7-f678c56d9cbf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/notifications/:notification_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "notifications", ":notification_guid" ], "variable": [ { "id": "159c9cf7-7418-428b-a845-9de3474f50ee", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "af6d416d-0e34-47f8-8bc2-15640a00ae6a", "key": "notification_guid", "value": "", "description": "(Required) The unique identifier for notifications. Defined by MX." } ] }, "description": "Can pull up any notification associated with the user, including notifications created by MX for other channels besides `PUSH`.\n" }, "response": [ { "id": "6d76aae0-a9d8-4a71-8277-37337cbe3579", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/notifications/:notification_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "notifications", ":notification_guid" ], "variable": [ { "key": "user_guid" }, { "key": "notification_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"notification\": {\n \"channel\": \"SMS\",\n \"content\": \"\",\n \"created_at\": \"\",\n \"deep_link_guid\": {\n \"description\": \"The unique identifier for objects that directly trigger a notification. For example, `TRANSACTION_FEE_CHARGE` and `TRANSACTION_EXPENSE_LARGE` notification types will have a transaction guid in this field.\",\n \"example\": \"BGT-e386a323-e452-47f2-b2fd-1ac3c18533de\"\n },\n \"delivered_at\": {\n \"description\": \"Date and time the notification was delivered, represented in ISO 8601 format with timestamp.\"\n },\n \"entity_guid\": {\n \"description\": \"The unique identifier of the entity that the notification is attached to.\",\n \"example\": \"BGT-e386a323-e452-47f2-b2fd-1ac3c18533de\"\n },\n \"guid\": {\n \"description\": \"Unique identifier for the notification. Defined by MX.\",\n \"example\": \"NTF-b53294f5-2356-4782-9f81-ae064c42b40a\"\n },\n \"has_been_delivered\": {\n \"description\": \"Indicates if the notification has been delivered to the user.\",\n \"example\": true\n },\n \"has_been_viewed\": {\n \"description\": \"Indicates if the notification has been viewed by the user.\",\n \"example\": false\n },\n \"notification_type\": {\n \"description\": \"The type of notification. See [Notification Types](/api-reference/platform-api/reference/notifications-fields#notification-types).\",\n \"example\": 2\n },\n \"subject\": {\n \"description\": \"The notification summary text. Usually the same text used for \u201cin-app\u201d or SMS notifications.\",\n \"example\": \"Your Fees & Charges budget projection\"\n },\n \"threshold\": {\n \"example\": 325\n }\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6d76aae0-a9d8-4a71-8277-37337cbe3579" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-9e4fda02-406d-4a21-98e7-f678c56d9cbf" } ], "id": "35aafdd5-569b-4b11-9bcc-195138c075bd", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-35aafdd5-569b-4b11-9bcc-195138c075bd" }, { "name": "Create a notification", "id": "ca23b29d-bc95-4c75-87b0-263a872188b4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"notification\": {\n \"content\": \"\",\n \"subject\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/notifications", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "notifications" ], "variable": [ { "id": "3e4d2c19-2d29-4c54-94fd-de5166816935", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "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." }, "response": [ { "id": "05b892c0-0c8f-44d9-9479-6056c4dffad3", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"notification\": {\n \"content\": \"\",\n \"subject\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/notifications", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "notifications" ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"notification\": {\n \"channel\": \"SMS\",\n \"content\": \"\",\n \"created_at\": \"\",\n \"deep_link_guid\": {\n \"description\": \"The unique identifier for objects that directly trigger a notification. For example, `TRANSACTION_FEE_CHARGE` and `TRANSACTION_EXPENSE_LARGE` notification types will have a transaction guid in this field.\",\n \"example\": \"BGT-e386a323-e452-47f2-b2fd-1ac3c18533de\"\n },\n \"delivered_at\": {\n \"description\": \"Date and time the notification was delivered, represented in ISO 8601 format with timestamp.\"\n },\n \"entity_guid\": {\n \"description\": \"The unique identifier of the entity that the notification is attached to.\",\n \"example\": \"BGT-e386a323-e452-47f2-b2fd-1ac3c18533de\"\n },\n \"guid\": {\n \"description\": \"Unique identifier for the notification. Defined by MX.\",\n \"example\": \"NTF-b53294f5-2356-4782-9f81-ae064c42b40a\"\n },\n \"has_been_delivered\": {\n \"description\": \"Indicates if the notification has been delivered to the user.\",\n \"example\": true\n },\n \"has_been_viewed\": {\n \"description\": \"Indicates if the notification has been viewed by the user.\",\n \"example\": false\n },\n \"notification_type\": {\n \"description\": \"The type of notification. See [Notification Types](/api-reference/platform-api/reference/notifications-fields#notification-types).\",\n \"example\": 2\n },\n \"subject\": {\n \"description\": \"The notification summary text. Usually the same text used for \u201cin-app\u201d or SMS notifications.\",\n \"example\": \"Your Fees & Charges budget projection\"\n },\n \"threshold\": {\n \"example\": 325\n }\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-05b892c0-0c8f-44d9-9479-6056c4dffad3" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-ca23b29d-bc95-4c75-87b0-263a872188b4" }, { "name": "List notifications", "id": "1cee870d-576a-4a8e-8ef2-33dd58db2286", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/notifications?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "notifications" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "id": "e406d1b8-aab6-4c9c-92b5-bf5f0b392390", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "All notifications for the user can be listed, including notifications created by MX for other channels besides `PUSH`." }, "response": [ { "id": "9ae2eb9c-345c-48ee-a3bc-3db733870c84", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/notifications?page=&records_per_page=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "notifications" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" } ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-9ae2eb9c-345c-48ee-a3bc-3db733870c84" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-1cee870d-576a-4a8e-8ef2-33dd58db2286" } ], "id": "fe45de46-9bd5-4d12-ac11-5ef6b3aa7f6a", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-fe45de46-9bd5-4d12-ac11-5ef6b3aa7f6a" }, { "name": "repeating_transactions", "item": [ { "name": "{repeating_transaction_guid}", "item": [ { "name": "Get a Repeating Transaction", "id": "3e2cc65c-cab3-4ea8-b378-04f00c5cad93", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/repeating_transactions/:repeating_transaction_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "repeating_transactions", ":repeating_transaction_guid" ], "variable": [ { "id": "dfd1e703-f6d7-4961-88db-2fc5a275d062", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "6a1be654-0ac7-4212-b0ac-240a8a8ad000", "key": "repeating_transaction_guid", "value": "", "description": "(Required) The unique id for a recurring transaction." } ] }, "description": "Get a Specific Repeating Transaction." }, "response": [ { "id": "e95a0195-1894-470e-a634-b6841fda76b6", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/repeating_transactions/:repeating_transaction_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "repeating_transactions", ":repeating_transaction_guid" ], "variable": [ { "key": "user_guid" }, { "key": "repeating_transaction_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"repeating_transactions\": [\n {\n \"account_guid\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"member_guid\": \"\",\n \"merchant_guid\": \"\",\n \"last_posted_date\": \"\",\n \"predicted_occurs_on\": \"\",\n \"recurrence_type\": \"\",\n \"user_guid\": \"\",\n \"repeating_transaction_type\": \"UNKNOWN\",\n \"transaction_type\": \"DEBIT\"\n },\n {\n \"account_guid\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"member_guid\": \"\",\n \"merchant_guid\": \"\",\n \"last_posted_date\": \"\",\n \"predicted_occurs_on\": \"\",\n \"recurrence_type\": \"\",\n \"user_guid\": \"\",\n \"repeating_transaction_type\": \"BILL\",\n \"transaction_type\": \"DEBIT\"\n }\n ]\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e95a0195-1894-470e-a634-b6841fda76b6" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-3e2cc65c-cab3-4ea8-b378-04f00c5cad93" } ], "id": "ea472bac-29d5-4b29-89d9-709d8346f229", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-ea472bac-29d5-4b29-89d9-709d8346f229" }, { "name": "List Repeating Transactions", "id": "2b0c77a3-75e4-4404-af97-8f5ba075419b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/repeating_transactions", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "repeating_transactions" ], "variable": [ { "id": "d49ba840-3099-467d-9b9c-6a44d524d2cd", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "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)." }, "response": [ { "id": "98cef916-09fe-4928-a068-8c276ea9c0b1", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/repeating_transactions", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "repeating_transactions" ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"repeating_transactions\": [\n {\n \"account_guid\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"member_guid\": \"\",\n \"merchant_guid\": \"\",\n \"last_posted_date\": \"\",\n \"predicted_occurs_on\": \"\",\n \"recurrence_type\": \"\",\n \"user_guid\": \"\",\n \"repeating_transaction_type\": \"UNKNOWN\",\n \"transaction_type\": \"DEBIT\"\n },\n {\n \"account_guid\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"guid\": \"\",\n \"member_guid\": \"\",\n \"merchant_guid\": \"\",\n \"last_posted_date\": \"\",\n \"predicted_occurs_on\": \"\",\n \"recurrence_type\": \"\",\n \"user_guid\": \"\",\n \"repeating_transaction_type\": \"BILL\",\n \"transaction_type\": \"DEBIT\"\n }\n ]\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-98cef916-09fe-4928-a068-8c276ea9c0b1" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-2b0c77a3-75e4-4404-af97-8f5ba075419b" } ], "id": "49c1be5e-7377-43d3-8728-e833f4bc1985", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-49c1be5e-7377-43d3-8728-e833f4bc1985" }, { "name": "micro_deposits", "item": [ { "name": "{micro_deposit_guid}", "item": [ { "name": "Delete a microdeposit", "id": "10c6ef7f-0477-4fc8-b0e8-3fc208bce9ae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/micro_deposits/:micro_deposit_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "micro_deposits", ":micro_deposit_guid" ], "variable": [ { "id": "cca384e4-c7f3-4a3f-934e-870e821decf0", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "c55e3b18-5660-4c2f-96ef-2b3195dba27c", "key": "micro_deposit_guid", "value": "", "description": "(Required) The unique identifier for the microdeposit. Defined by MX." } ] }, "description": "Use this endpoint to delete the specified microdeposit." }, "response": [ { "id": "568db077-8cf4-47e2-9800-11eb65ab971a", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/micro_deposits/:micro_deposit_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "micro_deposits", ":micro_deposit_guid" ], "variable": [ { "key": "user_guid" }, { "key": "micro_deposit_guid" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-568db077-8cf4-47e2-9800-11eb65ab971a" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-10c6ef7f-0477-4fc8-b0e8-3fc208bce9ae" }, { "name": "Read a microdeposit for a user", "id": "4aa5e2a9-6428-43a9-bec8-d7867a11cd8b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/micro_deposits/:micro_deposit_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "micro_deposits", ":micro_deposit_guid" ], "variable": [ { "id": "95fba299-004f-4c21-83b8-bc33d8093a33", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "0947a509-0bed-47b4-ad9a-97165cbed734", "key": "micro_deposit_guid", "value": "", "description": "(Required) The unique identifier for the microdeposit. Defined by MX." } ] }, "description": "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." }, "response": [ { "id": "bbe987fb-dfc7-4e15-857f-39d3ffd0df39", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/micro_deposits/:micro_deposit_guid", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "micro_deposits", ":micro_deposit_guid" ], "variable": [ { "key": "user_guid" }, { "key": "micro_deposit_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-bbe987fb-dfc7-4e15-857f-39d3ffd0df39" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-4aa5e2a9-6428-43a9-bec8-d7867a11cd8b" } ], "id": "45093f25-24d6-40f5-bda1-ac5b4a6523b1", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-45093f25-24d6-40f5-bda1-ac5b4a6523b1" }, { "name": "List all microdeposits for a user", "id": "5171be1d-458a-43f8-8219-ae3304f30eb8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/micro_deposits", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "micro_deposits" ], "variable": [ { "id": "a9041fdf-c976-46c7-8401-63a7aea19cb4", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID." }, "response": [ { "id": "f251e638-4e9a-4317-bdeb-2b80eda2e841", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/micro_deposits", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "micro_deposits" ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"micro_deposits\": [\n {\n \"error_message\": \"\",\n \"guid\": \"\",\n \"institution_code\": \"\",\n \"institution_name\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"error_message\": \"\",\n \"guid\": \"\",\n \"institution_code\": \"\",\n \"institution_name\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\",\n \"verified_at\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-f251e638-4e9a-4317-bdeb-2b80eda2e841" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-5171be1d-458a-43f8-8219-ae3304f30eb8" }, { "name": "Create or pre-initiate a microdeposit", "id": "30562e07-0a51-4089-a055-fabbfd786a8b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"micro_deposit\": {\n \"account_number\": \"\",\n \"account_type\": \"LINE_OF_CREDIT\",\n \"routing_number\": \"\",\n \"account_name\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/micro_deposits", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "micro_deposits" ], "variable": [ { "id": "b24f5cac-2045-4b02-afee-121e798711c1", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "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" }, "response": [ { "id": "ad63fd9b-9b3a-4222-a69f-6f2ea937225f", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"micro_deposit\": {\n \"account_number\": \"\",\n \"account_type\": \"LINE_OF_CREDIT\",\n \"routing_number\": \"\",\n \"account_name\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:user_guid/micro_deposits", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "micro_deposits" ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-ad63fd9b-9b3a-4222-a69f-6f2ea937225f" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-30562e07-0a51-4089-a055-fabbfd786a8b" } ], "id": "a5a5bce8-c724-485b-9aba-4cbf531e7214", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-a5a5bce8-c724-485b-9aba-4cbf531e7214" }, { "name": "account_verifications", "item": [ { "name": "List all verifications for a user", "id": "eaa89680-96a0-4aca-8b23-2b8f29591c94", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/account_verifications", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "account_verifications" ], "variable": [ { "id": "ecb8521e-453c-4cad-b03f-f166bc0591c4", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "description": "This endpoint returns a list of the account verifications associated with the user, as well as the status of those verifications.\n" }, "response": [ { "id": "0d0765e3-fd90-4336-922e-0d4bd0e873a5", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users/:user_guid/account_verifications", "host": [ "{{baseUrl}}" ], "path": [ "users", ":user_guid", "account_verifications" ], "variable": [ { "key": "user_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-0d0765e3-fd90-4336-922e-0d4bd0e873a5" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-eaa89680-96a0-4aca-8b23-2b8f29591c94" } ], "id": "dec23ada-1367-44d8-8a61-254de8de2d58", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-dec23ada-1367-44d8-8a61-254de8de2d58" } ], "id": "11d6ca19-9d88-45b4-8189-9daa895225c0", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-11d6ca19-9d88-45b4-8189-9daa895225c0" }, { "name": "List users", "id": "e7b434f0-986c-41b5-ad3a-66d97bf43638", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users?page=&records_per_page=&id=&email=&is_disabled=", "host": [ "{{baseUrl}}" ], "path": [ "users" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" }, { "description": "The user `id` to search for.", "key": "id", "value": "" }, { "description": "The user `email` to search for.", "key": "email", "value": "" }, { "description": "Search for users that are disabled.", "key": "is_disabled", "value": "" } ] }, "description": "Use this endpoint to list every user you've created in the MX Platform API." }, "response": [ { "id": "72c71d78-40f5-42a1-92b5-fece2d7ebbbf", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/users?page=&records_per_page=&id=&email=&is_disabled=", "host": [ "{{baseUrl}}" ], "path": [ "users" ], "query": [ { "description": "Results are paginated. Specify current page.", "key": "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.", "key": "records_per_page", "value": "" }, { "description": "The user `id` to search for.", "key": "id", "value": "" }, { "description": "The user `email` to search for.", "key": "email", "value": "" }, { "description": "Search for users that are disabled.", "key": "is_disabled", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": [\n {\n \"email\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_disabled\": \"\",\n \"metadata\": \"\"\n },\n {\n \"email\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_disabled\": \"\",\n \"metadata\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-72c71d78-40f5-42a1-92b5-fece2d7ebbbf" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-e7b434f0-986c-41b5-ad3a-66d97bf43638" }, { "name": "Create user", "id": "8e3a37a1-50da-4d3e-80e8-943325aa45d8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"email\": \"\",\n \"id\": \"\",\n \"is_disabled\": \"\",\n \"metadata\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users", "host": [ "{{baseUrl}}" ], "path": [ "users" ] }, "description": "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\u2019s data until they are no longer disabled." }, "response": [ { "id": "da3904d1-17c9-4f88-8a09-4832571e920c", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"email\": \"\",\n \"id\": \"\",\n \"is_disabled\": \"\",\n \"metadata\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users", "host": [ "{{baseUrl}}" ], "path": [ "users" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"user\": {\n \"email\": \"\",\n \"guid\": \"\",\n \"id\": \"\",\n \"is_disabled\": \"\",\n \"metadata\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-da3904d1-17c9-4f88-8a09-4832571e920c" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-8e3a37a1-50da-4d3e-80e8-943325aa45d8" } ], "id": "da2cc17d-accf-41e1-ab36-99cada6c31d7", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-da2cc17d-accf-41e1-ab36-99cada6c31d7" }, { "name": "tokens", "item": [ { "name": "View a List of Tokens", "id": "fab86795-397b-4fc7-aa2a-342147bf3258", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"scope\": {\n \"account_guid\": \"\",\n \"member_guid\": \"\",\n \"user_guid\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tokens", "host": [ "{{baseUrl}}" ], "path": [ "tokens" ] }, "description": "View a list of tokens that exist for a user, member, or account." }, "response": [ { "id": "12141f9f-d8a6-4cb5-8bd0-a795054adf34", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"scope\": {\n \"account_guid\": \"\",\n \"member_guid\": \"\",\n \"user_guid\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tokens", "host": [ "{{baseUrl}}" ], "path": [ "tokens" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-12141f9f-d8a6-4cb5-8bd0-a795054adf34" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-fab86795-397b-4fc7-aa2a-342147bf3258" } ], "id": "432ea067-2c13-41db-aff9-0429dcae5980", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-432ea067-2c13-41db-aff9-0429dcae5980" }, { "name": "account", "item": [ { "name": "account_numbers", "item": [ { "name": "Request an account number (Processors Only)", "id": "ae1e0d8b-39de-4dae-bebb-85a9c69b139e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/account/account_numbers", "host": [ "{{baseUrl}}" ], "path": [ "account", "account_numbers" ] }, "description": "Get account information such as routing number and account number, scoped to your access token." }, "response": [ { "id": "12ec651d-0199-428e-b725-199586d047ee", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/account/account_numbers", "host": [ "{{baseUrl}}" ], "path": [ "account", "account_numbers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-12ec651d-0199-428e-b725-199586d047ee" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-ae1e0d8b-39de-4dae-bebb-85a9c69b139e" } ], "id": "6e789014-3191-4630-ad1a-1d6e9cff14ab", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-6e789014-3191-4630-ad1a-1d6e9cff14ab" }, { "name": "check_balance", "item": [ { "name": "Check Real Time Account Balance (Processors Only)", "id": "0e06819b-f2ad-4f41-83ce-3f2f3df17512", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/account/check_balance", "host": [ "{{baseUrl}}" ], "path": [ "account", "check_balance" ] }, "description": "Check the real-time account balance using your access token." }, "response": [ { "id": "f7f115ce-3735-4374-a967-56b3847a8591", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/account/check_balance", "host": [ "{{baseUrl}}" ], "path": [ "account", "check_balance" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"member\": {\n \"aggregated_at\": \"\",\n \"background_aggregation_is_disabled\": \"\",\n \"connection_status\": \"PREVENTED\",\n \"connection_status_message\": \"\",\n \"error\": {},\n \"guid\": \"\",\n \"id\": \"\",\n \"institution_code\": \"\",\n \"institution_guid\": \"\",\n \"is_being_aggregated\": \"\",\n \"is_managed_by_user\": \"\",\n \"is_manual\": \"\",\n \"is_oauth\": \"\",\n \"metadata\": \"\",\n \"most_recent_job_detail_code\": \"\",\n \"most_recent_job_detail_text\": \"\",\n \"most_recent_job_guid\": \"\",\n \"name\": \"\",\n \"needs_updated_credentials\": \"\",\n \"oauth_window_uri\": \"\",\n \"successfully_aggregated_at\": \"\",\n \"use_cases\": [\n \"PFM\",\n \"PFM\"\n ],\n \"user_guid\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-f7f115ce-3735-4374-a967-56b3847a8591" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-0e06819b-f2ad-4f41-83ce-3f2f3df17512" } ], "id": "b27bb9cd-7a2a-4657-bfbc-5d47d552fe3c", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b27bb9cd-7a2a-4657-bfbc-5d47d552fe3c" }, { "name": "transactions", "item": [ { "name": "Get account owner information (Processors Only)", "id": "a2912120-2f43-433e-b34c-249a33747cea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/account/transactions", "host": [ "{{baseUrl}}" ], "path": [ "account", "transactions" ] }, "description": "Get account owner information (Processors Only)" }, "response": [ { "id": "f9510208-b0f0-485a-a1f1-a9c7c0175d73", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/account/transactions", "host": [ "{{baseUrl}}" ], "path": [ "account", "transactions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"pagination\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total_entries\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-f9510208-b0f0-485a-a1f1-a9c7c0175d73" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-a2912120-2f43-433e-b34c-249a33747cea" } ], "id": "96b19572-df56-4279-9737-dbead4885c02", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-96b19572-df56-4279-9737-dbead4885c02" } ], "id": "352d717d-6392-4eb1-ae97-88004cd0d2f9", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-352d717d-6392-4eb1-ae97-88004cd0d2f9" }, { "name": "payment_account", "item": [ { "name": "Read the account balance (Processors Only)", "id": "3216a00a-02e6-4bd7-82f0-17c067dd52ce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payment_account", "host": [ "{{baseUrl}}" ], "path": [ "payment_account" ] }, "description": "Read the account balance (Processors Only)" }, "response": [ { "id": "09bb8a8a-faf3-4433-a2a0-ceaa7f59f16f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_account", "host": [ "{{baseUrl}}" ], "path": [ "payment_account" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment_account\": {\n \"account_guid\": \"\",\n \"member_guid\": \"\",\n \"user_guid\": \"\",\n \"account_name\": \"\",\n \"account_number\": {\n \"description\": \"The banking account number associated with a particular account.\",\n \"example\": 6366816006\n },\n \"account_type\": \"LOAN\",\n \"available_balance\": \"\",\n \"balance\": \"\",\n \"created_at\": \"\",\n \"routing_number\": {\n \"description\": \"The routing number for the `account`.\",\n \"example\": 242722023\n },\n \"transit_number\": {\n \"description\": \"The five-digit number identifying the branch of a Canadian financial institution.\"\n },\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-09bb8a8a-faf3-4433-a2a0-ceaa7f59f16f" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-3216a00a-02e6-4bd7-82f0-17c067dd52ce" } ], "id": "33f9ff29-91c7-40fb-960c-7594a841b2e1", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-33f9ff29-91c7-40fb-960c-7594a841b2e1" }, { "name": "micro_deposits", "item": [ { "name": "{micro_deposit_guid}", "item": [ { "name": "verify", "item": [ { "name": "Verify a Microdeposit", "id": "bcedd88d-0737-4449-852d-dcf7c6ae3f92", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"micro_deposit\": {\n \"deposit_amount_1\": \"\",\n \"deposit_amount_2\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/micro_deposits/:micro_deposit_guid/verify", "host": [ "{{baseUrl}}" ], "path": [ "micro_deposits", ":micro_deposit_guid", "verify" ], "variable": [ { "id": "be4e7590-6a46-44fa-95f6-218b9ebb67ad", "key": "micro_deposit_guid", "value": "", "description": "(Required) The unique identifier for the microdeposit. Defined by MX." } ] }, "description": "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." }, "response": [ { "id": "c5c768a6-ab00-4688-ac77-adb48b61bf75", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"micro_deposit\": {\n \"deposit_amount_1\": \"\",\n \"deposit_amount_2\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/micro_deposits/:micro_deposit_guid/verify", "host": [ "{{baseUrl}}" ], "path": [ "micro_deposits", ":micro_deposit_guid", "verify" ], "variable": [ { "key": "micro_deposit_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-c5c768a6-ab00-4688-ac77-adb48b61bf75" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-bcedd88d-0737-4449-852d-dcf7c6ae3f92" } ], "id": "f4579468-99bf-45b8-8b82-f22fa304cad6", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-f4579468-99bf-45b8-8b82-f22fa304cad6" } ], "id": "c43b6de7-c3ad-42b9-810e-9df900af3745", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-c43b6de7-c3ad-42b9-810e-9df900af3745" } ], "id": "47febdad-a8e2-41f9-b2c4-7a69fa9a06a8", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-47febdad-a8e2-41f9-b2c4-7a69fa9a06a8" }, { "name": "credit_card_products", "item": [ { "name": "{credit_card_product_guid}", "item": [ { "name": "Read a Credit Card Product", "id": "4191ef00-29ab-4785-acd3-e52991ec777a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/credit_card_products/:credit_card_product_guid", "host": [ "{{baseUrl}}" ], "path": [ "credit_card_products", ":credit_card_product_guid" ], "variable": [ { "id": "914a8e79-bf81-438f-9d1d-e6b194f6c94f", "key": "credit_card_product_guid", "value": "", "description": "(Required) The required `credit_card_product_guid` can be found on the `account` object." } ] }, "description": "This endpoint returns the specified `credit_card_product` according to the unique GUID." }, "response": [ { "id": "ec2ac951-5244-4be4-a7c6-ee0bfee6c550", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/credit_card_products/:credit_card_product_guid", "host": [ "{{baseUrl}}" ], "path": [ "credit_card_products", ":credit_card_product_guid" ], "variable": [ { "key": "credit_card_product_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"credit_card_product\": {\n \"annual_fee\": \"\",\n \"duration_of_introductory_rate_on_balance_transfer\": \"\",\n \"duration_of_introductory_rate_on_purchases\": \"\",\n \"guid\": \"\",\n \"has_cashback_rewards\": \"\",\n \"has_other_rewards\": \"\",\n \"has_travel_rewards\": \"\",\n \"has_zero_introductory_annual_fee\": \"\",\n \"has_zero_percent_introductory_rate\": \"\",\n \"has_zero_percent_introductory_rate_on_balance_transfer\": \"\",\n \"is_accepting_applicants\": \"\",\n \"is_active_credit_card_product\": \"\",\n \"is_small_business_card\": \"\",\n \"name\": \"\"\n }\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-ec2ac951-5244-4be4-a7c6-ee0bfee6c550" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-4191ef00-29ab-4785-acd3-e52991ec777a" } ], "id": "8ba018d5-ade1-4338-aab1-f0b63ed51df5", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-8ba018d5-ade1-4338-aab1-f0b63ed51df5" } ], "id": "d821cdd6-9afc-4fcf-a8dd-02199aa43d89", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-d821cdd6-9afc-4fcf-a8dd-02199aa43d89" }, { "name": "vc", "item": [ { "name": "users", "item": [ { "name": "{user_guid}", "item": [ { "name": "members", "item": [ { "name": "{member_guid}", "item": [ { "name": "customers", "item": [ { "name": "Get Identity Data", "id": "944d6424-048c-400d-8140-e26824eb539a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/vnd.mx.api.v2beta+json" } ], "url": { "raw": "{{baseUrl}}/vc/users/:user_guid/members/:member_guid/customers", "host": [ "{{baseUrl}}" ], "path": [ "vc", "users", ":user_guid", "members", ":member_guid", "customers" ], "variable": [ { "id": "7ece9aa0-d8d9-48e3-9aa3-4ccfcc76cc94", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "0c6e5b37-ce72-4b55-b3b6-c97d070003c8", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." } ] }, "description": "Get an MX-issued verifiable credential of a user's identity data." }, "response": [ { "id": "41fb1ac0-676e-44fe-a6d5-511c05f9023e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/vnd.mx.api.v2beta+json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/vc/users/:user_guid/members/:member_guid/customers", "host": [ "{{baseUrl}}" ], "path": [ "vc", "users", ":user_guid", "members", ":member_guid", "customers" ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.mx.api.v2beta+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"verifiableCredential\": \"\"\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-41fb1ac0-676e-44fe-a6d5-511c05f9023e" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-944d6424-048c-400d-8140-e26824eb539a" } ], "id": "2a0c3575-52e7-44fb-90d5-ec05f9100225", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-2a0c3575-52e7-44fb-90d5-ec05f9100225" }, { "name": "accounts", "item": [ { "name": "Get Accounts Data", "id": "60cce372-5f7f-43b6-b4ae-2e044db0a100", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/vnd.mx.api.v2beta+json" } ], "url": { "raw": "{{baseUrl}}/vc/users/:user_guid/members/:member_guid/accounts", "host": [ "{{baseUrl}}" ], "path": [ "vc", "users", ":user_guid", "members", ":member_guid", "accounts" ], "variable": [ { "id": "00ccc52a-14c6-471c-9b7b-16484601fa07", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "f9417ffa-7f33-4d5c-b434-c637586ddb28", "key": "member_guid", "value": "", "description": "(Required) The unique id for a `member`." } ] }, "description": "Get an MX-issued verifiable credential of a user's accounts data." }, "response": [ { "id": "b526551e-a2cd-4637-b7c1-c6a257137f0d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/vnd.mx.api.v2beta+json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/vc/users/:user_guid/members/:member_guid/accounts", "host": [ "{{baseUrl}}" ], "path": [ "vc", "users", ":user_guid", "members", ":member_guid", "accounts" ], "variable": [ { "key": "user_guid" }, { "key": "member_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.mx.api.v2beta+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"verifiableCredential\": \"\"\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b526551e-a2cd-4637-b7c1-c6a257137f0d" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-60cce372-5f7f-43b6-b4ae-2e044db0a100" } ], "id": "9a9ca158-4b4e-4cd4-a0b3-f3f09bef64bd", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-9a9ca158-4b4e-4cd4-a0b3-f3f09bef64bd" } ], "id": "75d6b454-0c59-4bc1-893a-6882e98ef9cd", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-75d6b454-0c59-4bc1-893a-6882e98ef9cd" } ], "id": "a6f89195-3311-43aa-b505-73831457f14e", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-a6f89195-3311-43aa-b505-73831457f14e" }, { "name": "accounts", "item": [ { "name": "{account_guid}", "item": [ { "name": "transactions", "item": [ { "name": "Get Transactions Data", "id": "43d2ab52-d13d-450e-9661-5b9eb018e858", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/vnd.mx.api.v2beta+json" } ], "url": { "raw": "{{baseUrl}}/vc/users/:user_guid/accounts/:account_guid/transactions?startTime=&endTime=", "host": [ "{{baseUrl}}" ], "path": [ "vc", "users", ":user_guid", "accounts", ":account_guid", "transactions" ], "query": [ { "description": "Filter transactions from this date. Must be in the format YYYY-MM-DD. The range is limited to 1 year.", "key": "startTime", "value": "" }, { "description": "Filter transactions to this date. Must be in the format YYYY-MM-DD. The range is limited to 1 year.", "key": "endTime", "value": "" } ], "variable": [ { "id": "9e2d7f07-94cb-4be4-9647-eabc98c8272b", "key": "user_guid", "value": "", "description": "(Required) The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "id": "d6d49e34-78a0-4bcb-afbe-519e4bdc5a46", "key": "account_guid", "value": "", "description": "(Required) The unique id for an `account`." } ] }, "description": "Get an MX-issued verifiable credential of a user's transaction data." }, "response": [ { "id": "c5938cfa-8ffc-4d81-91e7-3f659f022d3d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) MX Platform API version.", "key": "Accept-Version", "value": "v20250224" }, { "key": "Accept", "value": "application/vnd.mx.api.v2beta+json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/vc/users/:user_guid/accounts/:account_guid/transactions?startTime=&endTime=", "host": [ "{{baseUrl}}" ], "path": [ "vc", "users", ":user_guid", "accounts", ":account_guid", "transactions" ], "query": [ { "description": "Filter transactions from this date. Must be in the format YYYY-MM-DD. The range is limited to 1 year.", "key": "startTime", "value": "" }, { "description": "Filter transactions to this date. Must be in the format YYYY-MM-DD. The range is limited to 1 year.", "key": "endTime", "value": "" } ], "variable": [ { "key": "user_guid" }, { "key": "account_guid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.mx.api.v2beta+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"verifiableCredential\": \"\"\n}", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-c5938cfa-8ffc-4d81-91e7-3f659f022d3d" } ], "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-43d2ab52-d13d-450e-9661-5b9eb018e858" } ], "id": "404b0a5d-a86f-495a-88d4-888828d1ea7e", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-404b0a5d-a86f-495a-88d4-888828d1ea7e" } ], "id": "45e2d0ec-9b54-4ef7-9c05-cb627dcdf5f7", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-45e2d0ec-9b54-4ef7-9c05-cb627dcdf5f7" } ], "id": "2aa40864-9954-4178-8ade-749f6c689c40", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-2aa40864-9954-4178-8ade-749f6c689c40" } ], "id": "ccfd1d3d-795a-4452-bf00-0026d8cbe934", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-ccfd1d3d-795a-4452-bf00-0026d8cbe934" } ], "id": "b422c39f-4c0b-428e-a930-b082170c0378", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-b422c39f-4c0b-428e-a930-b082170c0378" } ], "id": "70cb3fb8-463e-4b95-9686-2b66fe79d4ed", "createdAt": "2026-07-28T02:15:33.000Z", "updatedAt": "2026-07-28T02:15:33.000Z", "uid": "35240-70cb3fb8-463e-4b95-9686-2b66fe79d4ed" } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://int-api.mx.com" }, { "key": "statement_guid", "value": "" } ] }