{ "opencollection": "1.0.0", "info": { "name": "MX Platform Mx_platform API", "version": "0.1.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Mx_platform", "type": "folder" }, "items": [ { "info": { "name": "Request an authorization code.", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/authorization_code", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Read a default category", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/categories/:category_guid", "params": [ { "name": "category_guid", "value": "CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874", "type": "path", "description": "The unique id for a `category`." } ] }, "docs": "Use this endpoint to read the attributes of a default category." }, { "info": { "name": "List institutions", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/institutions", "params": [ { "name": "name", "value": "chase", "type": "query", "description": "This will list only institutions in which the appended string appears." }, { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." }, { "name": "supports_account_identification", "value": "true", "type": "query", "description": "Filter only institutions which support account identification." }, { "name": "supports_account_statement", "value": "true", "type": "query", "description": "Filter only institutions which support account statements." }, { "name": "supports_account_verification", "value": "true", "type": "query", "description": "Filter only institutions which support account verification." }, { "name": "supports_transaction_history", "value": "true", "type": "query", "description": "Filter only institutions which support extended transaction history." } ] }, "docs": "This endpoint returns a list of institutions based on the specified search term or parameter." }, { "info": { "name": "List managed institutions", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/managed_institutions", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "Specify records per page." } ] }, "docs": "This endpoint returns a list of institutions which can be used to create partner-managed members." }, { "info": { "name": "Read merchant", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/merchants/:merchant_guid", "params": [ { "name": "merchant_guid", "value": "MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b", "type": "path", "description": "The unique id for a `merchant`." } ] }, "docs": "Returns information about a particular merchant, such as a logo, name, and website." }, { "info": { "name": "(Deprecated) Request an authorization code.", "type": "http" }, "http": { "method": "POST", "url": "https://api.mx.com/payment_processor_authorization_code", "body": { "type": "json", "data": "{}" } }, "docs": "(This endpoint is deprecated. Clients should use `/authorization_code`.) Clients use this endpoint to request an authorization_code according to a user, member, and account specified in the request body. Clients then pass this code to processors. Processor access is scoped only to the user/member/account specified in this request. Before requesting an authorization_code, clients must have verified the specified member." }, { "info": { "name": "Read user", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to read the attributes of a specific user." }, { "info": { "name": "Update user", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid", "params": [ { "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 user." }, { "info": { "name": "Delete user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid", "params": [ { "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 `user`. The response will have a status of `204 No Content` without an object." }, { "info": { "name": "Read account", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/accounts/:account_guid", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint returns the specified `account` resource." }, { "info": { "name": "Delete manual account", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/accounts/:account_guid", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of `204 No Content`." }, { "info": { "name": "Read a custom category", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/categories/:category_guid", "params": [ { "name": "category_guid", "value": "CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874", "type": "path", "description": "The unique id for a `category`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to read the attributes of either a default category or a custom category." }, { "info": { "name": "Update category", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/categories/:category_guid", "params": [ { "name": "category_guid", "value": "CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874", "type": "path", "description": "The unique id for a `category`." }, { "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 a custom category according to its unique GUID." }, { "info": { "name": "Delete category", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/categories/:category_guid", "params": [ { "name": "category_guid", "value": "CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874", "type": "path", "description": "The unique id for a `category`." }, { "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 a specific custom category according to its unique GUID. The API will respond with an empty object and a status of `204 No Content`." }, { "info": { "name": "Read holding", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/holdings/:holding_guid", "params": [ { "name": "holding_guid", "value": "HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2", "type": "path", "description": "The unique id for a `holding`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to read the attributes of a specific `holding`." }, { "info": { "name": "Read managed member", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid", "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 id for a `user`." } ] }, "docs": "This endpoint returns the attributes of the specified partner-managed `member`." }, { "info": { "name": "Update managed member", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid", "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 id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the attributes of the specified partner_managed `member`." }, { "info": { "name": "Delete managed member", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid", "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 id for a `user`." } ] }, "docs": "Use this endpoint to delete the specified partner-managed `member`. The endpoint will respond with a status of `204 No Content` without a resource." }, { "info": { "name": "Read managed account", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to read the attributes of a partner-managed account according to its unique guid." }, { "info": { "name": "Update managed account", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the attributes of a partner-managed account according to its unique GUID." }, { "info": { "name": "Delete managed account", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/managed_members/:member_guid/accounts/:account_guid", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "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`." }, { "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": "Read member", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid", "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 id for a `user`." } ] }, "docs": "Use this endpoint to read the attributes of a specific member." }, { "info": { "name": "Update member", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/members/:member_guid", "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 id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete member", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/members/:member_guid", "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 id for a `user`." } ] }, "docs": "Accessing this endpoint will permanently delete a member." }, { "info": { "name": "Read account by member", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/accounts/:account_guid", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "This endpoint allows you to read the attributes of an `account` resource." }, { "info": { "name": "Update account by member", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/accounts/:account_guid", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint allows you to update certain attributes of an `account` resource, including manual accounts. For manual accounts, you can update every field listed. For aggregated accounts, you can only update `is_business`, `is_hidden` and `metadata`." }, { "info": { "name": "Read Reward", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/rewards/:reward_guid", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." }, { "name": "member_guid", "value": "MBR-fa7537f3-48aa-a683-a02a-b18345562f54", "type": "path", "description": "The unique identifier for the member. Defined by MX." }, { "name": "reward_guid", "value": "RWD-fa7537f3-48aa-a683-a02a-b324322f54", "type": "path", "description": "The unique identifier for the rewards. Defined by MX." } ] }, "docs": "Use this endpoint to read a specific `reward` based on its unique GUID.." }, { "info": { "name": "Read statement by member", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/statements/:statement_guid", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "statement_guid", "value": "STA-737a344b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for a `statement`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to read a JSON representation of the statement." }, { "info": { "name": "Read a Tax Document", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/members/:member_guid/tax_documents/:tax_document_guid", "params": [ { "name": "tax_document_guid", "value": "TAX-987dfds1b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `tax_document`." }, { "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`." } ] }, "docs": "Use this endpoint to read the attributes of the specified tax document." }, { "info": { "name": "Read tagging", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/taggings/:tagging_guid", "params": [ { "name": "tagging_guid", "value": "TGN-007f5486-17e1-45fc-8b87-8f03984430fe", "type": "path", "description": "The unique id for a `tagging`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to read the attributes of a `tagging` according to its unique GUID." }, { "info": { "name": "Update tagging", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/taggings/:tagging_guid", "params": [ { "name": "tagging_guid", "value": "TGN-007f5486-17e1-45fc-8b87-8f03984430fe", "type": "path", "description": "The unique id for a `tagging`." }, { "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 a tagging." }, { "info": { "name": "Delete tagging", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/taggings/:tagging_guid", "params": [ { "name": "tagging_guid", "value": "TGN-007f5486-17e1-45fc-8b87-8f03984430fe", "type": "path", "description": "The unique id for a `tagging`." }, { "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 a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content." }, { "info": { "name": "Read tag", "type": "http" }, "http": { "method": "GET", "url": "https://api.mx.com/users/:user_guid/tags/:tag_guid", "params": [ { "name": "tag_guid", "value": "TAG-aef36e72-6294-4c38-844d-e573e80aed52", "type": "path", "description": "The unique id for a `tag`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "Use this endpoint to read the attributes of a particular tag according to its unique GUID." }, { "info": { "name": "Update tag", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mx.com/users/:user_guid/tags/:tag_guid", "params": [ { "name": "tag_guid", "value": "TAG-aef36e72-6294-4c38-844d-e573e80aed52", "type": "path", "description": "The unique id for a `tag`." }, { "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 name of a specific tag according to its unique GUID." }, { "info": { "name": "Delete tag", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mx.com/users/:user_guid/tags/:tag_guid", "params": [ { "name": "tag_guid", "value": "TAG-aef36e72-6294-4c38-844d-e573e80aed52", "type": "path", "description": "The unique id for a `tag`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique id for a `user`." } ] }, "docs": "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`." }, { "info": { "name": "Read transaction rule", "type": "http" }, "http": { "method": "GET", "url": "https://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 id for a `user`." } ] }, "docs": "Use this endpoint to read the attributes of an existing transaction rule based on the rules unique GUID." }, { "info": { "name": "Update transaction_rule", "type": "http" }, "http": { "method": "PUT", "url": "https://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 id for a `user`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete transaction rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://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 id for a `user`." } ] }, "docs": "Use this endpoint to permanently delete a transaction rule based on its unique GUID." }, { "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." } ] } ], "bundled": true }