Skip to main content

Getting Started with FDX V6.6.0 API

Introduction

Financial Data Exchange V6.6.0 API (Core, Consent, Customer, Event Notifications, Fraud, Meta, Money Movement, Payroll, Recipient Registration, Registry, Tax)

Install the Package

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

pip install fdx-apimatic-sdk==0.0.1

You can also view the package at: https://pypi.python.org/pypi/fdx-apimatic-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
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.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
oauth_fapi_1_advanced_credentials OauthFapi1AdvancedCredentials The credential object for OAuth 2 Authorization Code Grant
oauth_fapi_1_baseline_credentials OauthFapi1BaselineCredentials The credential object for OAuth 2 Client Credentials Grant
tax_basic_auth_credentials TaxBasicAuthCredentials The credential object for Basic Authentication

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from fdxv660api.configuration import Environment
from fdxv660api.fdxv_660_api_client import Fdxv660ApiClient
from fdxv660api.http.auth.oauth_fapi_1_advanced import OauthFapi1AdvancedCredentials
from fdxv660api.http.auth.oauth_fapi_1_baseline import OauthFapi1BaselineCredentials
from fdxv660api.http.auth.tax_basic_auth import TaxBasicAuthCredentials
from fdxv660api.logging.configuration.api_logging_configuration import LoggingConfiguration
from fdxv660api.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from fdxv660api.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from fdxv660api.models.oauth_scope_oauth_fapi_1_advanced import OauthScopeOauthFapi1Advanced
from fdxv660api.models.oauth_scope_oauth_fapi_1_baseline import OauthScopeOauthFapi1Baseline

client = Fdxv660ApiClient(
    oauth_fapi_1_advanced_credentials=OauthFapi1AdvancedCredentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret',
        oauth_redirect_uri='OAuthRedirectUri',
        oauth_scopes=[
            OauthScopeOauthFapi1Advanced.FDXACCOUNTBASICREAD,
            OauthScopeOauthFapi1Advanced.FDXACCOUNTDETAILEDREAD
        ]
    ),
    oauth_fapi_1_baseline_credentials=OauthFapi1BaselineCredentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret',
        oauth_scopes=[
            OauthScopeOauthFapi1Baseline.FDXNOTIFICATIONSPUBLISH,
            OauthScopeOauthFapi1Baseline.FDXNOTIFICATIONSSUBSCRIBE
        ]
    ),
    tax_basic_auth_credentials=TaxBasicAuthCredentials(
        username='Username',
        password='Password'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from fdxv660api.fdxv_660_api_client import Fdxv660ApiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = Fdxv660ApiClient.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 Financial Data Exchange V6 API (Data Provider / FI host)
ENVIRONMENT2 FDX Registry host

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for fdx-apimatic-sdk 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fdx-apimatic-sdk 0.0.1
File Size Uploaded Provenance Actions
fdx_apimatic_sdk-0.0.1.tar.gz 636.4 kB Without provenance Details for fdx_apimatic_sdk-0.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for fdx-apimatic-sdk 0.0.1
File Interpreter ABI Platform Actions
fdx_apimatic_sdk-0.0.1-py3-none-any.whl Python 3 none any Details for fdx_apimatic_sdk-0.0.1-py3-none-any.whl

Total release size: 2.4 MB

Release files / fdx_apimatic_sdk-0.0.1.tar.gz

Download URL fdx_apimatic_sdk-0.0.1.tar.gz
Size 636.4 kB
Tags Source
SHA-256 checksum
How to use checksums
b4637c88ecfc34b36f4b777d0576e5ced7698b1ddcd29b1a8d8e194090bdf17d
BLAKE2b-256 checksum
How to use checksums
c4e10a01a613f5add482fded4b5e2b086d78cf46b1aa3408ec6496a9d7df8b69
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / fdx_apimatic_sdk-0.0.1-py3-none-any.whl

Download URL fdx_apimatic_sdk-0.0.1-py3-none-any.whl
Size 1.8 MB
Tags Python 3
SHA-256 checksum
How to use checksums
29e0e3515504dc710d43231ad598e09b692a78f29f17a1e2a27c1f6489a207d7
BLAKE2b-256 checksum
How to use checksums
31e39f9c7c2129a830f232de10a0941281254c25ff25dfb44cfddf752e9cb02d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for fdx-apimatic-sdk 0.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page