Code Changes & Developer Documentation

  • Updated

In order to migrate to Open Banking or OAuth, you may be required to offer developer support depending on the product you use.

Select the product you use below for more information on changes and requirements for set up.

  • Complete the steps below to set up a successful connection.
    1. Share the Developer Docs

      Share the developer documentation with your developer team. The guides will introduce them to what they need to know to implement OAuth, including an creating an OAuth member, generating an OAuth URI from the member, sending the user to the URI and getting the user back to their app.

    2. Test Against MX Bank

      After making code changes, it is not possible to test against live production financial institutions, however, integration testing is possible through MX Bank. You will find instructions on how to test against MX bank in the developer docs.

    3. Register Your Company with OAuth

      Manage your institution's OAuth information. This information is used to register your company with all OAuth connections MX provides.

      To register your company, email your Client Success Consultant the following information:

      • Display name of application/company
      • 100px x 100px logo
      • Address
      • Phone number
      • Support email
      • Main URL
      • App description

      Only Display name and logo will be presented to the end user.

    4. Activation

      Once you have completed the three steps above, reach out to your Client Success Consultant to let them know you have completed set up or submit a ticket to support.

      MX will turn on the OAuth functionality for all supported OAuth connections for your customers. This means rather than your customers having to authenticate with a username and password in MX like they previously have, if an institution has set up OAuth, they will be redirected to that institution to authenticate. To learn more about the new user experience, click here.

    Once you have completed all of the steps in the developer guide and tested against MX Bank, your OAuth integration is complete.

  • Complete the steps below to set up a successful connection.
    1. Developer Docs

      Share the developer documentation with your developer team. The guides will introduce them to what they need to know to implement OAuth, including an creating an OAuth member, generating an OAuth URI from the member, sending the user to the URI and getting the user back to their app.

    2. Test Against MX Bank

      After making code changes, it is not possible to test against live production financial institutions, however, integration testing is possible through MX Bank. You will find instructions on how to test against MX bank in the developer docs.

    3. Register Your Company with OAuth

      Manage your institution's OAuth information. This information is used to register your company with all OAuth connections MX provides.

      To register your company:

      1. Navigate to the Client Dashboard and sign in with your credentials.
      2. Select Developers from the menu on the left.
      3. Select OAuth.
      4. Enter in the requested information: App Name, Description, Company Website, etc.
      5. Click Submit.

      Only Display name and logo will be presented to the end user.

      mceclip0.png
    4. Activation

      Once you have completed the three steps above, reach out to your Client Success Consultant to let them know you have completed set up or submit a ticket to support.

      MX will turn on the OAuth functionality for all supported OAuth connections for your customers. This means rather than your customers having to authenticate with a username and password in MX like they previously have, if an institution has set up OAuth, they will be redirected to that institution to authenticate. To learn more about the new user experience, click here.

    Once you have completed all of the steps in the developer guide and tested against MX Bank, your OAuth integration is complete.

  • Complete the steps below to set up a successful connection.
    1. Developer Docs

      Share the following guides with your developer team:

      The guides will introduce them to what they need to know to implement OAuth, including an creating an OAuth member, generating an OAuth URI from the member, sending the user to the URI and getting the user back to their app.

    2. Register Your Company with OAuth

      Manage your institution's OAuth information. This information is used to register your company with all OAuth connections MX provides.

      To register your company:

      1. Navigate to the Client Dashboard and sign in with your credentials.
      2. Select Developers from the menu on the left.
      3. Select OAuth. 
      4. Enter in the requested information: App Name, Description, Company Website, etc.
      5. Click Submit.

      Only Display name and logo will be presented to the end user.

      mceclip0.png
    3. Activation

      Once you have completed the three steps above, reach out to your Client Success Consultant to let them know you have completed set up or submit a ticket to support.

      MX will turn on the OAuth functionality for all supported OAuth connections for your customers. This means rather than your customers having to authenticate with a username and password in MX like they previously have, if an institution has set up OAuth, they will be redirected to that institution to authenticate. To learn more about the new user experience, click here.

    Once you have completed all of the steps in the developer guide and tested against MX Bank, your OAuth integration is complete.

  • Clients utilizing the Connect widget in a desktop or mobile browser should not have to make any additional implementation changes.

  • Clients utilizing MXmobile should not have to make any additional implementation changes. MXmobile version 2.55 or higher is required. To find out what version you are on, reach out to your Client Success Consultant (CSC).

Was this article helpful?