Getting Started with Modern Treasury

Introduction

The Modern Treasury REST API. Please see https://docs.moderntreasury.com for more details.

Install the Package

Run the following command from your project directory to install the package from npm:

npm install mt-sdk-apimatic

For additional package details, see the Npm page for the mt-sdk-apimatic npm.

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 | number | Timeout for API calls.Default: 60000 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | logging | PartialLoggingOptions | Logging Configuration to enable logging | | basicAuthCredentials | BasicAuthCredentials | The credential object for basicAuth |

The API client can be initialized as follows:

Code-Based Client Initialization

import { Client, Environment, LogLevel } from 'mt-sdk-apimatic';

const client = new Client({
  basicAuthCredentials: {
    username: 'BasicAuthUserName',
    password: 'BasicAuthPassword'
  },
  timeout: 60000,
  environment: Environment.Production,
  logging: {
    logLevel: LogLevel.Info,
    logRequest: {
      logBody: true
    },
    logResponse: {
      logHeaders: true
    }
  },
});

Configuration-Based Client Initialization

import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'mt-sdk-apimatic';

// Provide absolute path for the configuration file
const absolutePath = path.resolve('./config.json');

// Read the configuration file content
const fileContent = fs.readFileSync(absolutePath, 'utf-8');

// Initialize client from JSON configuration content
const client = Client.fromJsonConfig(fileContent);

See the Configuration-Based Client Initialization section for details.

Environment-Based Client Initialization

import * as dotenv from 'dotenv';
import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'mt-sdk-apimatic';

// Optional - Provide absolute path for the .env file
const absolutePath = path.resolve('./.env');

if (fs.existsSync(absolutePath)) {
  // Load environment variables from .env file
  dotenv.config({ path: absolutePath, override: true });
}

// Initialize client using environment variables
const client = Client.fromEnvironment(process.env);

See the Environment-Based Client Initialization section for details.

Environments

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

Fields

| Name | Description | | --- | --- | | Production | Default | | Environment2 | - |

Authorization

This API uses the following authentication schemes.

• basic_auth (Basic Authentication)

List of APIs

• Account Collection Flow
• Account Detail
• Balance Report
• Connection
• Counterparty
• Document
• Event
• Expected Payment
• External Account
• Incoming Payment Detail
• Internal Account
• Invoice
• Invoice Line Item
• Ledger
• Ledgerable Event
• Ledger Account
• Ledger Account Category
• Ledger Account Payout
• Ledger Account Statement
• Ledger Entry
• Ledger Event Handler
• Ledger Transaction
• Line Item
• Paper Item
• Payment Flow
• Payment Order
• Payment Reference
• Ping
• Return
• Reversal
• Routing Detail
• Transaction
• Transaction Line Item
• Validation
• Virtual Account

SDK Infrastructure

Configuration

• HttpClientOptions
• RetryConfiguration
• ProxySettings
• Configuration-Based Client Initialization
• Environment-Based Client Initialization
• PartialLoggingOptions
• PartialRequestLoggingOptions
• PartialResponseLoggingOptions
• LoggerInterface

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError