What can the API do for you?

The MX Platform API provides a wide range of features that allow banks, fintechs, and other financial institutions to give end users an exceptional experience. These include:

• Account and transaction data aggregation from tens of thousands of institutions.
• For some institutions, up to 24 months of transaction data can be gathered in a single request.
• Held data can be managed entirely on your own while still maintaining access to the other features of the API.
• Industry-leading data enhancement out of the box, including automatic transaction categorization and classification, custom categorization by end users, and description cleansing.
• Enhancement for non-aggregated data provided directly from your own systems.
• Account verification — often eliminating the need for microdeposits — as well as owner identification.
• Personalization including transaction rules, custom tags, and custom categories.
• MX’s award-wining personal financial management widgets, including Connect, which automates aggregation and account verification.
• Merchant data for thousands of businesses and vendors.

Start here for all integrations and use cases

Every new integration with the MX Platform API needs to start with the following tasks, regardless of your particular use case. These will ensure your integration has the fewest possible complications.

• Complete the sign-up process if you have not already.
• Get your development-level client_id and api_key from the dashboard, and keep them secret and secure!
• Whitelist all IP addresses that will make requests to the API.
• Read though the API’s standards, conventions, errors, and global requirements.
  • The section on authentication and security is especially important — it covers HTTPS, TLS, and how to correctly use your client_id and api_key.
• Follow our guide on creating users and members.
• Read our Postman guide and get set up to use this powerful tool as you explore, build, and test.
• Keep in mind that all OAuth development and testing must be done with the MX Bank (OAuth) test institution; production institutions require prior registration.

Checklists for common use cases

The following set of checklists outline tasks and requirements for common use cases. Completing them will minimize your problems as you code up to the API.

Aggregation with API endpoints

• Follow our guide on creating users and members.
• Follow our guide on the aggregation process.
• Read and understand the details of a member’s connection status.
• Pay careful attention to dealing with multi-factor authentication.
• Follow our guide on reading account and transaction data.
• Make sure to consult the API reference throughout.
• Keep track of success and error rates on the dashboard metrics page.

Connect widget (aggregation and verification)

• Determine which type of integration is best for you:
  • Browser guide.
  • Mobile app guide.
    • With mobile, consider whether you’ll be using a hybrid mobile webapp, that is, a webapp embedded inside a WebView.
    • Consult our demo apps for iOS and Android.
• Determine which mode is appropriate for your use case, either aggregation or verification.
• Prepare to handle event messages:
  • PostMessages.
  • Alternative messages for WebViews.

Dealing with OAuth

• Determine which type of integration is best for you.
  • Browser with API aggregation or verification.
  • Browser with the Connect widget.
  • Mobile app with API aggregation or verification.
  • Mobile app with the Connect widget.
  • Hybrid mobile webapp with the Connect widget.
• Keep in mind that all OAuth development and testing must be done with the MX Bank (OAuth) test institution; production institutions require prior registration.
• After testing, request production access.
• Fill out the OAuth registration form on the dashboard as soon as you request production access.

Verification

• Determine which type of integration is best for you:
  • API-only guide.
  • Connect widget guide.
• Read and understand the details of a member’s connection status.
• Pay careful attention to dealing with multi-factor authentication.
• Keep track of success and error rates on the dashboard metrics page.

Webhooks

• Determine which type of webhook will be required for your use case.
• Set up an appropriate callback URL for you to recieve webhooks from MX.
• Create and configure a development webhook using your callback URL.
• Set up and configure production webhooks after requesting production access.

Contacting support

Make sure to have the following information when making a support request, wherever applicable:

• Steps to replicate the issue.
• MX-defined GUIDs for any users or members associated with the request.
• Operating system information.
• Browser information.
• End-user screenshots or videos.

This video also has important information on using the MX support portal.

Going to production

• Request production access on the dashboard.
• Get your production-level client_id and api_key and keep them secret and secure! These are different from your development-level ID and key.
• Fill out the OAuth registration form on the dashboard if necessary.
• Set up and configure production webhooks if necessary.
• Contact MX to ensure that all the necessary products and configurations have been enabled in the production environment.