{
"opencollection": "1.0.0",
"info": {
"name": "MX Platform accounts transactions API",
"version": "20111101"
},
"request": {
"auth": {
"type": "basic",
"username": "{{username}}",
"password": "{{password}}"
}
},
"items": [
{
"info": {
"name": "transactions",
"type": "folder"
},
"items": [
{
"info": {
"name": "Enhance transactions",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://int-api.mx.com/transactions/enhance",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "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)."
},
{
"info": {
"name": "List transactions by account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://int-api.mx.com/users/:user_guid/accounts/:account_guid/transactions",
"params": [
{
"name": "account_guid",
"value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
"type": "path",
"description": "The unique id for an `account`."
},
{
"name": "user_guid",
"value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
"type": "path",
"description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
},
{
"name": "page",
"value": "1",
"type": "query",
"description": "Results are paginated. Specify current page."
},
{
"name": "records_per_page",
"value": "10",
"type": "query",
"description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
},
{
"name": "from_date",
"value": "2024-01-01",
"type": "query",
"description": "Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided."
},
{
"name": "to_date",
"value": "2024-03-31",
"type": "query",
"description": "Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions."
},
{
"name": "from_created_at",
"value": "2024-01-01",
"type": "query",
"description": "Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months."
},
{
"name": "to_created_at",
"value": "2024-03-31",
"type": "query",
"description": "Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months."
},
{
"name": "from_updated_at",
"value": "2024-01-01",
"type": "query",
"description": "Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months."
},
{
"name": "to_updated_at",
"value": "2024-03-31",
"type": "query",
"description": "Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months."
},
{
"name": "category_guid",
"value": "",
"type": "query",
"description": "Filter transactions belonging to specified `category_guid`.\n\nFor example, `?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`."
},
{
"name": "category_guid[]",
"value": "",
"type": "query",
"description": "Filter transactions belonging to any specified `category_guid[]` in url.\n\nFor example, `?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`."
},
{
"name": "top_level_category_guid",
"value": "",
"type": "query",
"description": "Filter transactions belonging to specified `top_level_category_guid`. This must be top level category guid, use `category_guid` for subcategory guid.\n\nFor example, `?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`."
},
{
"name": "top_level_category_guid[]",
"value": "",
"type": "query",
"description": "Filter transactions belonging to any specified `top_level_category_guid[]` in url. This must be top level category guid(s), use `category_guid` for subcategory guid(s).\n\nFor example, `?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`."
},
{
"name": "includes",
"value": "repeating_transactions,merchants,classifications,geolocations",
"type": "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"
}
]
},
"docs": "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-tr"
},
{
"info": {
"name": "Create manual transaction",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://int-api.mx.com/users/:user_guid/accounts/:account_guid/transactions",
"params": [
{
"name": "user_guid",
"value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
"type": "path",
"description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
},
{
"name": "account_guid",
"value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
"type": "path",
"description": "The unique id for an `account`."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This endpoint can only be used to create manual transactions that are under a manual account. This endpoint accepts the optional MX-Skip-Webhook header and skip_webhook parameter."
},
{
"info": {
"name": "Update Transaction by Account",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://int-api.mx.com/users/:user_guid/members/:member_guid/accounts/:account_guid/transactions/:transaction_guid",
"params": [
{
"name": "user_guid",
"value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
"type": "path",
"description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
},
{
"name": "member_guid",
"value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
"type": "path",
"description": "The unique id for a `member`."
},
{
"name": "account_guid",
"value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
"type": "path",
"description": "The unique id for an `account`."
},
{
"name": "transaction_guid",
"value": "TRN-810828b0-5210-4878-9bd3-f4ce514f90c4",
"type": "path",
"description": "The unique id for a `transaction`."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use this endpoint to update a specific transaction according to its unique GUID."
},
{
"info": {
"name": "Extend history",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://int-api.mx.com/users/:user_guid/members/:member_guid/extend_history",
"params": [
{
"name": "member_guid",
"value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
"type": "path",
"description": "The unique id for a `member`."
},
{
"name": "user_guid",
"value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
"type": "path",
"description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
}
]
},
"docs": "Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication."
},
{
"info": {
"name": "List transactions by member",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://int-api.mx.com/users/:user_guid/members/:member_guid/transactions",
"params": [
{
"name": "member_guid",
"value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
"type": "path",
"description": "The unique id for a `member`."
},
{
"name": "user_guid",
"value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
"type": "path",
"description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
},
{
"name": "page",
"value": "1",
"type": "query",
"description": "Results are paginated. Specify current page."
},
{
"name": "records_per_page",
"value": "10",
"type": "query",
"description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
},
{
"name": "from_date",
"value": "2024-01-01",
"type": "query",
"description": "Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided."
},
{
"name": "to_date",
"value": "2024-03-31",
"type": "query",
"description": "Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions."
},
{
"name": "from_created_at",
"value": "2024-01-01",
"type": "query",
"description": "Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months."
},
{
"name": "to_created_at",
"value": "2024-03-31",
"type": "query",
"description": "Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months."
},
{
"name": "from_updated_at",
"value": "2024-01-01",
"type": "query",
"description": "Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months."
},
{
"name": "to_updated_at",
"value": "2024-03-31",
"type": "query",
"description": "Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months."
},
{
"name": "category_guid",
"value": "",
"type": "query",
"description": "Filter transactions belonging to specified `category_guid`.\n\nFor example, `?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`."
},
{
"name": "category_guid[]",
"value": "",
"type": "query",
"description": "Filter transactions belonging to any specified `category_guid[]` in url.\n\nFor example, `?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`."
},
{
"name": "top_level_category_guid",
"value": "",
"type": "query",
"description": "Filter transactions belonging to specified `top_level_category_guid`. This must be top level category guid, use `category_guid` for subcategory guid.\n\nFor example, `?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`."
},
{
"name": "top_level_category_guid[]",
"value": "",
"type": "query",
"description": "Filter transactions belonging to any specified `top_level_category_guid[]` in url. This must be top level category guid(s), use `category_guid` for subcategory guid(s).\n\nFor example, `?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`."
},
{
"name": "includes",
"value": "repeating_transactions,merchants,classifications,geolocations",
"type": "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"
}
]
},
"docs": "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/platf"
},
{
"info": {
"name": "List transactions by tag",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://int-api.mx.com/users/:user_guid/tags/:tag_guid/transactions",
"params": [
{
"name": "user_guid",
"value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
"type": "path",
"description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
},
{
"name": "tag_guid",
"value": "TAG-aef36e72-6294-4c38-844d-e573e80aed52",
"type": "path",
"description": "The unique id for a `tag`."
},
{
"name": "page",
"value": "1",
"type": "query",
"description": "Results are paginated. Specify current page."
},
{
"name": "records_per_page",
"value": "10",
"type": "query",
"description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
},
{
"name": "from_date",
"value": "2024-01-01",
"type": "query",
"description": "Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided."
},
{
"name": "to_date",
"value": "2024-03-31",
"type": "query",
"description": "Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions."
},
{
"name": "from_created_at",
"value": "2024-01-01",
"type": "query",
"description": "Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months."
},
{
"name": "to_created_at",
"value": "2024-03-31",
"type": "query",
"description": "Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months."
},
{
"name": "from_updated_at",
"value": "2024-01-01",
"type": "query",
"description": "Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months."
},
{
"name": "to_updated_at",
"value": "2024-03-31",
"type": "query",
"description": "Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months."
},
{
"name": "category_guid",
"value": "",
"type": "query",
"description": "Filter transactions belonging to specified `category_guid`.\n\nFor example, `?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`."
},
{
"name": "category_guid[]",
"value": "",
"type": "query",
"description": "Filter transactions belonging to any specified `category_guid[]` in url.\n\nFor example, `?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`."
},
{
"name": "top_level_category_guid",
"value": "",
"type": "query",
"description": "Filter transactions belonging to specified `top_level_category_guid`. This must be top level category guid, use `category_guid` for subcategory guid.\n\nFor example, `?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`."
},
{
"name": "top_level_category_guid[]",
"value": "",
"type": "query",
"description": "Filter transactions belonging to any specified `top_level_category_guid[]` in url. This must be top level category guid(s), use `category_guid` for subcategory guid(s).\n\nFor example, `?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`."
},
{
"name": "use_case",
"value": "MONEY_MOVEMENT",
"type": "query",
"description": "The use case associated with the member. Valid values are `PFM` and `MONEY_MOVEMENT`. For example, you can append either `?use_case=PFM` or `?use_case=MONEY_MOVEMENT`."
},
{
"name": "includes",
"value": "repeating_transactions,merchants,classifications,geolocations",
"type": "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"
}
]
},
"docs": "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 infor"
},
{
"info": {
"name": "Delete transaction rule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://int-api.mx.com/users/:user_guid/transaction_rules/:transaction_rule_guid",
"params": [
{
"name": "transaction_rule_guid",
"value": "TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3",
"type": "path",
"description": "The unique id for a `transaction_rule`."
},
{
"name": "user_guid",
"value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
"type": "path",
"description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
}
]
},
"docs": "Use this endpoint to permanently delete a transaction rule based on its unique GUID."
},
{
"info": {
"name": "List transactions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://int-api.mx.com/users/:user_guid/transactions",
"params": [
{
"name": "user_guid",
"value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
"type": "path",
"description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
},
{
"name": "page",
"value": "1",
"type": "query",
"description": "Results are paginated. Specify current page."
},
{
"name": "records_per_page",
"value": "10",
"type": "query",
"description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
},
{
"name": "from_date",
"value": "2024-01-01",
"type": "query",
"description": "Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided."
},
{
"name": "to_date",
"value": "2024-03-31",
"type": "query",
"description": "Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions."
},
{
"name": "from_created_at",
"value": "2024-01-01",
"type": "query",
"description": "Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months."
},
{
"name": "to_created_at",
"value": "2024-03-31",
"type": "query",
"description": "Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months."
},
{
"name": "from_updated_at",
"value": "2024-01-01",
"type": "query",
"description": "Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months."
},
{
"name": "to_updated_at",
"value": "2024-03-31",
"type": "query",
"description": "Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months."
},
{
"name": "category_guid",
"value": "",
"type": "query",
"description": "Filter transactions belonging to specified `category_guid`.\n\nFor example, `?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`."
},
{
"name": "category_guid[]",
"value": "",
"type": "query",
"description": "Filter transactions belonging to any specified `category_guid[]` in url.\n\nFor example, `?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`."
},
{
"name": "top_level_category_guid",
"value": "",
"type": "query",
"description": "Filter transactions belonging to specified `top_level_category_guid`. This must be top level category guid, use `category_guid` for subcategory guid.\n\nFor example, `?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`."
},
{
"name": "top_level_category_guid[]",
"value": "",
"type": "query",
"description": "Filter transactions belonging to any specified `top_level_category_guid[]` in url. This must be top level category guid(s), use `category_guid` for subcategory guid(s).\n\nFor example, `?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`."
},
{
"name": "use_case",
"value": "MONEY_MOVEMENT",
"type": "query",
"description": "The use case associated with the member. Valid values are `PFM` and `MONEY_MOVEMENT`. For example, you can append either `?use_case=PFM` or `?use_case=MONEY_MOVEMENT`."
},
{
"name": "includes",
"value": "repeating_transactions,merchants,classifications,geolocations",
"type": "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"
}
]
},
"docs": "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-referen"
},
{
"info": {
"name": "Read transaction",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://int-api.mx.com/users/:user_guid/transactions/:transaction_guid",
"params": [
{
"name": "user_guid",
"value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
"type": "path",
"description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
},
{
"name": "transaction_guid",
"value": "TRN-810828b0-5210-4878-9bd3-f4ce514f90c4",
"type": "path",
"description": "The unique id for a `transaction`."
},
{
"name": "includes",
"value": "repeating_transactions,merchants,classifications,geolocations",
"type": "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"
}
]
},
"docs": "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 Quer"
},
{
"info": {
"name": "Update transaction",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://int-api.mx.com/users/:user_guid/transactions/:transaction_guid",
"params": [
{
"name": "user_guid",
"value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
"type": "path",
"description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
},
{
"name": "transaction_guid",
"value": "TRN-810828b0-5210-4878-9bd3-f4ce514f90c4",
"type": "path",
"description": "The unique id for a `transaction`."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use this endpoint to update a specific transaction according to its unique GUID."
},
{
"info": {
"name": "Delete manual transactions",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://int-api.mx.com/users/:user_guid/transactions/:transaction_guid",
"params": [
{
"name": "user_guid",
"value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
"type": "path",
"description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
},
{
"name": "transaction_guid",
"value": "TRN-810828b0-5210-4878-9bd3-f4ce514f90c4",
"type": "path",
"description": "The unique id for a `transaction`."
}
]
},
"docs": "Delete a manual transaction. In the path, use the manual transaction guid as the `transaction_guid`, such as `MAN-810828b0-5210-4878-9bd3-f4ce514f90c4`."
},
{
"info": {
"name": "List Repeating Transactions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://int-api.mx.com/users/:user_guid/repeating_transactions",
"params": [
{
"name": "user_guid",
"value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
"type": "path",
"description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
}
]
},
"docs": "Retrieve a list of all recurring transactions for a user.
For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions)."
},
{
"info": {
"name": "Get a Repeating Transaction",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://int-api.mx.com/users/:user_guid/repeating_transactions/:repeating_transaction_guid",
"params": [
{
"name": "user_guid",
"value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
"type": "path",
"description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
},
{
"name": "repeating_transaction_guid",
"value": "TRN-810828b0-5210-4878-9bd3-f4ce514f90c4",
"type": "path",
"description": "The unique id for a recurring transaction."
}
]
},
"docs": "Get a Specific Repeating Transaction.
List For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions)"
},
{
"info": {
"name": "Create split transactions",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://int-api.mx.com/users/:user_guid/transactions/:transaction_guid/split",
"params": [
{
"name": "transaction_guid",
"value": "TRN-810828b0-5210-4878-9bd3-f4ce514f90c4",
"type": "path",
"description": "The unique id for a `transaction`."
},
{
"name": "user_guid",
"value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
"type": "path",
"description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This endpoint creates two or more child transactions that are branched from a previous transaction. This endpoint allows you to link multiple categories, descriptions, and amounts to a parent transaction. When a split transaction is created, the parent transaction's `has_been_split` field will automatically be updated to true and the child transactions' `parent_guid` will have the transaction guid of the parent. The total amount of the child transactions must equal the amount of the parent tran"
},
{
"info": {
"name": "Delete split transactions",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://int-api.mx.com/users/:user_guid/transactions/:transaction_guid/split",
"params": [
{
"name": "transaction_guid",
"value": "TRN-810828b0-5210-4878-9bd3-f4ce514f90c4",
"type": "path",
"description": "The unique id for a `transaction`."
},
{
"name": "user_guid",
"value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
"type": "path",
"description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
}
]
},
"docs": "This endpoint deletes all split transactions linked to a parent transaction, but it leaves the parent transaction active. This request will also update the parent transaction's has_been_split field to false. This endpoint accepts the optional MX-Skip-Webhook header."
},
{
"info": {
"name": "List transactions by account per member",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://int-api.mx.com/users/:user_guid/members/:member_guid/accounts/:account_guid/transactions",
"headers": [
{
"name": "Accept-Version",
"value": ""
}
],
"params": [
{
"name": "user_guid",
"value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
"type": "path",
"description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
},
{
"name": "account_guid",
"value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
"type": "path",
"description": "The unique id for an `account`."
},
{
"name": "member_guid",
"value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
"type": "path",
"description": "The unique id for a `member`."
},
{
"name": "page",
"value": "1",
"type": "query",
"description": "Results are paginated. Specify current page."
},
{
"name": "records_per_page",
"value": "10",
"type": "query",
"description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
},
{
"name": "from_date",
"value": "1666936800",
"type": "query",
"description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided."
},
{
"name": "to_date",
"value": "1698472800",
"type": "query",
"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."
},
{
"name": "from_created_at",
"value": "1666936800",
"type": "query",
"description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format."
},
{
"name": "to_created_at",
"value": "1698472800",
"type": "query",
"description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format."
},
{
"name": "from_updated_at",
"value": "1666936800",
"type": "query",
"description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format."
},
{
"name": "to_updated_at",
"value": "1698472800",
"type": "query",
"description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format."
},
{
"name": "includes",
"value": "repeating_transactions,merchants,classifications,geolocations",
"type": "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"
}
]
},
"docs": "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."
},
{
"info": {
"name": "Extend history",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://int-api.mx.com/users/:user_identifier/members/:member_identifier/extend_history",
"headers": [
{
"name": "Accept-Version",
"value": ""
}
],
"params": [
{
"name": "member_identifier",
"value": "",
"type": "path",
"description": "Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
},
{
"name": "user_identifier",
"value": "",
"type": "path",
"description": "Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
}
]
},
"docs": "Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication."
},
{
"info": {
"name": "List transactions by member",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://int-api.mx.com/users/:user_identifier/members/:member_identifier/transactions",
"headers": [
{
"name": "Accept-Version",
"value": ""
}
],
"params": [
{
"name": "user_identifier",
"value": "",
"type": "path",
"description": "Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
},
{
"name": "member_identifier",
"value": "",
"type": "path",
"description": "Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
},
{
"name": "page",
"value": "1",
"type": "query",
"description": "Results are paginated. Specify current page."
},
{
"name": "records_per_page",
"value": "10",
"type": "query",
"description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
},
{
"name": "from_date",
"value": "1666936800",
"type": "query",
"description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided."
},
{
"name": "to_date",
"value": "1698472800",
"type": "query",
"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."
},
{
"name": "from_created_at",
"value": "1666936800",
"type": "query",
"description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format."
},
{
"name": "to_created_at",
"value": "1698472800",
"type": "query",
"description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format."
},
{
"name": "from_timestamp",
"value": "1666936800",
"type": "query",
"description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format."
},
{
"name": "to_timestamp",
"value": "1698472800",
"type": "query",
"description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format."
},
{
"name": "from_updated_at",
"value": "1666936800",
"type": "query",
"description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format."
},
{
"name": "to_updated_at",
"value": "1698472800",
"type": "query",
"description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format."
},
{
"name": "includes",
"value": "repeating_transactions,merchants,classifications,geolocations",
"type": "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"
}
]
},
"docs": "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."
},
{
"info": {
"name": "List transactions by tag",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://int-api.mx.com/users/:user_identifier/tags/:tag_guid/transactions",
"headers": [
{
"name": "Accept-Version",
"value": ""
}
],
"params": [
{
"name": "user_identifier",
"value": "",
"type": "path",
"description": "Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
},
{
"name": "tag_guid",
"value": "TAG-aef36e72-6294-4c38-844d-e573e80aed52",
"type": "path",
"description": "The unique id for a `tag`."
},
{
"name": "page",
"value": "1",
"type": "query",
"description": "Results are paginated. Specify current page."
},
{
"name": "records_per_page",
"value": "10",
"type": "query",
"description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
},
{
"name": "from_date",
"value": "1666936800",
"type": "query",
"description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided."
},
{
"name": "to_date",
"value": "1698472800",
"type": "query",
"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."
},
{
"name": "from_created_at",
"value": "1666936800",
"type": "query",
"description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format."
},
{
"name": "to_created_at",
"value": "1698472800",
"type": "query",
"description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format."
},
{
"name": "from_updated_at",
"value": "1666936800",
"type": "query",
"description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format."
},
{
"name": "to_updated_at",
"value": "1698472800",
"type": "query",
"description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format."
},
{
"name": "includes",
"value": "repeating_transactions,merchants,classifications,geolocations",
"type": "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"
}
]
},
"docs": "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 infor"
},
{
"info": {
"name": "List transactions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://int-api.mx.com/users/:user_identifier/transactions",
"headers": [
{
"name": "Accept-Version",
"value": ""
}
],
"params": [
{
"name": "user_identifier",
"value": "",
"type": "path",
"description": "Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
},
{
"name": "page",
"value": "1",
"type": "query",
"description": "Results are paginated. Specify current page."
},
{
"name": "records_per_page",
"value": "10",
"type": "query",
"description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
},
{
"name": "from_date",
"value": "1666936800",
"type": "query",
"description": "Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided."
},
{
"name": "to_date",
"value": "1698472800",
"type": "query",
"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."
},
{
"name": "from_created_at",
"value": "1666936800",
"type": "query",
"description": "Filter transactions from the date the transaction was created. This only supports unix timestamp format."
},
{
"name": "to_created_at",
"value": "1698472800",
"type": "query",
"description": "Filter transaction to the date in which the transaction was created. This only supports unix timestamp format."
},
{
"name": "from_updated_at",
"value": "1666936800",
"type": "query",
"description": "Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format."
},
{
"name": "to_updated_at",
"value": "1698472800",
"type": "query",
"description": "Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format."
},
{
"name": "use_case",
"value": "",
"type": "query",
"description": "The use case associated with the member. Valid values are `PFM` and/or `MONEY_MOVEMENT`."
},
{
"name": "includes",
"value": "repeating_transactions,merchants,classifications,geolocations",
"type": "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"
}
]
},
"docs": "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."
},
{
"info": {
"name": "Read transaction by account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://int-api.mx.com/users/:user_identifier/members/:member_identifier/accounts/:account_identifier/transactions/:transaction_identifier",
"headers": [
{
"name": "Accept-Version",
"value": ""
}
],
"params": [
{
"name": "user_identifier",
"value": "",
"type": "path",
"description": "Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
},
{
"name": "member_identifier",
"value": "",
"type": "path",
"description": "Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
},
{
"name": "account_identifier",
"value": "",
"type": "path",
"description": "Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
},
{
"name": "transaction_identifier",
"value": "",
"type": "path",
"description": "Use either the transaction `id` you defined or the MX-defined transaction `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
},
{
"name": "includes",
"value": "repeating_transactions,merchants,classifications,geolocations",
"type": "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"
}
]
},
"docs": "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 "
},
{
"info": {
"name": "Update transaction",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://int-api.mx.com/users/:user_identifier/members/:member_identifier/accounts/:account_identifier/transactions/:transaction_identifier",
"headers": [
{
"name": "Accept-Version",
"value": ""
}
],
"params": [
{
"name": "user_identifier",
"value": "",
"type": "path",
"description": "Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
},
{
"name": "member_identifier",
"value": "",
"type": "path",
"description": "Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
},
{
"name": "account_identifier",
"value": "",
"type": "path",
"description": "Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
},
{
"name": "transaction_identifier",
"value": "",
"type": "path",
"description": "Use either the transaction `id` you defined or the MX-defined transaction `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use this endpoint to update the `description` of a specific transaction according to its unique GUID."
},
{
"info": {
"name": "Create split transactions by account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://int-api.mx.com/users/:user_identifier/members/:member_identifier/accounts/:account_identifier/transactions/:transaction_identifier/split",
"headers": [
{
"name": "Accept-Version",
"value": ""
}
],
"params": [
{
"name": "transaction_identifier",
"value": "",
"type": "path",
"description": "Use either the transaction `id` you defined or the MX-defined transaction `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
},
{
"name": "user_identifier",
"value": "",
"type": "path",
"description": "Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
},
{
"name": "member_identifier",
"value": "",
"type": "path",
"description": "Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
},
{
"name": "account_identifier",
"value": "",
"type": "path",
"description": "Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This endpoint creates two or more child transactions that are branched from a previous transaction. This endpoint allows you to link multiple categories, descriptions, and amounts to a parent transaction. When a split transaction is created, the parent transaction's `has_been_split` field will automatically be updated to true and the child transactions' `parent_guid` will have the transaction guid of the parent. The total amount of the child transactions must equal the amount of the parent tran"
},
{
"info": {
"name": "Delete split transactions by account",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://int-api.mx.com/users/:user_identifier/members/:member_identifier/accounts/:account_identifier/transactions/:transaction_identifier/split",
"headers": [
{
"name": "Accept-Version",
"value": ""
}
],
"params": [
{
"name": "transaction_identifier",
"value": "",
"type": "path",
"description": "Use either the transaction `id` you defined or the MX-defined transaction `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
},
{
"name": "user_identifier",
"value": "",
"type": "path",
"description": "Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
},
{
"name": "member_identifier",
"value": "",
"type": "path",
"description": "Use either the member `id` you defined or the MX-defined member `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
},
{
"name": "account_identifier",
"value": "",
"type": "path",
"description": "Use either the account `id` you defined or the MX-defined account `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
}
]
},
"docs": "This endpoint deletes all split transactions linked to a parent transaction, but it leaves the parent transaction active. This request will also update the parent transaction's has_been_split field to false. This endpoint accepts the optional MX-Skip-Webhook header."
}
]
}
],
"bundled": true
}