Authorization header

Authorization: Basic {token}

Basic authorization token

Base64 encoding of:
{client_id}:{api_key}

Example

CLIENT-1234:API-KEY-4567 -> Q0xJRU5ULTEyMzQ6QVBJLUtFWS00NTY3

Development URL

https://int-api.mx.com

Production URL

https://api.mx.com

Example error message

1
2
3
4
5
{
  "error": {
    "message": "Unrecognized institution.",
  }
}

'Content-Type: application/json'

'Accept: application/vnd.mx.api.v1+json'

Example pagination object

1
2
3
4
5
6
"pagination": {
  "current_page": 1,
  "per_page": 25,
  "total_entries": 2,
  "total_pages": 1
}

Endpoint:

POST /users/{user_guid}/widget_urls

Example request

1
2
3
4
5
6
7
8
9
10
curl -L -X POST 'https://int-api.mx.com/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/widget_urls' \
-H 'Authorization: Basic {token}' \
-H 'Accept: application/vnd.mx.api.v1+json' \
-H 'Content-Type: application/json' \
-d '{
      "widget_url": {
        "widget_type": "connect_widget",
        "color_scheme": "dark"
      }
    }'

Example request with language header

1
2
3
4
5
6
7
8
9
10
11
curl -L -X POST 'https://int-api.mx.com/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/widget_urls' \
-H 'Accept-Language: en-CA' \
-H 'Accept: application/vnd.mx.api.v1+json' \
-H 'Authorization: Basic {token}' \
-H 'Content-Type: application/json'
-d '{
      "widget_url": {
        "widget_type": "connect_widget",
        "color_scheme": "dark"
      }
    }'

Example response

1
2
3
4
5
6
7
{
  "widget_url": {
    "type": "connect_widget",
    "url": "https://int-widgets.moneydesktop.com/md/connect/yxcdk7f1nb99jwApp34lA24m0AZ8rzprgmw17gm8z8h2AzjyAnd1rj42qfv42r3xnn07Amfwlg3j09hwp8bkq8tc5z21j33xjggmp2qtlpkz2v4gywfhfn31l44tx2w91bfc2thc58j4syqp0hgxcyvA4g7754hk7gjc56kt7tc36s45mmkdz2jqqqydspytmtr3dAb9jh6fkb24f3zkfpdjj0v77f0vmrtzvzxkmxz7dklsq8gd0gstkbhlw5bgpgc3m9mAtpAcr2w15gwy5xc4blgxppl42Avnm63291z3cyp0wm3lqgmvgzdAddct423gAdqxdlfx5d4mvc0ck2gt7ktqgks4vxq1pAy5",
    "user_id": "U-jeff-201709221210"
  }
}

Endpoint:

POST /users/{user_guid}/connect_widget_url

Example request

1
2
3
4
5
6
7
8
9
curl -L -X POST https://int-api.mx.com/users/USR-29eab3cf-6a87-fe97-6279-563b63e75a53/connect_widget_url \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}' \
  -H 'Content-type: application/json' \
  -d '{
        "config": {
          "color_scheme": "dark"
        }
      }'

Example response

1
2
3
4
5
6
{
  "user": {
    "connect_widget_url": "https://int-widgets.moneydesktop.com/md/connect/52bxfvvvm0p1qyb9As6737366AZyw3x3c07gzflsqbjwA5gA0snwnAb2Ams468zz6gg0wA3yvfbsx2c9m6cfljf0zgznnlAmhy3tczmr987bxqbxd2785jfbs48k003v28mxt0xh16vAxjk6rv9h2rwxgbzwdyd9xsvlk82dl01yw3sp1wn68wb5gbn9v6kdy1wtgwl92sppxrzyp0rjvsgqclsyjwhbAgr5mqsAlw730hz3w9rl7vlp2pspAhn5gx1xxdbsz6lkmwlcA6tdfqzgpk6nh126kA89zqm7tk0qg3zd2nA7dgnkg14nw5bgyczb80Ad0sxrm6msvb2kw1c80dxc984f8p7bzb5y/eyJ1aV9tZXNzYWdlX3ZlcnNpb24iOjEsInVpX21lc3NhZ2Vfd2Vidmlld191cmxfc2NoZW1lIjoiYXRyaXVtIn0%3D",
    "guid": "USR-29eab3cf-6a87-fe97-6279-563b63e75a53"
  }
}

Do not include transaction data in the aggregation job after the user is connected

1
2
3
4
5
6
7
8
9
10
curl -L -X POST https://int-api.mx.com/users/USR-29eab3cf-6a87-fe97-6279-563b63e75a53/widget_urls \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}' \
  -H 'Content-type: application/json' \
  -d '{
        "widget_url": { 
          "widget_type": "connect_widget",
          "include_transactions": false
        }
      }'

Load MXConnect with the given institution

1
2
3
4
5
6
7
8
9
10
curl -L -X POST https://int-api.mx.com/users/USR-29eab3cf-6a87-fe97-6279-563b63e75a53/widget_urls \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}' \
  -H 'Content-type: application/json' \
  -d '{ 
        "widget_url": { 
          "widget_type": "connect_widget",
          "current_institution_code": {bank code}
        }
      }'

Load MXConnect with the given member

1
2
3
4
5
6
7
8
9
10
curl -L -X POST https://int-api.mx.com/users/USR-29eab3cf-6a87-fe97-6279-563b63e75a53/widget_urls \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}' \
  -H 'Content-type: application/json' \
  -d '{ 
        "widget_url": { 
          "widget_type": "connect_widget",
          "current_member_guid": {member_guid}
        }
      }'

Load MXConnect in verification mode

1
2
3
4
5
6
7
8
9
10
curl -L -X POST https://int-api.mx.com/users/USR-29eab3cf-6a87-fe97-6279-563b63e75a53/widget_urls \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}' \
  -H 'Content-type: application/json' \
  -d '{ 
        "widget_url": { 
          "widget_type": "connect_widget",
          "mode": "verification"
        }
      }'

Wait for account, transaction, or verification data before finishing

1
2
3
4
5
6
7
8
9
10
curl -L -X POST https://int-api.mx.com/users/USR-29eab3cf-6a87-fe97-6279-563b63e75a53/widget_urls \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}' \
  -H 'Content-type: application/json' \
  -d '{ 
        "widget_url": { 
          "widget_type": "connect_widget",
          "wait_for_full_aggregation": true 
        }
      }'

Example usage

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
var mxConnect = new window.MXConnect({
  id: "connect-widget",
  iframeTitle: "Connect",
  /**
   * Callback that for handling all events within Connect.
   * Only called in  ui_message_version 4 or higher.
   *
   * The events called here are the same events that come through post
   * messages.
   */
  onEvent: function (type, payload) {
    console.log("onEvent", type, payload);
  },
  config: {
    ui_message_version: 4
  },
  targetOrigin: "*",
})

Example navigation event schema

{ui_message_webview_url_scheme}://{some/path}?metadata={jsonString}

Suggested base configuration for WebViews.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
curl -L -X POST https://int-api.mx.com/users/USR-29eab3cf-6a87-fe97-6279-563b63e75a53/widget_urls \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}' \
  -H 'Content-type: application/json' \
  -d '{
        "widget_url": { 
          "widget_type": "connect_widget",
          "is_mobile_webview": true,
          "ui_message_version": 4,
          "ui_message_webview_url_scheme": "{app_scheme}"
        }
      }'

# Possible navigation events based on the config above:
# `mx://load`
# `yourAppScheme://connect/institutionSearch?metadata={...json...}

Java example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
public class MainActivity extends AppCompatActivity {
    private WebView webView = null;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
      webView = (WebView) findViewById(R.id.webview);
      webView.setWebViewClient(new ConnectWebviewClient());
      webView.getSettings().setDomStorageEnabled(true);
      webView.getSettings().setJavaScriptEnabled(true);
    }
    private class ConnectWebviewClient extends WebViewClient {
        @Override
        public boolean shouldOverrideUrlLoading(WebView view, String url) {
            if (url.startsWith("mx://")) {
                return true;
            }
            return false;
        }
    }
}

Swift example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
class ViewController: UIViewController, WKUIDelegate {
  override func viewDidLoad() {
      super.viewDidLoad()
      webView.delegate = self
      ...
  }

  func webView(_ webView: WKWebView, decidePolicyFor
    navigationAction: WKNavigationAction,
    decisionHandler: @escaping (WKNavigationActionPolicy) -> Swift.Void) {

    // Intercept custom URI
    let surl = navigationAction.url?.absoluteString
    if (surl?.hasPrefix("mx://"))! {
      // Take action here

      // Cancel request
      decisionHandler(.cancel)
      return
    }

    // Allow request
    decisionHandler(.allow)
  }
}

Example request

1
2
3
4
5
6
7
8
9
10
11
12
curl -L -X POST https://int-api.mx.com/users/USR-29eab3cf-6a87-fe97-6279-563b63e75a53/widget_urls \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}' \
  -H 'Content-type: application/json' \
  -d '{
        "widget_url": { 
          "widget_type": "connect_widget",
          "is_mobile_webview": true,
          "ui_message_version": 4,
          "ui_message_webview_url_scheme": "{app_scheme}"
        }
      }'

Redirecting the user

Example redirect with Java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
/**
 * This Client will capture urls from MX and cancel them. It will specifically
 * handle the oauthRequested URL. You will want to set this client as your
 * WebView's client or add this functionality to your own.
 */
public class MXWebViewClient extends WebViewClient {
    private Activity activity;

    public MXWebViewClient(Activity mainActivity) {
        activity = mainActivity;
    }

    @Override
    public boolean shouldOverrideUrlLoading(WebView view, String url) {
        // Ensure you are looking for schemes from 'mx' and whatever you configured
        // ui_message_webview_url_scheme to be. In this example, it was 'appscheme'.
        boolean isFromMX = url.startsWith("mx://")  || url.startsWith("appscheme://");

        if (isFromMX) {
            try {
                Uri mxURI = Uri.parse(url);

                // Handle the oauth url redirect. Send the user to the URL given.
                if (mxURI.getPath().equals("/oauthRequested")) {
                    JSONObject mxMetaData = new JSONObject(mxURI.getQueryParameter("metadata"));
                    String oauthURL = mxMetaData.getString("url");
                    Uri oauthPage = Uri.parse(oauthURL);
                    Intent intent = new Intent(Intent.ACTION_VIEW, oauthPage);
                    activity.startActivity(intent);
                }
            } catch (Exception err) {
                Log.e("sb: Error creating URI", err.getMessage());
            }
            return true;
        }

        return false;
    }
}

Example redirect with Swift

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/**
 * Set up the WebView to capture URLs. You will want to cancel all urls from MX.
 */
class ViewController: UIViewController, WKNavigationDelegate {

    var webView: WKWebView!
    let appScheme = "appscheme://"
    let mxScheme = "mx://"

    func webView(_ webView: WKWebView,
                 decidePolicyFor navigationAction: WKNavigationAction,
                 decisionHandler: @escaping (WKNavigationActionPolicy) -> Swift.Void) {

        // Ensure you are looking for schemes from both 'mx' and whatever you configured
        // ui_message_webview_url_scheme to be. In this example, it was 'appscheme'.
        let url = navigationAction.request.url?.absoluteString
        let isFromMX = url?.hasPrefix(appScheme) == true || url?.hasPrefix(mxScheme) == true

        if isFromMX {
            let urlc = URLComponents(string: surl ?? "")
            let path = urlc?.path ?? ""
            // there is only one query parameter ("metadata")
            // so just grab the first one
            let metaDataQueryItem = urlc?.queryItems?.first

            if path == "/oauthRequested" {
                handleOauthRedirect(payload: metaDataQueryItem)
            }

            // Cancel request
            decisionHandler(.cancel)
            return
        }

        // Allow request
        decisionHandler(.allow)
    }

    /*
     * Handle the oauthRequested event. Parse out the OAuth URL from the event
     * and open Safari to that URL
     * NOTE: This code is somewhat optimistic, you'll want to add error handling
     * that makes sense for your app.
     */
    func handleOauthRedirect(payload: URLQueryItem?) {
        let metadataString = payload?.value ?? ""

        do {
            if let json = try JSONSerialization.jsonObject(with: Data(metadataString.utf8), options: []) as? [String: Any] {
                if let url = json["url"] as? String {
                    // open safari with the url from the json payload
                    UIApplication.shared.open(URL(string: url)!)
                }
            }
        } catch let error as NSError {
            print("Failed to parse payload: \(error.localizedDescription)")
        }
    }
}

Example integration

1
2
3
4
5
6
7
function handleEvent(event) {
  if (event.data.mx) {
    // handle the mx post message using event.data.type and event.data.metadata.
  }
}

window.addEventListener('message', handleEvent)

Example event

1
2
3
4
5
6
7
8
9
const mxEvent = {
  mx: true,
  type: 'mx/account/created',
  metadata: {
    user_guid: 'USR-123',
    session_guid: 'ANS-123'
    // relevant data for the given type
  }
}

Connect loaded

1
2
3
4
5
6
7
8
9
{
  "type": "mx/connect/loaded",
  "mx": true,
  "metadata": {
    "user_guid": "USR-123",
    "session_guid": "ANS-123",
    "initial_step": "search"
  }
}

Enter credentials

1
2
3
4
5
6
7
8
9
10
11
12
{
  "type": "mx/connect/enterCredentials",
  "mx": true,
  "metadata": {
    "user_guid": "USR-123",
    "session_guid": "ANS-123",
    "institution": {
      "code": "mxbank",
      "guid": "INS-123"
    }
  }
}

Institution search

1
2
3
4
5
6
7
8
9
{
  "type": "mx/connect/institutionSearch",
  "mx": true,
  "metadata": {
    "user_guid": "USR-123",
    "session_guid": "ANS-123",
    "query": "MX Bank"
  }
}

Institution selected

1
2
3
4
5
6
7
8
9
10
11
12
{
  "type": "mx/connect/selectedInstitution",
  "mx": true,
  "metadata": {
    "code": "mxbank",
    "guid": "INS-123",
    "name": "MX Bank",
    "session_guid": "ANS-123",
    "url": "www.example.com",
    "user_guid": "USR-123"
  }
}

Member connected

1
2
3
4
5
6
7
8
9
{
  "type": "mx/connect/memberConnected",
  "mx": true,
  "metadata": {
    "user_guid": "USR-123",
    "session_guid": "ANS-123",
    "member_guid": "MBR-123"
  }
}

Member create error

1
2
3
4
5
6
7
8
9
10
{
  "type": "mx/connect/createMemberError",
  "mx": true,
  "metadata": {
    "user_guid": "USR-123",
    "session_guid": "ANS-123",
    "institution_guid": "INS-123",
    "institution_code": "mxbank"
  }
}

Member status update

1
2
3
4
5
6
7
8
9
10
{
  "type": "mx/connect/memberStatusUpdate",
  "mx": true,
  "metadata": {
    "user_guid": "USR-123",
    "session_guid": "ANS-123",
    "member_guid": "MBR-123",
    "connection_status": 6
  }
}

OAuth error

1
2
3
4
5
6
7
8
9
{
  "type": "mx/connect/oauthError",
  "mx": true,
  "metadata": {
    "user_guid": "USR-123",
    "session_guid": "ANS-123",
    "member_guid": "MBR-123"
  }
}

OAuth requested:

1
2
3
4
5
6
7
8
9
{
  "type": "mx/connect/oauthRequested",
  "mx": true,
  "metadata": {
    "user_guid": "USR-123",
    "session_guid": "ANS-123",
    "url": "https://something.com"
  }
}

Connect step change

1
2
3
4
5
6
7
8
9
10
{
  "type": "mx/connect/stepChange",
  "mx": true,
  "metadata": {
    "user_guid": "USR-123",
    "session_guid": "ANS-123",
    "previous": "search",
    "current": "enterCreds"
  }
}

Submit MFA

1
2
3
4
5
6
7
8
9
{
  "type": "mx/connect/submitMFA",
  "mx": true,
  "metadata": {
    "user_guid": "USR-123",
    "session_guid": "ANS-123",
    "member_guid": "MBR-123"
  }
}

Update credentials

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "type": "mx/connect/updateCredentials",
  "mx": true,
  "metadata": {
    "user_guid": "USR-123",
    "session_guid": "ANS-123",
    "member_guid": "MBR-123",
    "institution": {
      "code": "mxbank",
      "guid": "INS-123"
    }
  }
}

Widget load event

1
2
3
4
{
  "type": "mx/load",
  "mx": true
}

Widget ping event

1
2
3
4
5
6
7
8
{
  "type": "mx/ping",
  "mx": true,
  "metadata": {
    "user_guid": "USR-123",
    "session_guid": "ANS-123"
  }
}

Endpoint:

GET /users/{user_guid}/accounts

Example request:

1
2
3
curl -X GET https://int-api.mx.com/users/USR-11a448aa-5e7b-70db-45d6-d6927092043e/accounts \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}'

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
{
  "accounts": [
    {
      "account_number": "5366",
      "apr": null,
      "apy": null,
      "available_balance": null,
      "available_credit": 327.01,
      "balance": 1872.99,
      "cash_balance": null,
      "cash_surrender_value": null,
      "created_at": "2020-08-04T21:27:47Z",
      "credit_limit": null,
      "currency_code": "USD",
      "day_payment_is_due": null,
      "death_benefit": null,
      "guid": "ACT-82a93692-f756-534f-9b2e-ad10a0f38462",
      "holdings_value": null,
      "id": "1040434698",
      "institution_code": "chase",
      "insured_name": null,
      "interest_rate": null,
      "is_closed": false,
      "is_hidden": false,
      "last_payment": null,
      "last_payment_at": null,
      "loan_amount": null,
      "matures_on": null,
      "member_guid": "MBR-0b2121f5-bf4f-4244-a697-cac69160020f",
      "minimum_balance": null,
      "minimum_payment": null,
      "name": "CREDIT CARD",
      "original_balance": null,
      "pay_out_amount": null,
      "payment_due_at": null,
      "payoff_balance": null,
      "premium_amount": null,
      "started_on": null,
      "subtype": "NONE",
      "total_account_value": null,
      "type": "CREDIT_CARD",
      "updated_at": "2021-01-15T17:09:09Z",
      "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
    },
•••
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_entries": 8,
    "total_pages": 1
  }
}

Endpoint:

GET /users/{user_guid}/accounts/{account_guid}

Example request

1
2
3
curl -X GET https://int-api.mx.com/users/USR-11a448aa-5e7b-70db-45d6-d6927092043e/accounts/ACT-fcdfc4bc-bbff-4f1e-b5d1-35197f \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}'

Example response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
{
  "account": {
    "account_number": "5366",
    "apr": null,
    "apy": null,
    "available_balance": null,
    "available_credit": 327.01,
    "balance": 1872.99,
    "cash_balance": null,
    "cash_surrender_value": null,
    "created_at": "2020-08-04T21:27:47Z",
    "credit_limit": null,
    "currency_code": "USD",
    "day_payment_is_due": null,
    "death_benefit": null,
    "guid": "ACT-82a93692-f756-534f-9b2e-ad10a0f38462",
    "holdings_value": null,
    "id": "1040434698",
    "institution_code": "chase",
    "insured_name": null,
    "interest_rate": null,
    "is_closed": false,
    "is_hidden": false,
    "last_payment": null,
    "last_payment_at": null,
    "loan_amount": null,
    "matures_on": null,
    "member_guid": "MBR-0b2121f5-bf4f-4244-a697-cac69160020f",
    "minimum_balance": null,
    "minimum_payment": null,
    "name": "CREDIT CARD",
    "original_balance": null,
    "pay_out_amount": null,
    "payment_due_at": null,
    "payoff_balance": null,
    "premium_amount": null,
    "started_on": null,
    "subtype": "NONE",
    "total_account_value": null,
    "type": "CREDIT_CARD",
    "updated_at": "2021-01-15T17:09:09Z",
    "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
  }
}

Endpoint:

PUT /users/{user_guid}/members/{member_guid}/accounts/{account_guid}

Example request

1
2
3
4
5
6
7
8
9
curl -L -X PUT 'https://int-api.mx.com/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-3bdc7d6b-efd4-1497-a0af-b23501cf9bd0/accounts/ACT-82a93692-f756-534f-9b2e-ad10a0f38462' \
  -H 'Authorization: Basic {token}' \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Content-Type: application/json' \
  -d '{
        "account": {
          "is_hidden": true
        }
      }'

Example response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
{
  "account": {
    "account_number": "5366",
    "apr": null,
    "apy": null,
    "available_balance": null,
    "available_credit": 327.01,
    "balance": 1872.99,
    "cash_balance": null,
    "cash_surrender_value": null,
    "created_at": "2020-08-04T21:27:47Z",
    "credit_limit": null,
    "currency_code": "USD",
    "day_payment_is_due": null,
    "death_benefit": null,
    "guid": "ACT-82a93692-f756-534f-9b2e-ad10a0f38462",
    "holdings_value": null,
    "id": "1040434698",
    "institution_code": "chase",
    "insured_name": null,
    "interest_rate": null,
    "is_closed": false,
    "is_hidden": true,
    "last_payment": null,
    "last_payment_at": null,
    "loan_amount": null,
    "matures_on": null,
    "member_guid": "MBR-0b2121f5-bf4f-4244-a697-cac69160020f",
    "minimum_balance": null,
    "minimum_payment": null,
    "name": "CREDIT CARD",
    "original_balance": null,
    "pay_out_amount": null,
    "payment_due_at": null,
    "payoff_balance": null,
    "premium_amount": null,
    "started_on": null,
    "subtype": "NONE",
    "total_account_value": null,
    "type": "CREDIT_CARD",
    "updated_at": "2021-01-15T17:09:09Z",
    "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
  }
}

Endpoint:

GET /institutions/favorites

Example request:

1
2
3
4
curl -X GET https://int-api.mx.com/institutions/favorites
2bab47 \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}'

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
  "institutions": [
    {
      "code": "52726",
      "medium_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png",
      "name": "Washington Federal",
      "small_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png",
      "supports_account_identification": null,
      "supports_account_statement": null,
      "supports_account_verification": true,
      "supports_oauth": false,
      "supports_transaction_history": null,
      "url": "www.washingtonfederal.com"
    },
    {
      "code": "capital_one",
      "medium_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png",
      "name": "Capital One",
      "small_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png",
      "supports_account_identification": null,
      "supports_account_statement": null,
      "supports_account_verification": false,
      "supports_oauth": false,
      "supports_transaction_history": null,
      "url": "http://www.capitalone.com"
    },
    ...
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_entries": 130,
    "total_pages": 6
}
}

Endpoint:

GET /institutions/{institution_code}/credentials

Example request

1
2
3
curl -X GET https://int-api.mx.com/institutions/mxbank/credentials \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}'

Example response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "credentials": [
    {
      "display_order": 1,
      "field_name": "LOGIN",
      "field_type": "LOGIN",
      "guid": "CRD-9f61fb4c-912c-bd1e-b175-ccc7f0275cc1",
      "label": "Username"
    },
    {
      "display_order": 2,
      "field_name": "PASSWORD",
      "field_type": "PASSWORD",
      "guid": "CRD-e3d7ea81-aac7-05e9-fbdd-4b493c6e474d",
      "label": "Password"
    }
  ]
}

Endpoint:

GET /institutions

Example request:

1
2
3
curl -X GET https://int-api.mx.com/institutions \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}'

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
  "institutions": [
    {
      "code": "5426",
      "medium_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png",
      "name": "Test",
      "small_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png",
      "supports_account_identification": false,
      "supports_account_statement": false,
      "supports_account_verification": false,
      "supports_oauth": false,
      "supports_transaction_history": false,
      "url": "testbankformoneydesktop.com"
    },
    {
      "code": "50025",
      "medium_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/INS-a4c142b7-9d52-e9e9-e464-4d00eaa81f76_100x100.png",
      "name": "Franklin-Oil Region CU",
      "small_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/INS-a4c142b7-9d52-e9e9-e464-4d00eaa81f76_50x50.png",
      "supports_account_identification": false,
      "supports_account_statement": false,
      "supports_account_verification": false,
      "supports_oauth": false,
      "supports_transaction_history": false,
      "url": "www.franklincreditunion.com"
    },
    ...
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_entries": 130,
    "total_pages": 6
}
}

Example request with query parameters:

1
2
3
curl -X GET https://int-api.mx.com/institutions?name=chase \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}'

Example response with query parameters:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{
    "institutions": [
        {
            "code": "71426",
            "medium_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/INS-7cf00356-2c62-3764-a2bf-6451477d5117_100x100.png",
            "name": "Chase Bank",
            "small_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/INS-7cf00356-2c62-3764-a2bf-6451477d5117_50x50.png",
            "supports_account_identification": false,
            "supports_account_statement": false,
            "supports_account_verification": true,
            "supports_oauth": false,
            "supports_transaction_history": false,
            "url": "http://www.chase.com/"
        },
        {
            "code": "f2fe7f27-7005-46ba-b528-20e09b5152a4",
            "medium_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png",
            "name": "Centre @ Riverchase",
            "small_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png",
            "supports_account_identification": false,
            "supports_account_statement": false,
            "supports_account_verification": false,
            "supports_oauth": false,
            "supports_transaction_history": false,
            "url": "https://www.doxo.com/info/centre-at-riverchase"
        }
    ],
    "pagination": {
        "current_page": 1,
        "per_page": 25,
        "total_entries": 2,
        "total_pages": 1
    }
}

Endpoint:

GET /institutions/{institution_code}

Example request:

1
2
3
4
curl -X GET https://int-api.mx.com/institutions/50025
2bab47 \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}'

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "institution": {
    "code": "50025",
    "medium_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/INS-a4c142b7-9d52-e9e9-e464-4d00eaa81f76_100x100.png",
    "name": "Franklin-Oil Region CU",
    "small_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/INS-a4c142b7-9d52-e9e9-e464-4d00eaa81f76_50x50.png",
    "supports_account_identification": false,
    "supports_account_statement": false,
    "supports_account_verification": false,
    "supports_oauth": false,
    "supports_transaction_history": false,
    "url": "www.franklincreditunion.com"
  }
}

Endpoint:

POST /users/{user_guid}/members/{member_guid}/aggregate

Example request:

1
2
3
4
curl -L -X POST 'https://int-api.mx.com/users/USR-1234/members/MBR-5678/aggregate' \
-H 'Authorization: Basic {token}' \
-H 'Accept: application/vnd.mx.api.v1+json' \
-H 'Content-Type: application/json'

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "member": {
    "aggregated_at": "2020-04-29T20:40:07Z",
    "connection_status": "CONNECTED",
    "guid": "MBR-3bdc7d6b-efd4-1497-a0af-b23501cf9bd0",
    "id": null,
    "institution_code": "mxbank",
    "is_being_aggregated": true,
    "is_oauth": false,
    "metadata": null,
    "name": "MX Bank",
    "successfully_aggregated_at": "2019-08-08T16:17:51Z",
    "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
  }
}

Endpoint:

POST /users/{user_guid}/members/{member_guid}/check_balance

Example request:

1
2
3
4
curl -L -X POST 'https://int-api.mx.com/users/USR-1234/members/MBR-5678/check_balance' \
-H 'Authorization: Basic {token}' \
-H 'Accept: application/vnd.mx.api.v1+json' \
-H 'Content-Type: application/json'

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "member": {
    "aggregated_at": "2020-04-29T20:40:07Z",
    "connection_status": "CONNECTED",
    "guid": "MBR-3bdc7d6b-efd4-1497-a0af-b23501cf9bd0",
    "id": null,
    "institution_code": "mxbank",
    "is_being_aggregated": true,
    "is_oauth": false,
    "metadata": null,
    "name": "MX Bank",
    "successfully_aggregated_at": "2019-08-08T16:17:51Z",
    "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
  }
}

Endpoint:

POST /users/{user_guid}/members

Example request

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
curl -L -X POST 'https://int-api.mx.com/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members' \
-H 'Authorization: Basic {token}' \
-H 'Accept: application/vnd.mx.api.v1+json' \
-H 'Content-Type: application/json' \
-d '{
      "member": {
        "credentials": [
          {
            "guid": "CRD-1ec152cd-e628-e81a-e852-d1e7104624da",
            "value": "ExampleUsername"
          },
          {
            "guid": "CRD-1ec152cd-e628-e81a-e852-d1e7104624da",
            "value": "Pa$$vv@Rd"
          }
        ],
        "institution_code": "mxbank"
      }
    }'

Example response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "member": {
    "aggregated_at": null,
    "connection_status": "CREATED",
    "guid": "MBR-3bdc7d6b-efd4-1497-a0af-b23501cf9bd0",
    "id": null,
    "institution_code": "mxbank",
    "is_being_aggregated": true,
    "is_oauth": false,
    "metadata": null,
    "name": "MX Bank",
    "successfully_aggregated_at": null,
    "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
  }
}

Example is_oauth request

1
2
3
4
5
6
7
8
9
10
11
12
13
curl -L -X POST 'https://int-api.mx.com/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members' \
-H 'Authorization: Basic {token}' \
-H 'Accept: application/vnd.mx.api.v2+json' \
-H 'Content-Type: application/json' \
-d '{
      "member": {
        "institution_code": "mx_bank_oauth",
        "is_oauth": true,
        "metadata": "Additional information"
      },
      "referral_source": "APP",
      "ui_message_webview_url_scheme": "myapp"
    }'

Example is_oauth response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  "member": {
    "aggregated_at": null,
    "connection_status": "PENDING",
    "guid": "MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f",
    "id": null,
    "institution_code": "mx_bank_oauth",
    "is_being_aggregated": false,
    "is_oauth": true,
    "metadata": "Additional information",
    "name": "MX Bank (Oauth)",
    "oauth_window_uri": "int-widgets.moneydesktop.com/oauth/predirect_to/MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f/p8v7rxpxg3pdAsfgwxcrwxwhz3Zbygxfr6wAb931qv91hpb57k6bkr6t6m9djrfrfd467p8xkgqp6w7k1r9g8k8bfxqbfw2lq5tdwjq2sngAx76fm0jrw0dpmbtlkxchgjsw3r7r0hhq6A8sshqptfxql2rt123shfpkyhhpfvy67yvprbkb7lmlyrpwsd9yj0s22pmsyjhcw7d2q44d9fsxn5kfsmr2zqc79c2AxAx5gkjgbczf22A1sjx70t2pvnggzyh55s7bh62dd5wq7f1r4x90mcxn1tfhhrq5b09mjkt5hg66cjn700pcf6fgA42lbsp7v1pdch85mswycrp21c6j2sxffm14Asg3?skip_aggregation=false&referral_source=APP&ui_message_webview_url_scheme=myapp",
    "successfully_aggregated_at": null,
    "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
  }
}

Endpoint:

DELETE /users/{user_guid}/members/{member_guid}

Example request

1
2
3
4
curl -i -X DELETE https://int-api.mx.com/users/USR-1234/members/MBR-4567
2bab47 \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}'

Endpoint:

GET /users/{user_guid}/members/{member_guid}/oauth_window_uri

Example request

1
2
3
curl -L -X GET 'https://int-api.mx.com/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f/oauth_window_uri' \
-H 'Authorization: Basic {token}' \
-H 'Accept: application/vnd.mx.api.v2+json'

Example response

1
2
3
4
5
6
{
    "member": {
        "guid": "MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f",
        "oauth_window_uri": "int-widgets.moneydesktop.com/oauth/predirect_to/MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f/zgknnw5k7dmztn2njmwlgz574mZlnft6vdrv7kzn9ptj325th6c5p0w6c7j83Ap1bqg01mhsr1bqjgf2fry3ly9wff497c6fcczbyrfgj7s39cygw95Akl7vlpmcAy2kmvh1mlkytg7jA1z3vnw1w3zx2r1wt65s6f6r3ryqqrysl9qA1kr6cAj6vhr1zl325Azz6hx52j1ll3vwbvvbv5xzy7d6csplyw25brA7147vAfq29ArjjAj4qmc6r6h457hkcj2946m0kjp2xzpkz6hz55lsp3Avmdb8dsq4xzqmzzqk68s6bp5tj9jsskw4wvcb95vm4fwh9w8phgp67hfj2flrtwcy5bxbtk74?skip_aggregation=false"
    }
}

Endpoint:

GET /users/{user_guid}/members/{member_guid}/challenges

Example request:

1
2
3
4
curl -X GET https://int-api.mx.com/users/USR-1234/members/MBR-1234/challenges
2bab47 \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}'

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
  "challenges": [
    {
      "field_name": "text",
      "guid": "CRD-123",
      "label": "What is your name",
      "type": "TEXT"
    },
    {
      "field_name": "text",
      "guid": "CRD-456",
      "label": "What is your favorite color?",
      "options": [
        {
          "label": "Blue",
          "value": 1
        },
        {
          "label": "Red",
          "value": 2
        }
      ],
      "type": "OPTIONS"
    }
  ]
}

Endpoint:

GET /users/{user_guid}/members/{member_guid}/credentials

Example request:

1
2
3
curl -L -X GET 'https://int-api.mx.com/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-3bdc7d6b-efd4-1497-a0af-b23501cf9bd0/credentials' \
-H 'Authorization: Basic {token}' \
-H 'Accept: application/vnd.mx.api.v1+json'

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "credentials": [
    {
      "display_order": 1,
      "field_name": "LOGIN",
      "field_type": "LOGIN",
      "guid": "CRD-9f61fb4c-912c-bd1e-b175-ccc7f0275cc1",
      "label": "Username"
    },
    {
      "display_order": 2,
      "field_name": "PASSWORD",
      "field_type": "PASSWORD",
      "guid": "CRD-e3d7ea81-aac7-05e9-fbdd-4b493c6e474d",
      "label": "Password"
    }
  ]
}

Endpoint:

GET /users/{user_guid}/members

Example request:

1
2
3
curl -X GET https://int-api.mx.com/users/USR-1234/members \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}'

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
{
  "members": [
    {
      "aggregated_at": "2019-12-03T18:10:22Z",
      "connection_status": "CONNECTED",
      "guid": "MBR-3bdc7d6b-efd4-1497-a0af-b23501cf9bd0",
      "id": null,
      "institution_code": "mxbank",
      "is_being_aggregated": false,
      "is_oauth": false,
      "metadata": null,
      "name": "MX Bank",
      "successfully_aggregated_at": "2019-08-08T16:17:51Z",
      "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
    },
    {
      "aggregated_at": "2019-12-03T18:10:22Z",
      "connection_status": "FAILED",
      "guid": "MBR-61bfd52c-2e3c-44ef-b747-20797a6f9dc0",
      "id": null,
      "institution_code": "capital_one",
      "is_being_aggregated": false,
      "is_oauth": false,
      "metadata": null,
      "name": "Capital One ",
      "successfully_aggregated_at": null,
      "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
    },
    {
      "aggregated_at": "2019-12-03T18:10:23Z",
      "connection_status": "DEGRADED",
      "guid": "MBR-98ae3e6e-1623-4471-add6-b464bdb4a900",
      "id": null,
      "institution_code": "paypal",
      "is_being_aggregated": false,
      "is_oauth": false,
      "metadata": null,
      "name": "PayPal",
      "successfully_aggregated_at": null,
      "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_entries": 3,
    "total_pages": 1
  }
}

Endpoint:

GET /users/{user_guid}/members/{member_guid}

Example request:

1
2
3
4
curl -X GET https://int-api.mx.com/users/USR-1234/members/MBR-4567
2bab47 \
  -H 'Accept: application/vnd.mx.api.v1+json' \
  -H 'Authorization: Basic {token}'

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "member": {
    "aggregated_at": "2019-12-03T18:10:22Z",
    "connection_status": "FAILED",
    "guid": "MBR-3bdc7d6b-efd4-1497-a0af-b23501cf9bd0",
    "id": null,
    "institution_code": "mxbank",
    "is_being_aggregated": false,
    "is_oauth": false,
    "metadata": null,
    "name": "MX Bank",
    "successfully_aggregated_at": "2019-08-08T16:17:51Z",
    "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
  }
}

Endpoint:

GET /users/{user_guid}/members/{member_guid}/status

Example request

1
2
3
curl -L -X GET 'https://int-api.mx.com/users/USR-3a17a2b1-acbc-48d1-8098-1b8ae8939ab2/members/MBR-3bdc7d6b-efd4-1497-a0af-b23501cf9bd0/status' \
-H 'Accept: application/vnd.mx.api.v1+json' \
-H 'Authorization: Basic {token}'

Example response

1
2
3
4
5
6
7
8
9
10
{
  "member": {
    "aggregated_at": "2020-05-07T22:01:00Z",
    "connection_status": "CONNECTED",
    "guid": "MBR-3bdc7d6b-efd4-1497-a0af-b23501cf9bd0",
    "is_authenticated": true,
    "is_being_aggregated": false,
    "successfully_aggregated_at": "2020-05-07T22:01:25Z"
  }
}

Endpoint:

PUT /users/{user_guid}/members/{member_guid}/resume

Example request

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
curl -L -X PUT 'https://int-api.mx.com/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-3bdc7d6b-efd4-1497-a0af-b23501cf9bd0/resume' \
-H 'Authorization: Basic {token}' \
-H 'Accept: application/vnd.mx.api.v1+json' \
-H 'Content-Type: application/json' \
-d '{
      "member": {
        "challenges": [
          {
            "guid": "CRD-2378634-33ub5bhk54kjb",
            "value": "user-entered-value"
          },
          {
            "guid": "CRD-iu34yu39-98745jb45jb-d987r6",
            "value": "user-entered-value"
          }
        ]
      }
    }'

Example response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "member": {
    "aggregated_at": "2020-04-29T20:40:07Z",
    "connection_status": "RESUMED",
    "guid": "MBR-3bdc7d6b-efd4-1497-a0af-b23501cf9bd0",
    "id": null,
    "institution_code": "mxbank",
    "is_being_aggregated": true,
    "metadata": null,
    "name": "MX Bank",
    "successfully_aggregated_at": "2019-08-08T16:17:51Z",
    "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
  }
}

Endpoint:

PUT /users/{user_guid}/members/{member_guid}

Example request

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
curl -L -X PUT 'https://int-api.mx.com/users/USR-3a17a2b1-acbc-48d1-8098-1b8ae8939ab2/members/MBR-3bdc7d6b-efd4-1497-a0af-b23501cf9bd0' \
-H 'Authorization: Basic {token}' \
-H 'Accept: application/vnd.mx.api.v1+json' \
-H 'Content-Type: application/json' \
-d '{
      "member": {
        "credentials": [
          {
            "guid": "CRD-598ec8d4-6200-8cda-345d-3dbb5fc17716",
            "value": "updated-username"
          },
          {
            "guid": "CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f",
            "value": "updated-password"
          }
        ],
        "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-16\"}"
      }
    }'

Example response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "member": {
    "aggregated_at": "2019-12-03T18:10:22Z",
    "connection_status": "CONNECTED",
    "guid": "MBR-3bdc7d6b-efd4-1497-a0af-b23501cf9bd0",
    "id": null,
    "institution_code": "mxbank",
    "is_being_aggregated": true,
    "is_oauth": false,
    "metadata": null,
    "name": "MX Bank",
    "successfully_aggregated_at": "2019-08-08T16:17:51Z",
    "user_guid": "USR-3a17a2b1-acbc-48d1-8098-1b8ae8939ab2"
  }
}