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:

Parameter	Type	Description
environment	`Environment`	The API environment. Default: `Environment.PRODUCTION`
timeout	`int`	Timeout for API calls in seconds. Default: `30`
enableRetries	`bool`	Whether to enable retries and backoff feature. Default: `false`
numberOfRetries	`int`	The number of retries to make. Default: `0`
retryInterval	`float`	The retry time interval between the endpoint calls. Default: `1`
backOffFactor	`float`	Exponential backoff factor to increase interval between retries. Default: `2`
maximumRetryWaitTime	`int`	The maximum wait time in seconds for overall retrying requests. Default: `0`
retryOnTimeout	`bool`	Whether to retry on request timeout. Default: `true`
httpStatusCodesToRetry	`array`	Http status codes to retry against. Default: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524`
httpMethodsToRetry	`array`	Http methods to retry against. Default: `'GET', 'PUT'`
loggingConfiguration	`LoggingConfigurationBuilder`	Represents the logging configurations for API calls
proxyConfiguration	`ProxyConfigurationBuilder`	Represents the proxy configurations for API calls
basicAuthCredentials	`BasicAuthCredentials`	The Credentials Setter for Basic Authentication
bearerAuthCredentials	`BearerAuthCredentials`	The Credentials Setter for OAuth 2 Bearer token

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

Name	Description
PRODUCTION	Default
ENVIRONMENT2	-

sdksio / apimatic-mx-apis-sdk

Maintainers

Package info

Statistics

Security

README

Introduction

What's Changed?

Version Header

Install the Package

Initialize the API Client

Environments

Fields

Authorization

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities