{ "opencollection": "1.0.0", "info": { "name": "MX Platform accounts statements API", "version": "20111101" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "statements", "type": "folder" }, "items": [ { "info": { "name": "Fetch statements", "type": "http" }, "http": { "method": "POST", "url": "https://int-api.mx.com/users/:user_guid/members/:member_guid/fetch_statements", "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": "Use this endpoint to fetch the statements associated with a particular member." }, { "info": { "name": "List statements by member", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_guid/members/:member_guid/statements", "params": [ { "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": "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 get an array of available statements." }, { "info": { "name": "Read statement by member", "type": "http" }, "http": { "method": "GET", "url": "https://int-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 identifier for a `user`, beginning with the prefix `USR-`." } ] }, "docs": "Use this endpoint to read a JSON representation of the statement." }, { "info": { "name": "Download statement pdf", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_guid/members/:member_guid/statements/:statement_guid.pdf", "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 identifier for a `user`, beginning with the prefix `USR-`." } ] }, "docs": "Use this endpoint to download a specified statement PDF." }, { "info": { "name": "Fetch statements", "type": "http" }, "http": { "method": "POST", "url": "https://int-api.mx.com/users/:user_identifier/members/:member_identifier/fetch_statements", "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": "Use this endpoint to fetch the statements associated with a particular member." } ] } ], "bundled": true }