{
  "opencollection": "1.0.0",
  "info": {
    "name": "MX Platform Transactions API",
    "version": "0.1.0"
  },
  "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://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."
        },
        {
          "info": {
            "name": "List transactions by account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://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": "from_date",
                "value": "2015-09-20",
                "type": "query",
                "description": "Filter transactions from this date."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "Specify records per page."
              },
              {
                "name": "to_date",
                "value": "2019-10-20",
                "type": "query",
                "description": "Filter transactions to this date."
              },
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique id for a `user`."
              }
            ]
          },
          "docs": "This endpoint returns a list of the last 90 days of transactions associated with the specified account."
        },
        {
          "info": {
            "name": "Create manual transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mx.com/users/:user_guid/accounts/:account_guid/transactions",
            "params": [
              {
                "name": "user_guid",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the user."
              },
              {
                "name": "account_guid",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the 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": "List all transactions associated with an insight.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mx.com/users/:user_guid/insights/:insight_guid/transactions",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-1234-abcd",
                "type": "path",
                "description": "The unique identifier for the user. Defined by MX."
              },
              {
                "name": "insight_guid",
                "value": "BET-1234-abcd",
                "type": "path",
                "description": "The unique identifier for the insight. Defined by MX."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "Specify records per page."
              }
            ]
          },
          "docs": "Use this endpoint to list all the transactions associated with the insight."
        },
        {
          "info": {
            "name": "List managed transactions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mx.com/users/:user_guid/managed_members/:member_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": "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": "Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "Specify records per page."
              },
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique id for a `user`."
              }
            ]
          },
          "docs": "This endpoint returns a list of all the partner-managed transactions associated with the specified `account`, scoped through a `user` and a `member`."
        },
        {
          "info": {
            "name": "Create managed transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mx.com/users/:user_guid/managed_members/:member_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": "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 id for a `user`."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use this endpoint to create a new partner-managed `transaction`."
        },
        {
          "info": {
            "name": "Read managed transaction",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions/:transaction_guid",
            "params": [
              {
                "name": "account_guid",
                "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
                "type": "path",
                "description": "The unique id for an `account`."
              },
              {
                "name": "member_guid",
                "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
                "type": "path",
                "description": "The unique id for a `member`."
              },
              {
                "name": "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 id for a `user`."
              }
            ]
          },
          "docs": "Requests to this endpoint will return the attributes of the specified partner-managed `transaction`."
        },
        {
          "info": {
            "name": "Update managed transaction",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions/:transaction_guid",
            "params": [
              {
                "name": "account_guid",
                "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
                "type": "path",
                "description": "The unique id for an `account`."
              },
              {
                "name": "member_guid",
                "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
                "type": "path",
                "description": "The unique id for a `member`."
              },
              {
                "name": "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 id for a `user`."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use this endpoint to update the attributes of the specified partner_managed `transaction`."
        },
        {
          "info": {
            "name": "Delete managed transaction",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid/transactions/:transaction_guid",
            "params": [
              {
                "name": "account_guid",
                "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
                "type": "path",
                "description": "The unique id for an `account`."
              },
              {
                "name": "member_guid",
                "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
                "type": "path",
                "description": "The unique id for a `member`."
              },
              {
                "name": "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 id for a `user`."
              }
            ]
          },
          "docs": "Use this endpoint to delete the specified partner-managed `transaction`. The endpoint will respond with a status of `204 No Content` without a resource."
        },
        {
          "info": {
            "name": "List transactions by member",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mx.com/users/:user_guid/members/:member_guid/transactions",
            "params": [
              {
                "name": "from_date",
                "value": "2015-09-20",
                "type": "query",
                "description": "Filter transactions from this date."
              },
              {
                "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": "Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "Specify records per page."
              },
              {
                "name": "to_date",
                "value": "2019-10-20",
                "type": "query",
                "description": "Filter transactions to this date."
              },
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique id for a `user`."
              }
            ]
          },
          "docs": "Requests to this endpoint return a list of transactions associated with the specified `member`, accross all accounts associated with that `member`."
        },
        {
          "info": {
            "name": "List transactions by tag",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mx.com/users/:user_guid/tags/:tag_guid/transactions",
            "params": [
              {
                "name": "from_date",
                "value": "2015-09-20",
                "type": "query",
                "description": "Filter transactions from this date."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "Specify records per page."
              },
              {
                "name": "tag_guid",
                "value": "TAG-aef36e72-6294-4c38-844d-e573e80aed52",
                "type": "path",
                "description": "The unique id for a `tag`."
              },
              {
                "name": "to_date",
                "value": "2019-10-20",
                "type": "query",
                "description": "Filter transactions to this date."
              },
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique id for a `user`."
              }
            ]
          },
          "docs": "Use this endpoint to get a list of all transactions associated with a particular tag according to the tags unique GUID. In other words, a list of all transactions that have been assigned to a particular tag using the create a tagging endpoint."
        },
        {
          "info": {
            "name": "List transactions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mx.com/users/:user_guid/transactions",
            "params": [
              {
                "name": "from_date",
                "value": "2015-09-20",
                "type": "query",
                "description": "Filter transactions from this date."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "Specify records per page."
              },
              {
                "name": "to_date",
                "value": "2019-10-20",
                "type": "query",
                "description": "Filter transactions to this date."
              },
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique id for a `user`."
              }
            ]
          },
          "docs": "Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`."
        },
        {
          "info": {
            "name": "Read transaction",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mx.com/users/:user_guid/transactions/:transaction_guid",
            "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 id for a `user`."
              }
            ]
          },
          "docs": "Requests to this endpoint will return the attributes of the specified `transaction`."
        },
        {
          "info": {
            "name": "Update transaction",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.mx.com/users/:user_guid/transactions/:transaction_guid",
            "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 id for a `user`."
              }
            ],
            "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",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mx.com/users/:user_guid/transactions/:transaction_guid/split",
            "params": [
              {
                "name": "user_guid",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the user. Defined by MX."
              },
              {
                "name": "transaction_guid",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the transaction. Defined by MX."
              }
            ],
            "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://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-85628b0-5210-4878-9bd3-f4ce154f90c4",
                "type": "path",
                "description": "The unique id for a `user`."
              }
            ]
          },
          "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
}