README

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.

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

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure HTTP basic authorization: basicAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenAPI\Client\Api\BudgetsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$user_guid = 'user_guid_example'; // string | The unique identifier for the budget. Defined by MX.
$budget_guid = 'budget_guid_example'; // string | The unique identifier for the budget. Defined by MX.

try {
    $apiInstance->usersUserGuidBudgetsBudgetGuidDelete($user_guid, $budget_guid);
} catch (Exception $e) {
    echo 'Exception when calling BudgetsApi->usersUserGuidBudgetsBudgetGuidDelete: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

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

Class	Method	HTTP request	Description
BudgetsApi	usersUserGuidBudgetsBudgetGuidDelete	DELETE /users/{user_guid}/budgets/{budget_guid}	Delete a budget
BudgetsApi	usersUserGuidBudgetsBudgetGuidGet	GET /users/{user_guid}/budgets/{budget_guid}	Read a specific budget
BudgetsApi	usersUserGuidBudgetsBudgetGuidPut	PUT /users/{user_guid}/budgets/{budget_guid}	Update a specific budget
BudgetsApi	usersUserGuidBudgetsGeneratePost	POST /users/{user_guid}/budgets/generate	Auto-generate budgets
BudgetsApi	usersUserGuidBudgetsGet	GET /users/{user_guid}/budgets	List all budgets
BudgetsApi	usersUserGuidBudgetsPost	POST /users/{user_guid}/budgets	Create a budget
GoalsApi	usersUserGuidGoalsGet	GET /users/{user_guid}/goals	List goals
GoalsApi	usersUserGuidGoalsGoalGuidDelete	DELETE /users/{user_guid}/goals/{goal_guid}	Delete a goal
GoalsApi	usersUserGuidGoalsGoalGuidGet	GET /users/{user_guid}/goals/{goal_guid}	Read a goal
GoalsApi	usersUserGuidGoalsGoalGuidPut	PUT /users/{user_guid}/goals/{goal_guid}	Update a goal
GoalsApi	usersUserGuidGoalsPost	POST /users/{user_guid}/goals	Create a goal
GoalsApi	usersUserGuidGoalsRepositionPut	PUT /users/{user_guid}/goals/reposition	Reposition goals
InsightsApi	listAccountsInsight	GET /users/{user_guid}/insights/{insight_guid}/accounts	List all accounts associated with an insight.
InsightsApi	listCategoriesInsight	GET /users/{user_guid}/insights/{insight_guid}/categories	List all categories associated with an insight.
InsightsApi	listInsightsByAccount	GET /users/{user_guid}/accounts/{account_guid}/insights	List insights by account
InsightsApi	listInsightsUser	GET /users/{user_guid}/insights	List all insights for a user.
InsightsApi	listMerchantsInsight	GET /users/{user_guid}/insights/{insight_guid}/merchants	List all merchants associated with an insight.
InsightsApi	listScheduledPaymentsInsight	GET /users/{user_guid}/insights/{insight_guid}/scheduled_payments	List all scheduled payments associated with an insight
InsightsApi	listTransactionsInsight	GET /users/{user_guid}/insights/{insight_guid}/transactions	List all transactions associated with an insight.
InsightsApi	readInsightsUser	GET /users/{user_guid}/insights{insight_guid}	Read a specific insight.
InsightsApi	updateInsight	PUT /users/{user_guid}/insights{insight_guid}	Update insight
MicrodepositsApi	microDepositsMicrodepositGuidVerifyPut	PUT /micro_deposits/{microdeposit_guid}/verify	Verify a Microdeposit
MicrodepositsApi	usersUserGuidMicroDepositsGet	GET /users/{user_guid}/micro_deposits	List all microdeposits for a user
MicrodepositsApi	usersUserGuidMicroDepositsMicroDepositGuidDelete	DELETE /users/{user_guid}/micro_deposits/{micro_deposit_guid}	Delete a microdeposit
MicrodepositsApi	usersUserGuidMicroDepositsMicroDepositGuidGet	GET /users/{user_guid}/micro_deposits/{micro_deposit_guid}	Read a microdeposit for a user
MicrodepositsApi	usersUserGuidMicroDepositsPost	POST /users/{user_guid}/micro_deposits	Create a microdeposit
MxPlatformApi	aggregateMember	POST /users/{user_guid}/members/{member_guid}/aggregate	Aggregate member
MxPlatformApi	checkBalances	POST /users/{user_guid}/members/{member_guid}/check_balance	Check balances
MxPlatformApi	createCategory	POST /users/{user_guid}/categories	Create category
MxPlatformApi	createManagedAccount	POST /users/{user_guid}/managed_members/{member_guid}/accounts	Create managed account
MxPlatformApi	createManagedMember	POST /users/{user_guid}/managed_members	Create managed member
MxPlatformApi	createManagedTransaction	POST /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions	Create managed transaction
MxPlatformApi	createManualAccount	POST /users/{user_guid}/accounts	Create manual account
MxPlatformApi	createMember	POST /users/{user_guid}/members	Create member
MxPlatformApi	createTag	POST /users/{user_guid}/tags	Create tag
MxPlatformApi	createTagging	POST /users/{user_guid}/taggings	Create tagging
MxPlatformApi	createTransactionRule	POST /users/{user_guid}/transaction_rules	Create transaction rule
MxPlatformApi	createUser	POST /users	Create user
MxPlatformApi	creditCard	GET /credit_card_products/{credit_card_product_guid}	Read a Credit Card Product
MxPlatformApi	deleteCategory	DELETE /users/{user_guid}/categories/{category_guid}	Delete category
MxPlatformApi	deleteManagedAccount	DELETE /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}	Delete managed account
MxPlatformApi	deleteManagedMember	DELETE /users/{user_guid}/managed_members/{member_guid}	Delete managed member
MxPlatformApi	deleteManagedTransaction	DELETE /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}	Delete managed transaction
MxPlatformApi	deleteManualAccount	DELETE /users/{user_guid}/accounts/{account_guid}	Delete manual account
MxPlatformApi	deleteMember	DELETE /users/{user_guid}/members/{member_guid}	Delete member
MxPlatformApi	deleteTag	DELETE /users/{user_guid}/tags/{tag_guid}	Delete tag
MxPlatformApi	deleteTagging	DELETE /users/{user_guid}/taggings/{tagging_guid}	Delete tagging
MxPlatformApi	deleteTransactionRule	DELETE /users/{user_guid}/transaction_rules/{transaction_rule_guid}	Delete transaction rule
MxPlatformApi	deleteUser	DELETE /users/{user_guid}	Delete user
MxPlatformApi	deprecatedRequestPaymentProcessorAuthorizationCode	POST /payment_processor_authorization_code	(Deprecated) Request an authorization code.
MxPlatformApi	downloadStatementPDF	GET /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf	Download statement pdf
MxPlatformApi	downloadTaxDocument	GET /users/{user_guid}/members/{member_guid}/tax_documents/{tax_document_guid}.pdf	Download a Tax Document PDF
MxPlatformApi	enhanceTransactions	POST /transactions/enhance	Enhance transactions
MxPlatformApi	extendHistory	POST /users/{user_guid}/members/{member_guid}/extend_history	Extend history
MxPlatformApi	fetchRewards	POST /users/{user_guid}/members/{member_guid}/fetch_rewards	Fetch Rewards
MxPlatformApi	fetchStatements	POST /users/{user_guid}/members/{member_guid}/fetch_statements	Fetch statements
MxPlatformApi	fetchTaxDocuments	POST /users/{user_guid}/members/{member_guid}/fetch_tax_documents	Fetch Tax Documents
MxPlatformApi	identifyMember	POST /users/{user_guid}/members/{member_guid}/identify	Identify member
MxPlatformApi	listAccountNumbersByAccount	GET /users/{user_guid}/accounts/{account_guid}/account_numbers	List account numbers by account
MxPlatformApi	listAccountNumbersByMember	GET /users/{user_guid}/members/{member_guid}/account_numbers	List account numbers by member
MxPlatformApi	listAccountOwnersByMember	GET /users/{user_guid}/members/{member_guid}/account_owners	List account owners by member
MxPlatformApi	listCategories	GET /users/{user_guid}/categories	List categories
MxPlatformApi	listDefaultCategories	GET /categories/default	List default categories
MxPlatformApi	listDefaultCategoriesByUser	GET /users/{user_guid}/categories/default	List default categories by user
MxPlatformApi	listFavoriteInstitutions	GET /institutions/favorites	List favorite institutions
MxPlatformApi	listHoldings	GET /users/{user_guid}/holdings	List holdings
MxPlatformApi	listHoldingsByAccount	GET /users/{user_guid}/accounts/{account_guid}/holdings	List holdings by account
MxPlatformApi	listHoldingsByMember	GET /users/{user_guid}/members/{member_guid}/holdings	List holdings by member
MxPlatformApi	listInstitutionCredentials	GET /institutions/{institution_code}/credentials	List institution credentials
MxPlatformApi	listInstitutions	GET /institutions	List institutions
MxPlatformApi	listManagedAccounts	GET /users/{user_guid}/managed_members/{member_guid}/accounts	List managed accounts
MxPlatformApi	listManagedInstitutions	GET /managed_institutions	List managed institutions
MxPlatformApi	listManagedMembers	GET /users/{user_guid}/managed_members	List managed members
MxPlatformApi	listManagedTransactions	GET /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions	List managed transactions
MxPlatformApi	listMemberAccounts	GET /users/{user_guid}/members/{member_guid}/accounts	List accounts by member
MxPlatformApi	listMemberChallenges	GET /users/{user_guid}/members/{member_guid}/challenges	List member challenges
MxPlatformApi	listMemberCredentials	GET /users/{user_guid}/members/{member_guid}/credentials	List member credentials
MxPlatformApi	listMembers	GET /users/{user_guid}/members	List members
MxPlatformApi	listMerchants	GET /merchants	List merchants
MxPlatformApi	listRewards	GET /users/{user_guid}/members/{member_guid}/rewards	List Rewards
MxPlatformApi	listStatementsByMember	GET /users/{user_guid}/members/{member_guid}/statements	List statements by member
MxPlatformApi	listTaggings	GET /users/{user_guid}/taggings	List taggings
MxPlatformApi	listTags	GET /users/{user_guid}/tags	List tags
MxPlatformApi	listTaxDocuments	GET /users/{user_guid}/members/{member_guid}/tax_documents	List Tax Documents
MxPlatformApi	listTransactionRules	GET /users/{user_guid}/transaction_rules	List transaction rules
MxPlatformApi	listTransactions	GET /users/{user_guid}/transactions	List transactions
MxPlatformApi	listTransactionsByAccount	GET /users/{user_guid}/accounts/{account_guid}/transactions	List transactions by account
MxPlatformApi	listTransactionsByMember	GET /users/{user_guid}/members/{member_guid}/transactions	List transactions by member
MxPlatformApi	listTransactionsByTag	GET /users/{user_guid}/tags/{tag_guid}/transactions	List transactions by tag
MxPlatformApi	listUserAccounts	GET /users/{user_guid}/accounts	List accounts
MxPlatformApi	listUsers	GET /users	List users
MxPlatformApi	readAccount	GET /users/{user_guid}/accounts/{account_guid}	Read account
MxPlatformApi	readAccountByMember	GET /users/{user_guid}/members/{member_guid}/accounts/{account_guid}	Read account by member
MxPlatformApi	readCategory	GET /users/{user_guid}/categories/{category_guid}	Read a custom category
MxPlatformApi	readDefaultCategory	GET /categories/{category_guid}	Read a default category
MxPlatformApi	readHolding	GET /users/{user_guid}/holdings/{holding_guid}	Read holding
MxPlatformApi	readInstitution	GET /institutions/{institution_code}	Read institution
MxPlatformApi	readManagedAccount	GET /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}	Read managed account
MxPlatformApi	readManagedMember	GET /users/{user_guid}/managed_members/{member_guid}	Read managed member
MxPlatformApi	readManagedTransaction	GET /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}	Read managed transaction
MxPlatformApi	readMember	GET /users/{user_guid}/members/{member_guid}	Read member
MxPlatformApi	readMemberStatus	GET /users/{user_guid}/members/{member_guid}/status	Read member status
MxPlatformApi	readMerchant	GET /merchants/{merchant_guid}	Read merchant
MxPlatformApi	readMerchantLocation	GET /merchant_locations/{merchant_location_guid}	Read merchant location
MxPlatformApi	readRewards	GET /users/{user_guid}/members/{member_guid}/rewards/{reward_guid}	Read Reward
MxPlatformApi	readStatementByMember	GET /users/{user_guid}/members/{member_guid}/statements/{statement_guid}	Read statement by member
MxPlatformApi	readTag	GET /users/{user_guid}/tags/{tag_guid}	Read tag
MxPlatformApi	readTagging	GET /users/{user_guid}/taggings/{tagging_guid}	Read tagging
MxPlatformApi	readTaxDocument	GET /users/{user_guid}/members/{member_guid}/tax_documents/{tax_document_guid}	Read a Tax Document
MxPlatformApi	readTransaction	GET /users/{user_guid}/transactions/{transaction_guid}	Read transaction
MxPlatformApi	readTransactionRule	GET /users/{user_guid}/transaction_rules/{transaction_rule_guid}	Read transaction rule
MxPlatformApi	readUser	GET /users/{user_guid}	Read user
MxPlatformApi	requestAuthorizationCode	POST /authorization_code	Request an authorization code.
MxPlatformApi	requestConnectWidgetURL	POST /users/{user_guid}/connect_widget_url	Request connect widget url
MxPlatformApi	requestOAuthWindowURI	GET /users/{user_guid}/members/{member_guid}/oauth_window_uri	Request oauth window uri
MxPlatformApi	requestWidgetURL	POST /users/{user_guid}/widget_urls	Request widget url
MxPlatformApi	resumeAggregation	PUT /users/{user_guid}/members/{member_guid}/resume	Resume aggregation
MxPlatformApi	updateAccountByMember	PUT /users/{user_guid}/members/{member_guid}/accounts/{account_guid}	Update account by member
MxPlatformApi	updateCategory	PUT /users/{user_guid}/categories/{category_guid}	Update category
MxPlatformApi	updateManagedAccount	PUT /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}	Update managed account
MxPlatformApi	updateManagedMember	PUT /users/{user_guid}/managed_members/{member_guid}	Update managed member
MxPlatformApi	updateManagedTransaction	PUT /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}	Update managed transaction
MxPlatformApi	updateMember	PUT /users/{user_guid}/members/{member_guid}	Update member
MxPlatformApi	updateTag	PUT /users/{user_guid}/tags/{tag_guid}	Update tag
MxPlatformApi	updateTagging	PUT /users/{user_guid}/taggings/{tagging_guid}	Update tagging
MxPlatformApi	updateTransaction	PUT /users/{user_guid}/transactions/{transaction_guid}	Update transaction
MxPlatformApi	updateTransactionRule	PUT /users/{user_guid}/transaction_rules/{transaction_rule_guid}	Update transaction_rule
MxPlatformApi	updateUser	PUT /users/{user_guid}	Update user
MxPlatformApi	usersUserGuidMonthlyCashFlowProfileGet	GET /users/{user_guid}/monthly_cash_flow_profile	Read monthly cash flow profile
MxPlatformApi	usersUserGuidMonthlyCashFlowProfilePut	PUT /users/{user_guid}/monthly_cash_flow_profile	Update monthly cash flow profile
MxPlatformApi	usersUserGuidTransactionsTransactionGuidSplitDelete	DELETE /users/{user_guid}/transactions/{transaction_guid}/split	Delete split transactions
MxPlatformApi	usersUserGuidTransactionsTransactionGuidSplitPost	POST /users/{user_guid}/transactions/{transaction_guid}/split	Create split transactions
MxPlatformApi	verifyMember	POST /users/{user_guid}/members/{member_guid}/verify	Verify member
SpendingPlanApi	createSpendingPlan	POST /users/{user_guid}/spending_plans	Create spending plan
SpendingPlanApi	createSpendingPlanIterationItem	POST /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items	Create spending plan iteration item
SpendingPlanApi	deleteSpendingPlan	DELETE /users/{user_guid}/spending_plans/{spending_plan_guid}	Delete spending plan
SpendingPlanApi	deleteSpendingPlanAccount	DELETE /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}	Delete spending plan account
SpendingPlanApi	deleteSpendingPlanIterationItem	DELETE /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}	Delete spending plan iteration item
SpendingPlanApi	listSpendingPlanAccounts	GET /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts	List spending plan accounts
SpendingPlanApi	listSpendingPlanIterationItems	GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items	List spending plan iteration items
SpendingPlanApi	listSpendingPlanIterations	GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations	List spending plan iterations
SpendingPlanApi	listSpendingPlans	GET /users/{user_guid}/spending_plans	List spending plans
SpendingPlanApi	readSpendingPlanAccount	GET /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}	Read spending plan account
SpendingPlanApi	readSpendingPlanIteration	GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number}	Read a spending plan iteration
SpendingPlanApi	readSpendingPlanIterationItem	GET /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}	Read a spending plan iteration item
SpendingPlanApi	readSpendingPlanUser	GET /users/{user_guid}/spending_plans/{spending_plan_guid}	Read a spending plan for a user
SpendingPlanApi	updateSpendingPlanIterationItem	PUT /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}	Update a spending plan iteration item
TransactionsApi	usersUserGuidAccountsAccountGuidTransactionsPost	POST /users/{user_guid}/accounts/{account_guid}/transactions	Create manual transaction

Models

Authorization

Authentication schemes defined for the API:

basicAuth

Type: HTTP basic authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 0.1.0
- Generator version: 7.13.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

rewards-wise / mx-sdk-php

Maintainers

Details