{ "opencollection": "1.0.0", "info": { "name": "MX Platform accounts transaction rules API", "version": "20111101" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "transaction rules", "type": "folder" }, "items": [ { "info": { "name": "List transaction rules", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_guid/transaction_rules", "params": [ { "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": "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 read the attributes of all existing transaction rules belonging to the user." }, { "info": { "name": "Create transaction rule", "type": "http" }, "http": { "method": "POST", "url": "https://int-api.mx.com/users/:user_guid/transaction_rules", "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-`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new transaction rule. The newly-created `transaction_rule` object will be returned if successful." }, { "info": { "name": "Read transaction rule", "type": "http" }, "http": { "method": "GET", "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 read the attributes of an existing transaction rule based on the rule’s unique GUID." }, { "info": { "name": "Update transaction rule", "type": "http" }, "http": { "method": "PUT", "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-`." } ], "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." } ] } ], "bundled": true }