MX integration overview

Overview

MX provides financial data services. Persona’s MX Marketplace integration supports the operations below for working with MX users, connected members and accounts, microdeposits, and widget URLs.

MX Operations Overview

Persona can create and look up MX users, retrieve connected account and member information, read microdeposit details, and request a widget URL. The configuration fields below reflect the inputs available for each operation. The required MX API version header is supplied by the integration and does not need to be entered.

List Users

Use this operation to find users created in MX. Filter by your user ID, email address, or disabled status when you need a narrower list, or page through the results.

Configuration Steps:

• Provide values for required fields:
  • None
• Optionally add:
  • Page Number
  • Records Per Page
  • User ID
  • Email Address
  • Is Disabled

Create User

Use this operation to create an MX user and receive its User GUID for later lookups. The User object cannot be empty, but none of its individual fields is required; provide at least one of the optional fields below.

Configuration Steps:

• Provide values for required fields:
  • User (a nonempty object)
• Optionally add within User:
  • Email Address
  • User ID (your own identifier for the user)
  • Is Disabled
  • Metadata

Read Account

Use this operation to retrieve a specific account when you have its Account GUID and the associated MX User GUID.

Configuration Steps:

• Provide values for required fields:
  • User GUID
  • Account GUID
• Optionally add:
  • None

Read Member

Use this operation to retrieve the attributes of a specific connected member for an MX user.

Configuration Steps:

• Provide values for required fields:
  • User GUID
  • Member GUID
• Optionally add:
  • None

List Account Owners by Member

Use this operation to retrieve account-owner information associated with a member. You can page through the results when needed.

Configuration Steps:

• Provide values for required fields:
  • User GUID
  • Member GUID
• Optionally add:
  • Page Number
  • Records Per Page

List Account Numbers by Member

Use this operation to retrieve the account numbers associated with a member. You can page through the results when needed.

Configuration Steps:

• Provide values for required fields:
  • User GUID
  • Member GUID
• Optionally add:
  • Page Number
  • Records Per Page

Read a Microdeposit for a User

Use this operation to read the attributes of a specific microdeposit for an MX user, including its status when available.

Configuration Steps:

• Provide values for required fields:
  • User GUID
  • Microdeposit GUID
• Optionally add:
  • None

Request Widget URL

Use this operation to request a widget URL for an MX user. For MX Connect, the Widget Type is connect_widget; the integration defaults to that value. A request body is required, but the Widget URL configuration object is optional. If you include it, Widget Type is required within that object; the other configuration fields are optional.

Configuration Steps:

• Provide values for required fields:
  • User GUID
  • Request body (the Widget URL configuration object is optional)
• Optionally add:
  • Language
  • Widget URL configuration (if supplied, Widget Type is required within it):
    • Widget Type (defaults to connect_widget)
    • Client Redirect URL
    • Color Scheme
    • Current Institution Code
    • Current Institution GUID
    • Current Member GUID
    • Disable Background Aggregation
    • Disable Institution Search
    • Include Identity
    • Include Transactions
    • Insight GUID
    • Is Mobile Webview
    • Current Microdeposit GUID
    • Microwidget Instance ID
    • Mode
    • OAuth Referral Source
    • UI Message Version
    • UI Message Webview URL Scheme
    • Update Credentials

Configuring the MX Bank form in an Inquiry involves additional setup. To learn more about that setup, contact your Persona team.

Plans Explained

MX Integration by plan

Learn more about pricing and plans.