Skip to content

kodebooth/mx-openapi-rs

BranchesTags

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

Class Method HTTP request Description
AccountsApi create_manual_account POST /users/{user_identifier}/accounts Create manual account
AccountsApi delete_manual_account DELETE /users/{user_guid}/accounts/{account_guid} Delete manual account
AccountsApi list_account_numbers_by_account GET /users/{user_identifier}/accounts/{account_identifier}/account_numbers List account numbers by account
AccountsApi list_account_numbers_by_member GET /users/{user_guid}/members/{member_guid}/account_numbers List account numbers by member
AccountsApi list_account_owners_by_member GET /users/{user_identifier}/members/{member_identifier}/account_owners List account owners by member
AccountsApi list_member_accounts GET /users/{user_identifier}/members/{member_identifier}/accounts List member accounts
AccountsApi list_user_accounts GET /users/{user_identifier}/accounts List accounts
AccountsApi merge_accounts POST /users/{user_guid}/accounts/merge Merge accounts
AccountsApi read_account GET /users/{user_guid}/accounts/{account_guid} Read account
AccountsApi read_account_by_member GET /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier} Read member account
AccountsApi update_account_by_member PUT /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier} Update account by member
AchReturnApi create_ach_return POST /ach_returns Create ACH Return
AchReturnApi list_ach_retruns GET /ach_returns List ACH Returns
AchReturnApi read_ach_retrun GET /ach_returns/{ach_return_guid} Read ACH Return
BudgetsApi auto_generate_budgets POST /users/{user_guid}/budgets/generate Auto-generate budgets
BudgetsApi create_budget POST /users/{user_guid}/budgets Create a budget
BudgetsApi delete_budget DELETE /users/{user_guid}/budgets/{budget_guid} Delete a budget
BudgetsApi list_all_budgets GET /users/{user_guid}/budgets List all budgets
BudgetsApi read_specific_budget GET /users/{user_guid}/budgets/{budget_guid} Read a specific budget
BudgetsApi update_specific_budget PUT /users/{user_guid}/budgets/{budget_guid} Update a specific budget
CategoriesApi create_category POST /users/{user_guid}/categories Create category
CategoriesApi delete_category DELETE /users/{user_guid}/categories/{category_guid} Delete category
CategoriesApi list_categories GET /users/{user_guid}/categories List categories
CategoriesApi list_default_categories GET /categories/default List default categories
CategoriesApi list_default_categories_by_user GET /users/{user_guid}/categories/default List default categories by user
CategoriesApi read_category GET /users/{user_guid}/categories/{category_guid} Read a custom category
CategoriesApi read_default_category GET /categories/{category_guid} Read a default category
CategoriesApi update_category PUT /users/{user_guid}/categories/{category_guid} Update category
GoalsApi create_goal POST /users/{user_guid}/goals Create a goal
GoalsApi delete_goal DELETE /users/{user_guid}/goals/{goal_guid} Delete a goal
GoalsApi list_goals GET /users/{user_guid}/goals List goals
GoalsApi read_goal GET /users/{user_guid}/goals/{goal_guid} Read a goal
GoalsApi reposition_goals PUT /users/{user_guid}/goals/reposition Reposition goals
GoalsApi update_goal PUT /users/{user_guid}/goals/{goal_guid} Update a goal
InsightsApi list_accounts_insight GET /users/{user_guid}/insights/{insight_guid}/accounts List all accounts associated with an insight
InsightsApi list_categories_insight GET /users/{user_guid}/insights/{insight_guid}/categories List all categories associated with an insight
InsightsApi list_insights_by_account GET /users/{user_guid}/accounts/{account_guid}/insights List insights by account
InsightsApi list_insights_by_transaction GET /users/{user_guid}/transactions/{transaction_guid}/insights List insights by transaction
InsightsApi list_insights_user GET /users/{user_guid}/insights List all insights for a user
InsightsApi list_merchants_insight GET /users/{user_guid}/insights/{insight_guid}/merchants List all merchants associated with an insight
InsightsApi list_scheduled_payments_insight GET /users/{user_guid}/insights/{insight_guid}/scheduled_payments List all scheduled payments associated with an insight
InsightsApi list_transactions_insight GET /users/{user_guid}/insights/{insight_guid}/transactions List all transactions associated with an insight
InsightsApi read_insight_user GET /users/{user_guid}/insights/{insight_guid} Read insight
InsightsApi update_insight PUT /users/{user_guid}/insights/{insight_guid} Update insight
InstitutionsApi list_favorite_institutions GET /institutions/favorites List favorite institutions
InstitutionsApi list_institution_credentials GET /institutions/{institution_identifier}/credentials List institution credentials
InstitutionsApi list_institutions GET /institutions List institutions
InstitutionsApi read_institution GET /institutions/{institution_code} Read institution
InvestmentHoldingsApi deactivate_user GET /users/{user_guid}/investment_holdings_deactivate Deactivate user from Investment Holdings
InvestmentHoldingsApi list_holdings GET /users/{user_guid}/investment_holdings List holdings by user
InvestmentHoldingsApi list_holdings_by_account GET /users/{user_guid}/accounts/{account_guid}/investment_holdings List holdings by account
InvestmentHoldingsApi list_holdings_by_member GET /users/{user_guid}/members/{member_guid}/investment_holdings List holdings by member
InvestmentHoldingsApi read_holding GET /users/{user_guid}/investment_holdings/{holding_guid} Read holding
ManagedDataDeprecatedApi create_managed_account POST /users/{user_guid}/managed_members/{member_guid}/accounts Create managed account
ManagedDataDeprecatedApi create_managed_member POST /users/{user_guid}/managed_members Create managed member
ManagedDataDeprecatedApi create_managed_transaction POST /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions Create managed transaction
ManagedDataDeprecatedApi delete_managed_account DELETE /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} Delete managed account
ManagedDataDeprecatedApi delete_managed_member DELETE /users/{user_guid}/managed_members/{member_guid} Delete managed member
ManagedDataDeprecatedApi delete_managed_transaction DELETE /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid} Delete managed transaction
ManagedDataDeprecatedApi list_managed_accounts GET /users/{user_guid}/managed_members/{member_guid}/accounts List managed accounts
ManagedDataDeprecatedApi list_managed_institutions GET /managed_institutions List managed institutions
ManagedDataDeprecatedApi list_managed_members GET /users/{user_guid}/managed_members List managed members
ManagedDataDeprecatedApi list_managed_transactions GET /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions List managed transactions
ManagedDataDeprecatedApi read_managed_account GET /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} Read managed account
ManagedDataDeprecatedApi read_managed_member GET /users/{user_guid}/managed_members/{member_guid} Read managed member
ManagedDataDeprecatedApi read_managed_transaction GET /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid} Read managed transaction
ManagedDataDeprecatedApi update_managed_account PUT /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} Update managed account
ManagedDataDeprecatedApi update_managed_member PUT /users/{user_guid}/managed_members/{member_guid} Update managed member
ManagedDataDeprecatedApi update_managed_transaction PUT /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid} Update managed transaction
MembersApi aggregate_member POST /users/{user_identifier}/members/{member_identifier}/aggregate Aggregate member
MembersApi check_balances POST /users/{user_identifier}/members/{member_identifier}/check_balance Check balances
MembersApi create_member POST /users/{user_identifier}/members Create member
MembersApi delete_member DELETE /users/{user_identifier}/members/{member_identifier} Delete member
MembersApi identify_member POST /users/{user_identifier}/members/{member_identifier}/identify Identify member
MembersApi list_member_challenges GET /users/{user_identifier}/members/{member_identifier}/challenges List member challenges
MembersApi list_member_credentials GET /users/{user_identifier}/members/{member_identifier}/credentials List member credentials
MembersApi list_members GET /users/{user_identifier}/members List members
MembersApi read_member GET /users/{user_identifier}/members/{member_identifier} Read member
MembersApi read_member_status GET /users/{user_identifier}/members/{member_identifier}/status Read member status
MembersApi resume_aggregation PUT /users/{user_identifier}/members/{member_identifier}/resume Resume aggregation
MembersApi update_member PUT /users/{user_identifier}/members/{member_identifier} Update member
MembersApi verify_member POST /users/{user_identifier}/members/{member_identifier}/verify Verify member
MerchantsApi list_merchants GET /merchants List merchants
MerchantsApi read_merchant GET /merchants/{merchant_guid} Read merchant
MerchantsApi read_merchant_location GET /merchant_locations/{merchant_location_guid} Read merchant location
MicrodepositsApi create_microdeposit POST /users/{user_guid}/micro_deposits Create or pre-initiate a microdeposit
MicrodepositsApi delete_microdeposit DELETE /users/{user_guid}/micro_deposits/{micro_deposit_guid} Delete a microdeposit
MicrodepositsApi list_user_microdeposits GET /users/{user_guid}/micro_deposits List all microdeposits for a user
MicrodepositsApi list_user_verifications GET /users/{user_guid}/account_verifications List all verifications for a user
MicrodepositsApi read_user_microdeposit GET /users/{user_guid}/micro_deposits/{micro_deposit_guid} Read a microdeposit for a user
MicrodepositsApi verify_microdeposit PUT /micro_deposits/{micro_deposit_guid}/verify Verify a Microdeposit
MonthlyCashFlowProfileApi read_monthly_cash_flow_profile GET /users/{user_identifier}/monthly_cash_flow_profile Read monthly cash flow profile
MonthlyCashFlowProfileApi update_monthly_cash_flow_profile PUT /users/{user_identifier}/monthly_cash_flow_profile Update monthly cash flow profile
NotificationsApi create_notification POST /users/{user_guid}/notifications Create a notification
NotificationsApi list_notifications GET /users/{user_guid}/notifications List notifications
NotificationsApi read_notifications GET /users/{user_guid}/notifications/{notification_guid} Read notifications
ProcessorTokenApi check_real_time_account_balance POST /account/check_balance Check Real Time Account Balance (Processors Only)
ProcessorTokenApi get_account_owner_info GET /account/transactions Get account owner information (Processors Only)
ProcessorTokenApi list_tokens GET /tokens View a List of Tokens
ProcessorTokenApi read_account_balance GET /payment_account Read the account balance (Processors Only)
ProcessorTokenApi request_account_number GET /account/account_numbers Request an account number (Processors Only)
ProcessorTokenApi request_authorization_code POST /authorization_code Request an authorization code
RewardsApi credit_card GET /credit_card_products/{credit_card_product_guid} Read a Credit Card Product
RewardsApi fetch_rewards POST /users/{user_identifier}/members/{member_identifier}/fetch_rewards Fetch Rewards
RewardsApi list_rewards GET /users/{user_guid}/members/{member_guid}/rewards List Rewards
RewardsApi read_rewards GET /users/{user_guid}/members/{member_guid}/rewards/{reward_guid} Read Reward
SpendingPlanApi create_spending_plan POST /users/{user_guid}/spending_plans Create spending plan
SpendingPlanApi create_spending_plan_iteration_item POST /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items Create spending plan iteration item
SpendingPlanApi delete_spending_plan DELETE /users/{user_guid}/spending_plans/{spending_plan_guid} Delete spending plan
SpendingPlanApi delete_spending_plan_account DELETE /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid} Delete spending plan account
SpendingPlanApi delete_spending_plan_iteration_item DELETE /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid} Delete spending plan iteration item
SpendingPlanApi list_spending_plan_accounts GET /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts List spending plan accounts
SpendingPlanApi list_spending_plan_iteration_items GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items List spending plan iteration items
SpendingPlanApi list_spending_plan_iterations GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations List spending plan iterations
SpendingPlanApi list_spending_plans GET /users/{user_guid}/spending_plans List spending plans
SpendingPlanApi read_current_spending_plan_iteration GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current Read current spending plan iteration
SpendingPlanApi read_spending_plan_account GET /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid} Read spending plan account
SpendingPlanApi read_spending_plan_iteration GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number} Read a spending plan iteration
SpendingPlanApi read_spending_plan_iteration_item GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid} Read a spending plan iteration item
SpendingPlanApi read_spending_plan_user GET /users/{user_guid}/spending_plans/{spending_plan_guid} Read a spending plan for a user
SpendingPlanApi update_spending_plan_iteration_item PUT /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid} Update a spending plan iteration item
StatementsApi download_statement_pdf GET /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf Download statement pdf
StatementsApi fetch_statements POST /users/{user_identifier}/members/{member_identifier}/fetch_statements Fetch statements
StatementsApi list_statements_by_member GET /users/{user_guid}/members/{member_guid}/statements List statements by member
StatementsApi read_statement_by_member GET /users/{user_guid}/members/{member_guid}/statements/{statement_guid} Read statement by member
TaggingsApi create_tagging POST /users/{user_guid}/taggings Create tagging
TaggingsApi delete_tagging DELETE /users/{user_guid}/taggings/{tagging_guid} Delete tagging
TaggingsApi list_taggings GET /users/{user_guid}/taggings List taggings
TaggingsApi read_tagging GET /users/{user_guid}/taggings/{tagging_guid} Read tagging
TaggingsApi update_tagging PUT /users/{user_guid}/taggings/{tagging_guid} Update tagging
TagsApi create_tag POST /users/{user_guid}/tags Create tag
TagsApi delete_tag DELETE /users/{user_guid}/tags/{tag_guid} Delete tag
TagsApi list_tags GET /users/{user_guid}/tags List tags
TagsApi read_tag GET /users/{user_guid}/tags/{tag_guid} Read tag
TagsApi update_tag PUT /users/{user_guid}/tags/{tag_guid} Update tag
TransactionRulesApi create_transaction_rule POST /users/{user_guid}/transaction_rules Create transaction rule
TransactionRulesApi list_transaction_rules GET /users/{user_guid}/transaction_rules List transaction rules
TransactionRulesApi read_transaction_rule GET /users/{user_guid}/transaction_rules/{transaction_rule_guid} Read transaction rule
TransactionRulesApi update_transaction_rule PUT /users/{user_guid}/transaction_rules/{transaction_rule_guid} Update transaction rule
TransactionsApi create_manual_transaction POST /users/{user_guid}/accounts/{account_guid}/transactions Create manual transaction
TransactionsApi create_split_transactions POST /users/{user_guid}/transactions/{transaction_guid}/split Create split transactions
TransactionsApi create_split_transactions_by_account POST /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}/split Create split transactions by account
TransactionsApi delete_manual_transactions DELETE /users/{user_guid}/transactions/{transaction_guid} Delete manual transactions
TransactionsApi delete_split_transaction_by_account DELETE /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}/split Delete split transactions by account
TransactionsApi delete_split_transactions DELETE /users/{user_guid}/transactions/{transaction_guid}/split Delete split transactions
TransactionsApi delete_transaction_rule DELETE /users/{user_guid}/transaction_rules/{transaction_rule_guid} Delete transaction rule
TransactionsApi enhance_transactions POST /transactions/enhance Enhance transactions
TransactionsApi extend_history POST /users/{user_identifier}/members/{member_identifier}/extend_history Extend history
TransactionsApi list_transactions GET /users/{user_identifier}/transactions List transactions
TransactionsApi list_transactions_by_account GET /users/{user_guid}/accounts/{account_guid}/transactions List transactions by account
TransactionsApi list_transactions_by_account_per_member GET /users/{user_guid}/members/{member_guid}/accounts/{account_guid}/transactions List transactions by account per member
TransactionsApi list_transactions_by_member GET /users/{user_identifier}/members/{member_identifier}/transactions List transactions by member
TransactionsApi list_transactions_by_tag GET /users/{user_identifier}/tags/{tag_guid}/transactions List transactions by tag
TransactionsApi read_transaction GET /users/{user_guid}/transactions/{transaction_guid} Read transaction
TransactionsApi read_transaction_by_account GET /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier} Read transaction by account
TransactionsApi repeating_transactions GET /users/{user_guid}/repeating_transactions List Repeating Transactions
TransactionsApi specific_repeating_transaction GET /users/{user_guid}/repeating_transactions/{repeating_transaction_guid} Get a Repeating Transaction
TransactionsApi update_transaction PUT /users/{user_guid}/transactions/{transaction_guid} Update transaction
TransactionsApi update_transaction_by_account PUT /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier} Update transaction
UsersApi create_user POST /users Create user
UsersApi delete_user DELETE /users/{user_identifier} Delete user
UsersApi list_users GET /users List users
UsersApi read_user GET /users/{user_identifier} Read user
UsersApi update_user PUT /users/{user_identifier} Update user
VerifiableCredentialsApi get_accounts_data GET /vc/users/{user_guid}/members/{member_guid}/accounts Get Accounts Data
VerifiableCredentialsApi get_identity_data GET /vc/users/{user_guid}/members/{member_guid}/customers Get Identity Data
VerifiableCredentialsApi get_transactions_data GET /vc/users/{user_guid}/accounts/{account_guid}/transactions Get Transactions Data
WidgetsApi request_o_auth_window_uri GET /users/{user_identifier}/members/{member_identifier}/oauth_window_uri Request oauth window uri
WidgetsApi request_widget_url POST /users/{user_guid}/widget_urls Request 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

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages