ApimaticmxapisSDK 0.0.1

Getting Started with MX Platform API

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

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package ApimaticmxapisSDK --version 0.0.1

You can also view the package at: https://www.nuget.org/packages/ApimaticmxapisSDK/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:

Code-Based Initialization

using Microsoft.Extensions.Logging;
using MxPlatformApi.Standard;
using MxPlatformApi.Standard.Authentication;

namespace ConsoleApp;

MxPlatformApiClient client = new MxPlatformApiClient.Builder()
    .BasicAuthCredentials(
        new BasicAuthModel.Builder(
            "Username",
            "Password"
        )
        .Build())
    .BearerAuthCredentials(
        new BearerAuthModel.Builder(
            "AccessToken"
        )
        .Build())
    .HttpClientConfig(httpClientConfig =>
        httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
    .Environment(MxPlatformApi.Standard.Environment.Production)
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Configuration-Based Initialization

using MxPlatformApi.Standard;
using Microsoft.Extensions.Configuration;

namespace ConsoleApp;

// Build the IConfiguration using .NET conventions (JSON, environment, etc.)
var configuration = new ConfigurationBuilder()
    .AddJsonFile("config.json")
    .AddEnvironmentVariables() // [optional] read environment variables
    .Build();

// Instantiate your SDK and configure it from IConfiguration
var client = MxPlatformApiClient
    .FromConfiguration(configuration.GetSection("MxPlatformApi"));

See the Configuration-Based Initialization section for details.

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

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• LogBuilder
• LogRequestBuilder
• LogResponseBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiResponse
• ApiHelper