MX Platform Managed_members API
The Managed_members API from MX Platform — 6 operation(s) for managed_members.
OpenAPI Specification
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.'
title: MX Platform Managed_members API
version: 0.1.0
servers:
- url: https://api.mx.com
- url: https://int-api.mx.com
security:
- basicAuth: []
tags:
- name: Managed_members
paths:
/users/{user_guid}/managed_members:
get:
description: This endpoint returns a list of all the partner-managed members associated with the specified `user`.
operationId: listManagedMembers
parameters:
- description: Specify current page.
example: 1
in: query
name: page
schema:
type: integer
- description: Specify records per page.
example: 10
in: query
name: records_per_page
schema:
type: integer
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MembersResponseBody'
description: OK
summary: List managed members
tags:
- Managed_members
post:
description: Use this endpoint to create a new partner-managed `member`.
operationId: createManagedMember
parameters:
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedMemberCreateRequestBody'
description: Managed member to be created.
required: true
responses:
'202':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: OK
summary: Create managed member
tags:
- Managed_members
/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.
operationId: deleteManagedMember
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'204':
description: No Content
summary: Delete managed member
tags:
- Managed_members
get:
description: This endpoint returns the attributes of the specified partner-managed `member`.
operationId: readManagedMember
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: OK
summary: Read managed member
tags:
- Managed_members
put:
description: Use this endpoint to update the attributes of the specified partner_managed `member`.
operationId: updateManagedMember
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
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)
required: true
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: OK
summary: Update managed member
tags:
- Managed_members
/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-manage member.
operationId: listManagedAccounts
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: Specify current page.
example: 1
in: query
name: page
schema:
type: integer
- description: Specify records per page.
example: 10
in: query
name: records_per_page
schema:
type: integer
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/AccountsResponseBody'
description: OK
summary: List managed accounts
tags:
- Managed_members
post:
description: Use this endpoint to create a partner-managed account.
operationId: createManagedAccount
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedAccountCreateRequestBody'
description: Managed account to be created.
required: true
responses:
'202':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/AccountResponseBody'
description: OK
summary: Create managed account
tags:
- Managed_members
/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`.
operationId: deleteManagedAccount
parameters:
- description: The unique id for an `account`.
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
in: path
name: account_guid
required: true
schema:
type: string
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'204':
description: No Content
summary: Delete managed account
tags:
- Managed_members
get:
description: Use this endpoint to read the attributes of a partner-managed account according to its unique guid.
operationId: readManagedAccount
parameters:
- description: The unique id for an `account`.
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
in: path
name: account_guid
required: true
schema:
type: string
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/AccountResponseBody'
description: OK
summary: Read managed account
tags:
- Managed_members
put:
description: Use this endpoint to update the attributes of a partner-managed account according to its unique GUID.
operationId: updateManagedAccount
parameters:
- description: The unique id for an `account`.
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
in: path
name: account_guid
required: true
schema:
type: string
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
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/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/AccountResponseBody'
description: OK
summary: Update managed account
tags:
- Managed_members
/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`.
operationId: listManagedTransactions
parameters:
- description: The unique id for an `account`.
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
in: path
name: account_guid
required: true
schema:
type: string
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: Specify current page.
example: 1
in: query
name: page
schema:
type: integer
- description: Specify records per page.
example: 10
in: query
name: records_per_page
schema:
type: integer
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/TransactionsResponseBody'
description: OK
summary: List managed transactions
tags:
- Managed_members
post:
description: Use this endpoint to create a new partner-managed `transaction`.
operationId: createManagedTransaction
parameters:
- description: The unique id for an `account`.
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
in: path
name: account_guid
required: true
schema:
type: string
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedTransactionCreateRequestBody'
description: Managed transaction to be created.
required: true
responses:
'202':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/TransactionResponseBody'
description: OK
summary: Create managed transaction
tags:
- Managed_members
/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.
operationId: deleteManagedTransaction
parameters:
- description: The unique id for an `account`.
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
in: path
name: account_guid
required: true
schema:
type: string
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `transaction`.
example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4
in: path
name: transaction_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'204':
description: No Content
summary: Delete managed transaction
tags:
- Managed_members
get:
description: Requests to this endpoint will return the attributes of the specified partner-managed `transaction`.
operationId: readManagedTransaction
parameters:
- description: The unique id for an `account`.
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
in: path
name: account_guid
required: true
schema:
type: string
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `transaction`.
example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4
in: path
name: transaction_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/TransactionResponseBody'
description: OK
summary: Read managed transaction
tags:
- Managed_members
put:
description: Use this endpoint to update the attributes of the specified partner_managed `transaction`.
operationId: updateManagedTransaction
parameters:
- description: The unique id for an `account`.
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
in: path
name: account_guid
required: true
schema:
type: string
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `transaction`.
example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4
in: path
name: transaction_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
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/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/TransactionResponseBody'
description: OK
summary: Update managed transaction
tags:
- Managed_members
components:
schemas:
ManagedAccountUpdateRequestBody:
properties:
account:
$ref: '#/components/schemas/ManagedAccountUpdateRequest'
type: object
PaginationResponse:
properties:
current_page:
example: 1
type: integer
per_page:
example: 25
type: integer
total_entries:
example: 1
type: integer
total_pages:
example: 1
type: integer
type: object
ManagedMemberUpdateRequestBody:
properties:
member:
$ref: '#/components/schemas/ManagedMemberUpdateRequest'
type: object
AccountsResponseBody:
properties:
accounts:
items:
$ref: '#/components/schemas/AccountResponse'
type: array
pagination:
$ref: '#/components/schemas/PaginationResponse'
type: object
ManagedMemberUpdateRequest:
properties:
id:
example: member123
type: string
metadata:
example: some metadata
type: string
name:
example: MX Bank
type: string
type: object
ManagedAccountUpdateRequest:
properties:
account_number:
example: '5366'
type: string
apr:
example: 1
type: number
apy:
example: 1
type: number
available_balance:
example: 1000
type: number
available_credit:
example: 1000
type: number
balance:
example: 1000
type: number
cash_surrender_value:
example: 1000
type: number
credit_limit:
example: 100
type: number
currency_code:
example: USD
type: string
day_payment_is_due:
example: 20
type: integer
death_benefit:
example: 1000
type: integer
id:
example: '1040434698'
type: string
interest_rate:
example: 1
type: number
is_closed:
example: false
type: boolean
is_hidden:
example: false
type: boolean
last_payment:
example: 100
type: number
last_payment_at:
example: '2015-10-13T17:57:37.000Z'
type: string
loan_amount:
example: 1000
type: number
matures_on:
example: '2015-10-13T17:57:37.000Z'
type: string
metadata:
example: some metadata
type: string
minimum_balance:
example: 100
type: number
minimum_payment:
example: 10
type: number
name:
example: Test account 2
type: string
nickname:
example: Swiss Account
type: string
original_balance:
example: 10
type: number
payment_due_at:
example: '2015-10-13T17:57:37.000Z'
type: string
payoff_balance:
example: 10
type: number
routing_number:
example: '68899990000000'
type: string
started_on:
example: '2015-10-13T17:57:37.000Z'
type: string
subtype:
example: NONE
type: string
type:
example: SAVINGS
type: string
type: object
MembersResponseBody:
properties:
members:
items:
$ref: '#/components/schemas/MemberResponse'
type: array
pagination:
$ref: '#/components/schemas/PaginationResponse'
type: object
ManagedMemberCreateRequestBody:
properties:
member:
$ref: '#/components/schemas/ManagedMemberCreateRequest'
type: object
AccountResponse:
properties:
account_number:
example: '5366'
nullable: true
type: string
account_ownership:
example: INDIVIDUAL
nullable: true
type: string
annuity_policy_to_date:
example: '2016-10-13T17:57:37.000Z'
nullable: true
type: string
annuity_provider:
example: Metlife
nullable: true
type: string
annuity_term_year:
example: 2048
nullable: true
type: number
apr:
example: 1
nullable: true
type: number
apy:
example: 1
nullable: true
type: number
available_balance:
example: 1000
nullable: true
type: number
available_credit:
example: 1000
nullable: true
type: number
balance:
example: 10000
nullable: true
type: number
cash_balance:
example: 1000
nullable: true
type: number
cash_surrender_value:
example: 1000
nullable: true
type: number
created_at:
example: '2023-07-25T17:14:46Z'
nullable: false
type: string
credit_limit:
example: 100
nullable: true
type: number
currency_code:
example: USD
nullable: true
type: string
day_payment_is_due:
example: 20
nullable: true
type: integer
death_benefit:
example: 1000
nullable: true
type: integer
federal_insurance_status:
example: INSURED
nullable: true
type: string
guid:
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
nullable: true
type: string
holdings_value:
example: 1000
nullable: true
type: number
id:
example: '1040434698'
nullable: true
type: string
imported_at:
example: '2015-10-13T17:57:37.000Z'
nullable: true
type: string
institution_code:
example: 3af3685e-05d9-7060-359f-008d0755e993
nullable: true
type: string
insured_name:
example: Tommy Shelby
nullable: true
type: string
interest_rate:
example: 1
nullable: true
type: number
is_closed:
example: false
nullable: true
type: boolean
is_hidden:
example: false
nullable: true
type: boolean
is_manual:
example: false
nullable: true
type: boolean
last_payment:
example: 100
nullable: true
type: number
last_payment_at:
example: '2023-07-25T17:14:46Z'
nullable: true
type: string
loan_amount:
example: 1000
nullable: true
type: number
margin_balance:
example: 1000
nullable: true
type: number
matures_on:
example: '2015-10-13T17:57:37.000Z'
nullable: true
type: string
member_guid:
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
nullable: true
type: string
member_id:
example: member123
nullable: true
type: string
member_is_managed_by_user:
example: false
nullable: true
type: boolean
metadata:
example: some metadata
nullable: true
type: string
minimum_balance:
example: 100
nullable: true
type: number
minimum_payment:
example: 10
nullable: true
type: number
name:
example: Test account 2
nullable: true
type: string
nickname:
example: My Checking
nullable: true
type: string
original_balance:
example: 10
nullable: true
type: number
pay_out_amount:
example: 10
nullable: true
type: number
payment_due_at:
example: '2015-10-13T17:57:37.000Z'
nullable: true
type: string
payoff_balance:
example: 10
nullable: true
type: number
premium_amount:
example: 1
nullable: true
type: number
property_type:
example: VEHICLE
nullable: true
type: string
routing_number:
example: '68899990000000'
nullable: true
type: string
started_on:
example: '2015-10-13T17:57:37.000Z'
nullable: true
type: string
statement_balance:
example: 100.1
nullable: true
type: number
subtype:
example: NONE
nullable: true
type: string
today_ugl_amount:
example: 1000.5
nullable: true
type: number
today_ugl_percentage:
example: 6.9
nullable: true
type: number
total_account_value:
example: 1
nullable: true
type: number
total_account_value_ugl:
example: 1.1
nullable: true
type: number
type:
example: SAVINGS
nullable: true
type: string
updated_at:
example: '2016-10-13T18:08:00.000Z'
nullable: true
type: string
user_guid:
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
nullable: true
type: string
user_id:
example: user123
nullable: true
type: string
type: object
ManagedTransactionUpdateRequest:
properties:
amount:
example: '61.11'
type: string
category:
example: Groceries
type: string
check_number_string:
example: '6812'
type: string
currency_code:
example: USD
type: string
description:
example: Whole foods
type: string
id:
example: transaction-265abee9-889b-af6a-c69b-25157db2bdd9
type: string
is_international:
example: false
type: boolean
latitude:
example: -43.2075
type: number
localized_description:
example: This is a localized_description
type: string
localized_memo:
example: This is a localized_memo
type: string
longitude:
example: 139.691706
type: number
memo:
example: This is a memo
type: string
merchant_category_code:
example: 5411
type: integer
merchant_guid:
example: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b
type: string
merchant_location_guid:
example: MCL-00024e59-18b5-4d79-b879-2a7896726fea
type: string
metadata:
example: some metadata
type: string
posted_at:
example: '2016-10-07T06:00:00.000Z'
type: string
status:
example: POSTED
type: string
transacted_at:
example: '2016-10-06T13:00:00.000Z'
type: string
type:
example: DEBIT
type: string
type: object
ManagedMemberCreateRequest:
properties:
id:
example: member123
type: string
institution_code:
example: mxbank
type: string
metadata:
example: some metadata
type: string
name:
example: MX Bank
type: string
required:
- institution_code
type: object
ManagedAccountCreateRequestBody:
properties:
account:
$ref: '#/components/schemas/ManagedAccountCreateRequest'
type: object
ManagedAccountCreateRequest:
properties:
account_number:
example: '5366'
type: string
apr:
example: 1
type: number
apy:
example: 1
type: number
available_balance:
example: 1000
type: number
available_credit:
example: 1000
type: number
balance:
example: 1000
type: number
cash_surrender_value:
example: 1000
type: number
credit_limit:
example: 100
type: number
currency_code:
example: USD
type: string
day_payment_is_due:
example: 20
type: integer
death_benefit:
example: 1000
type: integer
id:
example: '1040434698'
type: string
interest_rate:
example: 1
type: number
is_closed:
example: false
type: boolean
is_hidden:
example: false
type: boolean
last_payment:
example: 100
type: number
last_payment_at:
example: '2015-10-13T17:57:37.000Z'
type: string
loan_amount:
example: 1000
type: number
matures_on:
example: '2015-10-13T17:57:37.000Z'
type: string
metadata:
example: some metadata
type: string
minimum_balance:
example: 100
type: number
minimum_payment:
example: 10
type: number
name:
example: Test account 2
type: string
nickname:
example: Swiss Account
type: string
original_balance:
example: 10
type: number
payment_due_at:
example: '2015-10-13T17:57:37.000Z'
type: string
payoff_balance:
example: 10
type: number
routing_number:
example: '68
# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mx-platform/refs/heads/main/openapi/mx-platform-managed-members-api-openapi.yml