README

Introduction

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'

Install the Package

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "sdksio/apimatic-mx-apis-sdk:0.0.1"

Or add it to the composer.json file manually as given below:

"require": {
    "sdksio/apimatic-mx-apis-sdk": "0.0.1"
}

You can also view the package at: https://packagist.org/packages/sdksio/apimatic-mx-apis-sdk#0.0.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

use MxPlatformApiLib\Logging\LoggingConfigurationBuilder;
use MxPlatformApiLib\Logging\RequestLoggingConfigurationBuilder;
use MxPlatformApiLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use MxPlatformApiLib\Environment;
use MxPlatformApiLib\Authentication\BasicAuthCredentialsBuilder;
use MxPlatformApiLib\Authentication\BearerAuthCredentialsBuilder;
use MxPlatformApiLib\MxPlatformApiClientBuilder;

$client = MxPlatformApiClientBuilder::init()
    ->basicAuthCredentials(
        BasicAuthCredentialsBuilder::init(
            'Username',
            'Password'
        )
    )
    ->bearerAuthCredentials(
        BearerAuthCredentialsBuilder::init(
            'AccessToken'
        )
    )
    ->environment(Environment::PRODUCTION)
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Authorization

This API uses the following authentication schemes.

• basicAuth (Basic Authentication)
• bearerAuth (OAuth 2 Bearer token)

List of APIs

• Achreturn
• Investmentholdings
• Monthlycashflowprofile
• Processortoken
• Spendingplan
• Transactionrules
• Verifiablecredentials
• Manageddata Deprecated
• Accounts
• Budgets
• Categories
• Goals
• Insights
• Institutions
• Members
• Merchants
• Microdeposits
• Notifications
• Rewards
• Statements
• Taggings
• Tags
• Transactions
• Users
• Widgets
• Jobs

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder
• LoggingConfigurationBuilder
• RequestLoggingConfigurationBuilder
• ResponseLoggingConfigurationBuilder

HTTP

• HttpRequest

Utilities

• ApiResponse