Definitions - MX Documentation

System Terms

Term	Definition
Accessor	A Partner that accesses the SSO API with its unique API Key.
Client	An organization that uses MoneyDesktop and can create and modify a User. Clients are directly associated to a single Accessor.
User	An individual who uses MoneyDesktop.
Institution	A financial data provider such as a Bank, Credit Union, Prepaid Card Program, etc. that Users have accounts with.
Member	The connecting relationship of a User and an Institution. A Member contains the credentials that are used to get the User’s account and transaction information from an Institution.
Account	Checking, Savings, Prepaid Card, Loan, etc. for a given Member.
Transaction	A debit or credit for a given Account.
GUID	Globally Unique Identifier. All parameters having “guid” as a suffix must be unique in the system. MX does not adhere to the Microsoft® standard of GUIDs. All MX-generated GUIDs are known as internal GUIDs and are prefixed with three letters and a hyphen to help easily identify what the GUID is used for within the system (eg: CLT-abc… for a Client). All GUID parameters having “external” as a prefix are GUIDs that are provided by the Partner, as described in the Overview.

User Definitions

Term	Definition
guid	Prefixed with USR-. An internally defined identifier for the User.
external_guid	This has been replaced by and is identical in usage to external_user_guid which more clearly identifies its usage. It can be used any place that external_user_guid is used. Both values are returned in the User create and User read response bodies for backward compatibility.
external_user_guid	An externally defined (Partner defined) identifier for the User. This value is to be determined by the Partner and used in place of the MX-generated guid. The external_user_guid cannot start with “USR-” which is reserved for the system. It must be unique within each Client.
email	The email address of the User.
client_guid	Prefixed with CLT-. An internally defined identifier for the Client.
external_client_guid	An externally defined (Partner defined) identifier for the Client. This must be setup in the system prior to using the value.
login_token	A random and unique string of characters generated for each User during a User read or User create API request. The token expires upon first use or in ten minutes, whichever occurs first. To refresh or reload the page a new token must be generated.
master_widget_url	The single sign-on (SSO) URL that can be used to open the MoneyDesktop master widget. It is intended to be set as the src of an iFrame when embedding the master widget into a web page. It contains a login_token that expires on first use or in ten minutes, whichever occurs first. The master_widget_url is provided so that partners do not need to construct their own URL to open the widget. It also insulates partners from any changes within the URL. The contents of the URL can change from time to time. Please do not attempt to parse any values out of the URL or assume it will contain a fixed structure. The URL is intended to be used as-is as the source of an iFrame.
login_url	The single sign-on (SSO) URL that was used to open the legacy flash-based UI. This is now deprecated.
first_name	The first name of the User.
last_name	The last name of the User.
phone	The phone number of the User.
age	The age of the User.
sex	The sex of the User.
credit_score	The credit score of the User.
zip_code	The zip code of the User.

Member Definitions

Term	Definition
guid	Prefixed with MBR-. An internally defined identifier for the Member.
external_member_guid	An externally defined (Partner defined) identifier for the Member. Its use is optional.
institution_guid	Prefixed with INS-. An internally defined identifier for the Institution. Please do not use this parameter unless instructed to do so by MX.
user_guid	(see “guid” definition under User)
external_guid	(see “external_guid” definition under User)
external_user_guid	(see “external_user_guid” definition under User)
name	The name of the Institution. Please do not use this parameter unless instructed to do so by MX.
credentials	(array) `field_name`: The type of credential being sent to the system. Possible values include the pair “login” and “password”, or just “userkey”. `response`: The value for the corresponding field_name.
account_id	The account ID that was provided to MX in the data feed. It is used only in the delete account endpoint.

Status

Status types are used to determine which existing state the record is in. Possible values are:

Status	Value
PENDIND	0
ENABLED	1
DISABLED	2
DELETED	3

The status type for a JSON response will be composed of the following:

Term	Definition
status (object)	`status`: A number from the list above indicating the status. `name`: The name for the corresponding status number. `message`: A message, if one exists, specifying what action took place to set the new status.

API Requirements