{ "opencollection": "1.0.0", "info": { "name": "MX Platform accounts widgets API", "version": "20111101" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "widgets", "type": "folder" }, "items": [ { "info": { "name": "(Deprecated) Request connect widget URL", "type": "http" }, "http": { "method": "POST", "url": "https://int-api.mx.com/users/:user_guid/connect_widget_url", "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": "This endpoint will return a URL for an embeddable version of MX Connect." }, { "info": { "name": "Request oauth window uri", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_guid/members/:member_guid/oauth_window_uri", "params": [ { "name": "client_redirect_url", "value": "https://{yoursite.com}", "type": "query", "description": "A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with `referral_source=APP`." }, { "name": "enable_app2app", "value": "false", "type": "query", "description": "This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to `true`. When set to `false`, any `oauth_window_uri` generated will **not** direct the end user to the institution's mobile application. This setting is not persistent. This setting currently only affects Chase institutions." }, { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "referral_source", "value": "APP", "type": "query", "description": "Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`." }, { "name": "skip_aggregation", "value": "false", "type": "query", "description": "Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page." }, { "name": "ui_message_webview_url_scheme", "value": "", "type": "query", "description": "A scheme for routing the user back to the application state they were previously in. Only available with `referral_source=APP`." }, { "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 will generate an `oauth_window_uri` for the specified `member`." }, { "info": { "name": "Request widget URL", "type": "http" }, "http": { "method": "POST", "url": "https://int-api.mx.com/users/:user_guid/widget_urls", "headers": [ { "name": "Accept-Language", "value": "en-US" }, { "name": "X-CALLBACK-PAYLOAD", "value": "813e50bd-4a7e-4517-b6bb-9eef65a68cbd" } ], "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": "Get an embeddable URL for integrating a widget into your website or app. The URL expires after ten minutes or upon first use, whichever occurs first. You'll need to obtain a new URL each time the page loads or reloads.\n\nInclude the `widget_type` in the request body to specify which widget you want to embed—the Connect Widget, a Personal Financial Management widget, or an Insights widget. Some request parameters are specific to certain widget types.\n\nTo embed the Connect Widget, set `widget_type`" }, { "info": { "name": "Request oauth window uri", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_identifier/members/:member_identifier/oauth_window_uri", "headers": [ { "name": "Accept-Version", "value": "" } ], "params": [ { "name": "client_redirect_url", "value": "https://{yoursite.com}", "type": "query", "description": "A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with `referral_source=APP`." }, { "name": "enable_app2app", "value": "false", "type": "query", "description": "This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to `true`. When set to `false`, any `oauth_window_uri` generated will **not** direct the end user to the institution's mobile application. This setting is not persistent. This setting currently only affects Chase institutions." }, { "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": "referral_source", "value": "APP", "type": "query", "description": "Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`." }, { "name": "skip_aggregation", "value": "false", "type": "query", "description": "Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page." }, { "name": "ui_message_webview_url_scheme", "value": "", "type": "query", "description": "A scheme for routing the user back to the application state they were previously in. Only available with `referral_source=APP`." }, { "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": "This endpoint will generate an `oauth_window_uri` for the specified `member`." } ] } ], "bundled": true }