Skip to content

Repository files navigation

Rust API client for mx-openapi-rs

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.

What's Changed?

Several endpoints, headers, and fields changed in v20250224. For more on breaking changes, refer to our versioning and migration guides.

Version Header

Versions are set in the Accept-Version header of API requests. Version numbers correspond with the date associated with that version. The example below uses the version v20250224.

-H 'Accept: application/json'
-H 'Accept-Version: v20250224'

For more information, please visit https://www.mx.com/products/platform-api

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 20250224
  • Package version: 2025.2.24+0
  • Generator version: 7.22.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named mx-openapi-rs and add the following to Cargo.toml under [dependencies]:

mx-openapi-rs = { path = "./mx-openapi-rs" }

Documentation for API Endpoints

All URIs are relative to https://int-api.mx.com

ClassMethodHTTP requestDescription
AccountsApicreate_manual_accountPOST /users/{user_identifier}/accountsCreate manual account
AccountsApidelete_manual_accountDELETE /users/{user_guid}/accounts/{account_guid}Delete manual account
AccountsApilist_account_numbers_by_accountGET /users/{user_identifier}/accounts/{account_identifier}/account_numbersList account numbers by account
AccountsApilist_account_numbers_by_memberGET /users/{user_guid}/members/{member_guid}/account_numbersList account numbers by member
AccountsApilist_account_owners_by_memberGET /users/{user_identifier}/members/{member_identifier}/account_ownersList account owners by member
AccountsApilist_member_accountsGET /users/{user_identifier}/members/{member_identifier}/accountsList member accounts
AccountsApilist_user_accountsGET /users/{user_identifier}/accountsList accounts
AccountsApimerge_accountsPOST /users/{user_guid}/accounts/mergeMerge accounts
AccountsApiread_accountGET /users/{user_guid}/accounts/{account_guid}Read account
AccountsApiread_account_by_memberGET /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}Read member account
AccountsApiupdate_account_by_memberPUT /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}Update account by member
AchReturnApicreate_ach_returnPOST /ach_returnsCreate ACH Return
AchReturnApilist_ach_retrunsGET /ach_returnsList ACH Returns
AchReturnApiread_ach_retrunGET /ach_returns/{ach_return_guid}Read ACH Return
BudgetsApiauto_generate_budgetsPOST /users/{user_guid}/budgets/generateAuto-generate budgets
BudgetsApicreate_budgetPOST /users/{user_guid}/budgetsCreate a budget
BudgetsApidelete_budgetDELETE /users/{user_guid}/budgets/{budget_guid}Delete a budget
BudgetsApilist_all_budgetsGET /users/{user_guid}/budgetsList all budgets
BudgetsApiread_specific_budgetGET /users/{user_guid}/budgets/{budget_guid}Read a specific budget
BudgetsApiupdate_specific_budgetPUT /users/{user_guid}/budgets/{budget_guid}Update a specific budget
CategoriesApicreate_categoryPOST /users/{user_guid}/categoriesCreate category
CategoriesApidelete_categoryDELETE /users/{user_guid}/categories/{category_guid}Delete category
CategoriesApilist_categoriesGET /users/{user_guid}/categoriesList categories
CategoriesApilist_default_categoriesGET /categories/defaultList default categories
CategoriesApilist_default_categories_by_userGET /users/{user_guid}/categories/defaultList default categories by user
CategoriesApiread_categoryGET /users/{user_guid}/categories/{category_guid}Read a custom category
CategoriesApiread_default_categoryGET /categories/{category_guid}Read a default category
CategoriesApiupdate_categoryPUT /users/{user_guid}/categories/{category_guid}Update category
GoalsApicreate_goalPOST /users/{user_guid}/goalsCreate a goal
GoalsApidelete_goalDELETE /users/{user_guid}/goals/{goal_guid}Delete a goal
GoalsApilist_goalsGET /users/{user_guid}/goalsList goals
GoalsApiread_goalGET /users/{user_guid}/goals/{goal_guid}Read a goal
GoalsApireposition_goalsPUT /users/{user_guid}/goals/repositionReposition goals
GoalsApiupdate_goalPUT /users/{user_guid}/goals/{goal_guid}Update a goal
InsightsApilist_accounts_insightGET /users/{user_guid}/insights/{insight_guid}/accountsList all accounts associated with an insight
InsightsApilist_categories_insightGET /users/{user_guid}/insights/{insight_guid}/categoriesList all categories associated with an insight
InsightsApilist_insights_by_accountGET /users/{user_guid}/accounts/{account_guid}/insightsList insights by account
InsightsApilist_insights_by_transactionGET /users/{user_guid}/transactions/{transaction_guid}/insightsList insights by transaction
InsightsApilist_insights_userGET /users/{user_guid}/insightsList all insights for a user
InsightsApilist_merchants_insightGET /users/{user_guid}/insights/{insight_guid}/merchantsList all merchants associated with an insight
InsightsApilist_scheduled_payments_insightGET /users/{user_guid}/insights/{insight_guid}/scheduled_paymentsList all scheduled payments associated with an insight
InsightsApilist_transactions_insightGET /users/{user_guid}/insights/{insight_guid}/transactionsList all transactions associated with an insight
InsightsApiread_insight_userGET /users/{user_guid}/insights/{insight_guid}Read insight
InsightsApiupdate_insightPUT /users/{user_guid}/insights/{insight_guid}Update insight
InstitutionsApilist_favorite_institutionsGET /institutions/favoritesList favorite institutions
InstitutionsApilist_institution_credentialsGET /institutions/{institution_identifier}/credentialsList institution credentials
InstitutionsApilist_institutionsGET /institutionsList institutions
InstitutionsApiread_institutionGET /institutions/{institution_code}Read institution
InvestmentHoldingsApideactivate_userGET /users/{user_guid}/investment_holdings_deactivateDeactivate user from Investment Holdings
InvestmentHoldingsApilist_holdingsGET /users/{user_guid}/investment_holdingsList holdings by user
InvestmentHoldingsApilist_holdings_by_accountGET /users/{user_guid}/accounts/{account_guid}/investment_holdingsList holdings by account
InvestmentHoldingsApilist_holdings_by_memberGET /users/{user_guid}/members/{member_guid}/investment_holdingsList holdings by member
InvestmentHoldingsApiread_holdingGET /users/{user_guid}/investment_holdings/{holding_guid}Read holding
ManagedDataDeprecatedApicreate_managed_accountPOST /users/{user_guid}/managed_members/{member_guid}/accountsCreate managed account
ManagedDataDeprecatedApicreate_managed_memberPOST /users/{user_guid}/managed_membersCreate managed member
ManagedDataDeprecatedApicreate_managed_transactionPOST /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactionsCreate managed transaction
ManagedDataDeprecatedApidelete_managed_accountDELETE /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}Delete managed account
ManagedDataDeprecatedApidelete_managed_memberDELETE /users/{user_guid}/managed_members/{member_guid}Delete managed member
ManagedDataDeprecatedApidelete_managed_transactionDELETE /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}Delete managed transaction
ManagedDataDeprecatedApilist_managed_accountsGET /users/{user_guid}/managed_members/{member_guid}/accountsList managed accounts
ManagedDataDeprecatedApilist_managed_institutionsGET /managed_institutionsList managed institutions
ManagedDataDeprecatedApilist_managed_membersGET /users/{user_guid}/managed_membersList managed members
ManagedDataDeprecatedApilist_managed_transactionsGET /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactionsList managed transactions
ManagedDataDeprecatedApiread_managed_accountGET /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}Read managed account
ManagedDataDeprecatedApiread_managed_memberGET /users/{user_guid}/managed_members/{member_guid}Read managed member
ManagedDataDeprecatedApiread_managed_transactionGET /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}Read managed transaction
ManagedDataDeprecatedApiupdate_managed_accountPUT /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}Update managed account
ManagedDataDeprecatedApiupdate_managed_memberPUT /users/{user_guid}/managed_members/{member_guid}Update managed member
ManagedDataDeprecatedApiupdate_managed_transactionPUT /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}Update managed transaction
MembersApiaggregate_memberPOST /users/{user_identifier}/members/{member_identifier}/aggregateAggregate member
MembersApicheck_balancesPOST /users/{user_identifier}/members/{member_identifier}/check_balanceCheck balances
MembersApicreate_memberPOST /users/{user_identifier}/membersCreate member
MembersApidelete_memberDELETE /users/{user_identifier}/members/{member_identifier}Delete member
MembersApiidentify_memberPOST /users/{user_identifier}/members/{member_identifier}/identifyIdentify member
MembersApilist_member_challengesGET /users/{user_identifier}/members/{member_identifier}/challengesList member challenges
MembersApilist_member_credentialsGET /users/{user_identifier}/members/{member_identifier}/credentialsList member credentials
MembersApilist_membersGET /users/{user_identifier}/membersList members
MembersApiread_memberGET /users/{user_identifier}/members/{member_identifier}Read member
MembersApiread_member_statusGET /users/{user_identifier}/members/{member_identifier}/statusRead member status
MembersApiresume_aggregationPUT /users/{user_identifier}/members/{member_identifier}/resumeResume aggregation
MembersApiupdate_memberPUT /users/{user_identifier}/members/{member_identifier}Update member
MembersApiverify_memberPOST /users/{user_identifier}/members/{member_identifier}/verifyVerify member
MerchantsApilist_merchantsGET /merchantsList merchants
MerchantsApiread_merchantGET /merchants/{merchant_guid}Read merchant
MerchantsApiread_merchant_locationGET /merchant_locations/{merchant_location_guid}Read merchant location
MicrodepositsApicreate_microdepositPOST /users/{user_guid}/micro_depositsCreate or pre-initiate a microdeposit
MicrodepositsApidelete_microdepositDELETE /users/{user_guid}/micro_deposits/{micro_deposit_guid}Delete a microdeposit
MicrodepositsApilist_user_microdepositsGET /users/{user_guid}/micro_depositsList all microdeposits for a user
MicrodepositsApilist_user_verificationsGET /users/{user_guid}/account_verificationsList all verifications for a user
MicrodepositsApiread_user_microdepositGET /users/{user_guid}/micro_deposits/{micro_deposit_guid}Read a microdeposit for a user
MicrodepositsApiverify_microdepositPUT /micro_deposits/{micro_deposit_guid}/verifyVerify a Microdeposit
MonthlyCashFlowProfileApiread_monthly_cash_flow_profileGET /users/{user_identifier}/monthly_cash_flow_profileRead monthly cash flow profile
MonthlyCashFlowProfileApiupdate_monthly_cash_flow_profilePUT /users/{user_identifier}/monthly_cash_flow_profileUpdate monthly cash flow profile
NotificationsApicreate_notificationPOST /users/{user_guid}/notificationsCreate a notification
NotificationsApilist_notificationsGET /users/{user_guid}/notificationsList notifications
NotificationsApiread_notificationsGET /users/{user_guid}/notifications/{notification_guid}Read notifications
ProcessorTokenApicheck_real_time_account_balancePOST /account/check_balanceCheck Real Time Account Balance (Processors Only)
ProcessorTokenApiget_account_owner_infoGET /account/transactionsGet account owner information (Processors Only)
ProcessorTokenApilist_tokensGET /tokensView a List of Tokens
ProcessorTokenApiread_account_balanceGET /payment_accountRead the account balance (Processors Only)
ProcessorTokenApirequest_account_numberGET /account/account_numbersRequest an account number (Processors Only)
ProcessorTokenApirequest_authorization_codePOST /authorization_codeRequest an authorization code
RewardsApicredit_cardGET /credit_card_products/{credit_card_product_guid}Read a Credit Card Product
RewardsApifetch_rewardsPOST /users/{user_identifier}/members/{member_identifier}/fetch_rewardsFetch Rewards
RewardsApilist_rewardsGET /users/{user_guid}/members/{member_guid}/rewardsList Rewards
RewardsApiread_rewardsGET /users/{user_guid}/members/{member_guid}/rewards/{reward_guid}Read Reward
SpendingPlanApicreate_spending_planPOST /users/{user_guid}/spending_plansCreate spending plan
SpendingPlanApicreate_spending_plan_iteration_itemPOST /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_itemsCreate spending plan iteration item
SpendingPlanApidelete_spending_planDELETE /users/{user_guid}/spending_plans/{spending_plan_guid}Delete spending plan
SpendingPlanApidelete_spending_plan_accountDELETE /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}Delete spending plan account
SpendingPlanApidelete_spending_plan_iteration_itemDELETE /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}Delete spending plan iteration item
SpendingPlanApilist_spending_plan_accountsGET /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accountsList spending plan accounts
SpendingPlanApilist_spending_plan_iteration_itemsGET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_itemsList spending plan iteration items
SpendingPlanApilist_spending_plan_iterationsGET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterationsList spending plan iterations
SpendingPlanApilist_spending_plansGET /users/{user_guid}/spending_plansList spending plans
SpendingPlanApiread_current_spending_plan_iterationGET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/currentRead current spending plan iteration
SpendingPlanApiread_spending_plan_accountGET /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}Read spending plan account
SpendingPlanApiread_spending_plan_iterationGET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number}Read a spending plan iteration
SpendingPlanApiread_spending_plan_iteration_itemGET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}Read a spending plan iteration item
SpendingPlanApiread_spending_plan_userGET /users/{user_guid}/spending_plans/{spending_plan_guid}Read a spending plan for a user
SpendingPlanApiupdate_spending_plan_iteration_itemPUT /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}Update a spending plan iteration item
StatementsApidownload_statement_pdfGET /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdfDownload statement pdf
StatementsApifetch_statementsPOST /users/{user_identifier}/members/{member_identifier}/fetch_statementsFetch statements
StatementsApilist_statements_by_memberGET /users/{user_guid}/members/{member_guid}/statementsList statements by member
StatementsApiread_statement_by_memberGET /users/{user_guid}/members/{member_guid}/statements/{statement_guid}Read statement by member
TaggingsApicreate_taggingPOST /users/{user_guid}/taggingsCreate tagging
TaggingsApidelete_taggingDELETE /users/{user_guid}/taggings/{tagging_guid}Delete tagging
TaggingsApilist_taggingsGET /users/{user_guid}/taggingsList taggings
TaggingsApiread_taggingGET /users/{user_guid}/taggings/{tagging_guid}Read tagging
TaggingsApiupdate_taggingPUT /users/{user_guid}/taggings/{tagging_guid}Update tagging
TagsApicreate_tagPOST /users/{user_guid}/tagsCreate tag
TagsApidelete_tagDELETE /users/{user_guid}/tags/{tag_guid}Delete tag
TagsApilist_tagsGET /users/{user_guid}/tagsList tags
TagsApiread_tagGET /users/{user_guid}/tags/{tag_guid}Read tag
TagsApiupdate_tagPUT /users/{user_guid}/tags/{tag_guid}Update tag
TransactionRulesApicreate_transaction_rulePOST /users/{user_guid}/transaction_rulesCreate transaction rule
TransactionRulesApilist_transaction_rulesGET /users/{user_guid}/transaction_rulesList transaction rules
TransactionRulesApiread_transaction_ruleGET /users/{user_guid}/transaction_rules/{transaction_rule_guid}Read transaction rule
TransactionRulesApiupdate_transaction_rulePUT /users/{user_guid}/transaction_rules/{transaction_rule_guid}Update transaction rule
TransactionsApicreate_manual_transactionPOST /users/{user_guid}/accounts/{account_guid}/transactionsCreate manual transaction
TransactionsApicreate_split_transactionsPOST /users/{user_guid}/transactions/{transaction_guid}/splitCreate split transactions
TransactionsApicreate_split_transactions_by_accountPOST /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}/splitCreate split transactions by account
TransactionsApidelete_manual_transactionsDELETE /users/{user_guid}/transactions/{transaction_guid}Delete manual transactions
TransactionsApidelete_split_transaction_by_accountDELETE /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}/splitDelete split transactions by account
TransactionsApidelete_split_transactionsDELETE /users/{user_guid}/transactions/{transaction_guid}/splitDelete split transactions
TransactionsApidelete_transaction_ruleDELETE /users/{user_guid}/transaction_rules/{transaction_rule_guid}Delete transaction rule
TransactionsApienhance_transactionsPOST /transactions/enhanceEnhance transactions
TransactionsApiextend_historyPOST /users/{user_identifier}/members/{member_identifier}/extend_historyExtend history
TransactionsApilist_transactionsGET /users/{user_identifier}/transactionsList transactions
TransactionsApilist_transactions_by_accountGET /users/{user_guid}/accounts/{account_guid}/transactionsList transactions by account
TransactionsApilist_transactions_by_account_per_memberGET /users/{user_guid}/members/{member_guid}/accounts/{account_guid}/transactionsList transactions by account per member
TransactionsApilist_transactions_by_memberGET /users/{user_identifier}/members/{member_identifier}/transactionsList transactions by member
TransactionsApilist_transactions_by_tagGET /users/{user_identifier}/tags/{tag_guid}/transactionsList transactions by tag
TransactionsApiread_transactionGET /users/{user_guid}/transactions/{transaction_guid}Read transaction
TransactionsApiread_transaction_by_accountGET /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}Read transaction by account
TransactionsApirepeating_transactionsGET /users/{user_guid}/repeating_transactionsList Repeating Transactions
TransactionsApispecific_repeating_transactionGET /users/{user_guid}/repeating_transactions/{repeating_transaction_guid}Get a Repeating Transaction
TransactionsApiupdate_transactionPUT /users/{user_guid}/transactions/{transaction_guid}Update transaction
TransactionsApiupdate_transaction_by_accountPUT /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}Update transaction
UsersApicreate_userPOST /usersCreate user
UsersApidelete_userDELETE /users/{user_identifier}Delete user
UsersApilist_usersGET /usersList users
UsersApiread_userGET /users/{user_identifier}Read user
UsersApiupdate_userPUT /users/{user_identifier}Update user
VerifiableCredentialsApiget_accounts_dataGET /vc/users/{user_guid}/members/{member_guid}/accountsGet Accounts Data
VerifiableCredentialsApiget_identity_dataGET /vc/users/{user_guid}/members/{member_guid}/customersGet Identity Data
VerifiableCredentialsApiget_transactions_dataGET /vc/users/{user_guid}/accounts/{account_guid}/transactionsGet Transactions Data
WidgetsApirequest_o_auth_window_uriGET /users/{user_identifier}/members/{member_identifier}/oauth_window_uriRequest oauth window uri
WidgetsApirequest_widget_urlPOST /users/{user_guid}/widget_urlsRequest widget URL

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages