MX Technologies managed data [deprecated] API
The managed data [deprecated] API from MX Technologies — 7 operation(s) for managed data [deprecated].
The managed data [deprecated] API from MX Technologies — 7 operation(s) for managed data [deprecated].
openapi: 3.0.0
info:
contact:
name: MX Platform API
url: https://www.mx.com/products/platform-api
description: 'The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.
Just getting started? See our [use case guides](/use-cases/).
'
title: MX Platform accounts managed data [deprecated] API
version: '20111101'
servers:
- url: https://int-api.mx.com
- url: https://api.mx.com
security:
- basicAuth: []
tags:
- name: managed data [deprecated]
paths:
/managed_institutions:
get:
description: 'This endpoint returns a list of institutions which can be used to create partner-managed members.
:::warning Deprecated
This endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration)
:::
'
operationId: listManagedInstitutions
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InstitutionsResponseBody'
description: OK
summary: List managed institutions
tags:
- managed data [deprecated]
deprecated: true
/users/{user_guid}/managed_members:
get:
description: 'This endpoint returns a list of all the partner-managed members associated with the specified `user`.
:::warning Deprecated
This endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).
:::
'
operationId: listManagedMembers
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/userGuid'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MembersResponseBody'
description: OK
summary: List managed members
tags:
- managed data [deprecated]
deprecated: true
post:
description: 'Use this endpoint to create a new partner-managed `member`.
:::warning Deprecated
This endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).
:::
'
operationId: createManagedMember
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/userGuid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedMemberCreateRequestBody'
description: Managed member to be created.
required: true
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: OK
summary: Create managed member
tags:
- managed data [deprecated]
deprecated: true
/users/{user_guid}/managed_members/{member_guid}:
delete:
description: 'Use this endpoint to delete the specified partner-managed `member`. The endpoint will respond with a status of `204 No Content` without a resource.
:::warning Deprecated
This endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).
:::
'
operationId: deleteManagedMember
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/acceptHeader'
- $ref: '#/components/parameters/userGuid'
responses:
'204':
description: No Content
summary: Delete managed member
tags:
- managed data [deprecated]
deprecated: true
get:
description: 'This endpoint returns the attributes of the specified partner-managed`member`.
:::warning Deprecated
This endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).
:::
'
operationId: readManagedMember
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/userGuid'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: OK
summary: Read managed member
tags:
- managed data [deprecated]
deprecated: true
put:
description: 'Use this endpoint to update the attributes of the specified partner_managed `member`.
:::warning Deprecated
This endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).
:::
'
operationId: updateManagedMember
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/userGuid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedMemberUpdateRequestBody'
description: 'Managed member object to be updated (While no single parameter is required, the request body can''t be empty).
:::warning Deprecated
This endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).
:::
'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: OK
summary: Update managed member
tags:
- managed data [deprecated]
deprecated: true
/users/{user_guid}/managed_members/{member_guid}/accounts:
get:
description: 'Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-managed member.
:::warning Deprecated
This endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).
:::
'
operationId: listManagedAccounts
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/userGuid'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountsResponseBody'
description: OK
summary: List managed accounts
tags:
- managed data [deprecated]
deprecated: true
post:
description: 'Use this endpoint to create a partner-managed account.
:::warning Deprecated
This endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).
:::
'
operationId: createManagedAccount
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/userGuid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedAccountCreateRequestBody'
description: Managed account to be created.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountResponseBody'
description: OK
summary: Create managed account
tags:
- managed data [deprecated]
deprecated: true
/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}:
delete:
description: 'Use this endpoint to delete a partner-managed account according to its unique GUID. If successful, the API will respond with a status of `204 No Content`.
:::warning Deprecated
This endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).
:::
'
operationId: deleteManagedAccount
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/accountGuid'
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/userGuid'
responses:
'204':
description: No Content
summary: Delete managed account
tags:
- managed data [deprecated]
deprecated: true
get:
description: 'Use this endpoint to read the attributes of a partner-managed account according to its unique guid.
:::warning Deprecated
This endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).
:::
'
operationId: readManagedAccount
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/accountGuid'
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/userGuid'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountResponseBody'
description: OK
summary: Read managed account
tags:
- managed data [deprecated]
deprecated: true
put:
description: "Use this endpoint to update the attributes of a partner-managed account according to its unique GUID.\n:::warning Deprecated \nThis endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).\n:::\n"
operationId: updateManagedAccount
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/accountGuid'
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/userGuid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedAccountUpdateRequestBody'
description: Managed account object to be updated (While no single parameter is required, the request body can't be empty).
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountResponseBody'
description: OK
summary: Update managed account
tags:
- managed data [deprecated]
deprecated: true
/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions:
get:
description: 'This endpoint returns a list of all the partner-managed transactions associated with the specified `account`, scoped through a `user` and a `member`.
:::warning Deprecated
This endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).
:::
'
operationId: listManagedTransactions
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/accountGuid'
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/fromDate'
- $ref: '#/components/parameters/toDate'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/userGuid'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsResponseBody'
description: OK
summary: List managed transactions
tags:
- managed data [deprecated]
deprecated: true
post:
description: 'Use this endpoint to create a new partner-managed `transaction`.
:::warning Deprecated
This endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).
:::
'
operationId: createManagedTransaction
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/accountGuid'
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/userGuid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedTransactionCreateRequestBody'
description: Managed transaction to be created.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionResponseBody'
description: OK
summary: Create managed transaction
tags:
- managed data [deprecated]
deprecated: true
/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}:
delete:
description: 'Use this endpoint to delete the specified partner-managed `transaction`. The endpoint will respond with a status of `204 No Content` without a resource.
:::warning Deprecated
This endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).
:::
'
operationId: deleteManagedTransaction
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/accountGuid'
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/transactionGuid'
- $ref: '#/components/parameters/userGuid'
responses:
'204':
description: No Content
summary: Delete managed transaction
tags:
- managed data [deprecated]
deprecated: true
get:
description: 'Requests to this endpoint will return the attributes of the specified partner-managed `transaction`.
:::warning Deprecated
This endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).
:::
'
operationId: readManagedTransaction
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/accountGuid'
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/transactionGuid'
- $ref: '#/components/parameters/userGuid'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionResponseBody'
description: OK
summary: Read managed transaction
tags:
- managed data [deprecated]
deprecated: true
put:
description: 'Use this endpoint to update the attributes of the specified partner_managed `transaction`.
:::warning Deprecated
This endpoint has been deprecated. For more information, reference the [Migration guide](https://docs.mx.com/api-reference/platform-api/overview/migration).
:::
'
operationId: updateManagedTransaction
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/accountGuid'
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/transactionGuid'
- $ref: '#/components/parameters/userGuid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedTransactionUpdateRequestBody'
description: Managed transaction object to be updated (While no single parameter is required, the request body can't be empty)
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionResponseBody'
description: OK
summary: Update managed transaction
tags:
- managed data [deprecated]
deprecated: true
components:
schemas:
ManagedMemberCreateRequest:
properties:
id:
description: The unique partner-defined identifier for the member.
example: member123
type: string
institution_code:
description: The code identifying a financial institution.
example: mxbank
type: string
metadata:
description: Additional information you can store about the `member`.
example: some metadata
type: string
name:
description: The name of the `member`.
example: MX Bank
type: string
required:
- institution_code
type: object
ManagedMemberCreateRequestBody:
properties:
member:
$ref: '#/components/schemas/ManagedMemberCreateRequest'
type: object
SupportedProducts:
type: string
enum:
- account_verification
- identity_verification
- transactions
- transaction_history
- statements
- investments
- rewards
TransactionResponseBody:
properties:
transaction:
$ref: '#/components/schemas/TransactionResponse'
type: object
ManagedTransactionCreateRequestBody:
properties:
transaction:
$ref: '#/components/schemas/ManagedTransactionCreateRequest'
type: object
PaginationResponse:
properties:
current_page:
description: The page delivered by the current response.
example: 1
type: integer
per_page:
description: The number of records delivered with each page.
example: 25
type: integer
total_entries:
description: The total number of records available.
example: 1
type: integer
total_pages:
description: The total number of pages available.
example: 1
type: integer
type: object
ManagedAccountUpdateRequestBody:
properties:
account:
$ref: '#/components/schemas/ManagedAccountUpdateRequest'
type: object
AccountResponse:
properties:
account_number:
description: The account number associated with the account. This will typically be a masked or partial account number.
example: '3331261'
type: string
nullable: true
account_ownership:
description: The type of ownership associated with the account. `NULL` is returned if not received in the data feed.
example: INDIVIDUAL
nullable: true
type: string
enum:
- UNKNOWN
- INDIVIDUAL
- JOINT
- MULTIPLE
- null
annuity_policy_to_date:
description: The date until which the policy is in effect.
example: '2025-12-31'
nullable: true
type: string
annuity_provider:
description: The provider of the insurance policy.
example: Metlife
nullable: true
type: string
annuity_term_year:
description: The effective duration of an insurance policy (one year, five years, etc.).
example: 30
nullable: true
type: integer
apr:
description: The annual percentage rate associated with the `account`.
example: 1
nullable: true
type: number
apy:
description: The annual percentage yield associated with the `account`.
example: 2.35
nullable: true
type: number
available_balance:
description: 'The balance that is available for use in asset accounts like checking and savings.
`PENDING` transactions are typically (not always) taken into account with the available balance.
`available_balance` will usually be a positive value for all account types, determined in the same way as the balance field.
'
example: 1000
type: number
nullable: true
available_credit:
description: 'The amount of credit available for use in liability accounts like credit cards and lines of credit.
`PENDING` transactions are typically (not always) taken into account with available credit.
`available_credit` will usually be a positive value for all account types, determined in the same way as the `balance` field.
'
example: 4000
nullable: true
type: number
balance:
description: "The current balance of the account.\n\n`PENDING` transactions are typically not taken into account with the current balance, but this may not always be the case.\n \nThe balance will usually be a positive value for all account types. Asset-type accounts (`CHECKING`, `SAVINGS`, `INVESTMENT`) may have a negative balance if they are in overdraft.\n\nDebt-type accounts (`CREDIT_CARD`, `LOAN`, `LINE_OF_CREDIT`, `MORTGAGE`) may have a negative balance if they are overpaid.\n"
example: 1000
type: number
nullable: true
cash_balance:
description: The cash balance of the `account`.
example: 2500
nullable: true
type: number
cash_surrender_value:
description: The sum of money paid to the policyholder or annuity holder in the event the policy is voluntarily terminated before it matures, or the insured event occurs.
example: 1000
type: number
nullable: true
created_at:
description: The date and time the account was created, represented in ISO 8601 format with a timestamp.
example: '2025-02-13T18:08:00+00:00'
nullable: false
type: string
credit_limit:
description: The credit limit associated with the `account`.
example: 5000
nullable: true
type: number
currency_code:
description: The three-character ISO 4217 currency code, for example, `USD`.
example: USD
nullable: true
type: string
day_payment_is_due:
description: The day of the month the payment is due. For example, the 14th is passed as `14`.
example: 14
nullable: true
type: integer
death_benefit:
description: The amount paid to the beneficiary of the account upon death of the account owner.
example: 1000
nullable: true
type: integer
federal_insurance_status:
description: 'The federal insurance status of the account. Indicates whether the account is insured by the FDIC (banks) or NCUA (credit unions).
Returns an integer (`UNKNOWN_INSURED` = 0, `INSURED` = 1, `NOT_INSURED` = 2).
'
example: INSURED
nullable: true
type: string
enum:
- UNKNOWN_INSURED
- INSURED
- NOT_INSURED
guid:
description: Unique identifier for the account. Defined by MX.
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
nullable: true
type: string
id:
description: The unique partner-defined identifier for the account.
example: '1040434698'
nullable: true
type: string
imported_at:
description: The date and time at which the `account` was last successfully aggregated and received data.
example: '2015-10-13T17:57:37.000Z'
nullable: true
type: string
interest_rate:
description: The interest rate associated with the account.
example: 3.25
nullable: true
type: number
institution_code:
description: The code identifying a financial institution.
example: 3af3685e-05d9-7060-359f-008d0755e993
nullable: true
type: string
insured_name:
description: The name of the insured person.
example: Tommy Shelby
nullable: true
type: string
is_closed:
description: Indicates whether an account has been closed. Closed accounts will no longer update balance or transaction information.
example: false
type: boolean
is_hidden:
description: Indicates whether the account is hidden. Hidden accounts can still have an active balance and receive transactions. Defaults to `false`.
example: false
nullable: true
type: boolean
is_manual:
description: Indicates whether the transaction was manually created or belongs to a manual account.
example: false
nullable: true
type: boolean
last_payment:
description: The amount of the most recent payment on the `account`.
example: 100
nullable: true
type: number
last_payment_at:
description: The date and time when the last payment was made, represented in ISO 8601 format with a timestamp.
example: '2023-07-25T17:14:46Z'
nullable: true
type: string
loan_amount:
description: The amount of the loan associated with the `account`.
example: 1000
nullable: true
type: number
margin_balance:
description: Represents the amount of debt the investor owes to the broker for the use of margin. It can be positive or negative, depending on the performance of the investments made with the borrowed funds. A positive margin balance indicates that the securities purchased on margin have increased in value, whereas a negative margin balance signifies that the securities have decreased in value.
example: 1000
nullable: true
type: number
matures_on:
description: The date on which the `account` matures.
example: '2015-10-13T17:57:37.000Z'
nullable: true
type: string
member_guid:
description: The unique identifier for the member. Defined by MX.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
nullable: true
type: string
member_id:
description: The unique, partner-defined, identifier for the member associated with this `account`.
example: member123
nullable: true
type: string
member_is_managed_by_user:
description: This indicates whether the member is managed by the user or the MX partner. Members created with the managed member feature will have this field set to `false`.
example: false
nullable: true
type: boolean
metadata:
description: Additional information you stored about the `account`.
example: some metadata
nullable: true
type: string
minimum_balance:
description: The minimum balance associated with the `account`.
example: 100
nullable: true
type: number
minimum_payment:
description: The minimum payment required for an account. This can apply to any debt account.
example: 10
nullable: true
type: number
name:
description: The human-readable name for the resource.
example: Test account 2
nullable: true
type: string
nickname:
description: An alternate name for the `account`.
example: My Checking
nullable: true
type: string
original_balance:
description: The original balance associated with the `account`. This will always be positive.
example: 10
nullable: true
type: number
pay_out_amount:
description: The amount paid out to the insured individual or beneficiary under the conditions of the insurance policy.
example: 10
nullable: true
type: number
payment_due_at:
description: The date and time at which the next payment is due on the `account`.
example: '2015-10-13T17:57:37.000Z'
nullable: true
type: string
payoff_balance:
description: The payoff balance for a debt `account`. This will normally be a positive number.
example: 10
nullable: true
type: number
premium_amount:
description: The insurance policy's premium amount.
example: 1
nullable: true
type: number
property_type:
description: Subtype if the account type is `PROPERTY`. This field should be ignored unless the type is set to PROPERTY.
example: VEHICLE
nullable: true
type: string
enum:
- APPLIANCES
- ART
- COMPUTER
- ELECTRONICS
- FURNITURE
- JEWELRY
- MISCELLANEOUS
- REAL_ESTATE
- SPORTS_EQUIPMENT
- VEHICLE
routing_number:
description: The routing number for the `account`.
example: '68899990000000'
nullable: true
type: string
started_on:
description: The date on which the loan from a debt account started.
example: '2025-10-13T17:57:37.000Z'
nullable: true
type: string
statement_balance:
description: The balance at the end of the account's last statement period.
example: 1000.5
nullable: true
type: number
subtype:
description: The account's subtype, for example, `PLAN_401_K`, `MONEY_MARKET`, or `HOME_EQUITY`. Each subtype belongs to an account `type`. For a full list of account subtypes and types, see [Accounts](/api-reference/platform-api/reference/accounts).
example: MONEY_MARKET
nullable: true
type: string
today_ugl_amount:
description: The unrealized gain/loss amount for the day for the account.
example: 1000.5
nullable: true
type: number
today_ugl_percentage:
description: The unrealized gain/loss percentage for the date for the account.
example: 6.9
nullable: true
type: number
total_account_value:
description: The sum of the long and short positions, the sweep account and/or cash balance, and any margin debt associated with a particular account. This amount includes the market value of all positions held in the account and is reduced by any debit balance and the amount of short options positions that are "in the money". This may sum to a negative value, and it does not represent an account balance.
example: 1
nullable: true
type: number
total_account_value_ugl:
description: The unrealized gains and losses represent the amount the account has gained or lost based on the purchase price. This is calculated by subtracting the purchase price from the current market value. It does not affect the account until the positions are sold and "realized". This may sum to a negative value, and it does not represent an account balance.
exam
# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mx-technologies/refs/heads/main/openapi/mx-technologies-managed-data-deprecated-api-openapi.yml