Endpoints

EndpointRequest MethodDescription
GET
Find a single Institution and return its status.
GET
Listing institution-required credentials returns all credentials for the institutions along with pagination parameters.
GET
Returns a list of institutions based on the specified search term or parameter.
GET
Returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity.
GET
Returns a paginated list of all the merchants in the MX system.
GET
Returns the attributes of the specified merchant.
GET
Returns the specified account resource.
GET
Returns a list of account numbers associated with the specified account.
GET
Returns a list of the last 90 days of transactions associated with the specified account.
GET
Returns a list of all the accounts associated with the specified user.
DELETE
This endpoint is used to delete a specific custom category according to its unique GUID.
GET
Returns a list of account numbers associated with the specified account.
PUT
This endpoint is used to update the attributes of a custom category according to its unique GUID.
GET
This endpoint is used to list all categories associated with a user, including both default and custom categories.
POST
This endpoint is used to list all categories associated with a user, including both default and custom categories.
GET
This endpoint is used to retrieve a list of all the default categories and subcategories offered within the MX Platform API.
GET
Returns all holdings associated with the specified user across all accounts and members.
GET
Returns all holdings associated with the specified account.
GET
This endpoint is used to get an array of available statements.
GET
This endpoint is used to read a JSON representation of the statement.
GET
Use this endpoint to download a specified statement PDF.
DELETE
This endpoint will permanently delete the specified member.
GET
This endpoint returns information about the specified member.
PUT
This endpoint is used to update certain attributes of the specified member.
GET
This endpoint returns a list of account numbers associated with the specified member.
GET
Use this endpoint to check whether identity data is available for a specific member.
PUT
This endpoint allows you to update certain attributes of an account resource.
POST
This endpoint initiates an aggregation event for the member.
GET
Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member.
POST
This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data.
GET
This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.
POST
Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member.
POST
Use this endpoint to fetch the statements associated with a particular member.
GET
Returns all holdings associated with the specified member across all accounts.
GET
Returns information about the member’s connection to a financial institution, including crucial information about aggregation.
GET
Returns a list of transactions associated with the specified member, across all accounts associated with that member.
GET
Returns a list of all the members that belong to the specified user.
POST
This endpoint allows you to create a new member.
DELETE
This endpoint permanently deletes a transaction rule based on its unique GUID.
GET
This endpoint is used to read the attributes of an existing transaction rule based on the rule’s unique GUID.
PUT
This endpoint is used to read the attributes of an existing transaction rule based on the rule’s unique GUID.
GET
This endpoint is used to read the attributes of all existing transaction rules belonging to the user.
POST
This endpoint is used to create a new transaction rule.
GET
This endpoint will return the attributes of the specified transaction.
PUT
Use this endpoint to update the description of a specific transaction according to its unique GUID.
GET
Returns a list of transactions associated with the specified user, across all members and accounts associated with that user.
DELETE
This endpoint is used to delete the specified user.
GET
This endpoint will return the details of the specified user.
PUT
This endpoint is used to update the attributes of the specified user.
GET
Returns a list of all your users.
POST
Use this endpoint to create a new user.