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:

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

Authorization

This API uses the following authentication schemes.

• OAuthFapi1Advanced (OAuth 2 Authorization Code Grant)
• OAuthFapi1Baseline (OAuth 2 Client Credentials Grant)
• TaxBasicAuth (Basic Authentication)

List of APIs

• Account Information
• Account Statements
• Account Transactions
• Money Movement
• Personal Information
• Reward Program Categories
• Reward Program Information
• Terms and Conditions
• User Consent
• Event Notifications
• Fraud Notification
• Internal Transfers
• Payee Management
• Payment Initiation Parties
• Recurring Payments
• Request for Payments
• Pay Stub Information
• Payroll Information
• Data Providers
• Submit Tax Forms
• Tax Forms
• Meta
• Payments
• Recipients

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime