mt-sdk 0.0.1

MT SDKs APIMatic

Getting Started with Modern Treasury

Introduction

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

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install mt-sdk==0.0.1

You can also view the package at: https://pypi.python.org/pypi/mt-sdk/0.0.1

Test the SDK

You can test the generated SDK and the server with test cases. unittest is used as the testing framework and pytest is used as the test runner. You can run the tests as follows:

Navigate to the root directory of the SDK and run the following commands

pip install -r test-requirements.txt pytest

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
http_client_instance	Union[Session, HttpClientProvider]	The Http Client passed from the sdk user for making requests
override_http_client_configuration	bool	The value which determines to override properties of the passed Http Client from the sdk user
http_call_back	HttpCallBack	The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout	float	The value to use for connection timeout. Default: 60
max_retries	int	The number of times to retry an endpoint call if it fails. Default: 0
backoff_factor	float	A backoff factor to apply between attempts after the second try. Default: 2
retry_statuses	Array of int	The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array of string	The http methods on which retry is to be done. Default: ["GET", "PUT"]
proxy_settings	ProxySettings	Optional proxy configuration to route HTTP requests through a proxy server.
basic_auth_credentials	BasicAuthCredentials	The credential object for Basic Authentication

The API client can be initialized as follows:

Code-Based Client Initialization

from moderntreasury.configuration import Environment
from moderntreasury.http.auth.basic_auth import BasicAuthCredentials
from moderntreasury.moderntreasury_client import ModerntreasuryClient

client = ModerntreasuryClient(
    basic_auth_credentials=BasicAuthCredentials(
        username='BasicAuthUserName',
        password='BasicAuthPassword'
    ),
    environment=Environment.PRODUCTION
)

Environment-Based Client Initialization

from moderntreasury.moderntreasury_client import ModerntreasuryClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = ModerntreasuryClient.from_environment(dotenv_path='/path/to/.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 Detail
• Balance Report
• Connection
• Counterparty
• Document
• Event
• Expected Payment
• External Account
• Incoming Payment Detail
• Internal Account
• Invoice Line Item
• Invoice
• Ledger Account Category
• Ledger Account Payout
• Ledger Account Statement
• Ledger Account
• Ledger Entry
• Ledger Event Handler
• Ledger Transaction
• Ledgerable Event
• Ledger
• Line Item
• Paper Item
• Payment Order
• Payment Reference
• Ping
• Return
• Reversal
• Routing Detail
• Transaction Line Item
• Transaction
• Validation
• Virtual Account
• Account Collection Flow
• Payment Flow

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime