Getting Started with FDX API

Introduction

Financial Data Exchange V6.2.0 Consent API

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-api-sdk-python==1.0.0

You can also view the package at: https://pypi.python.org/pypi/fdx-api-sdk-python/1.0.0

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	HttpClient	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
bearer_auth_credentials	BearerAuthCredentials	The credential object for OAuth 2 Bearer token
tax_basic_auth_credentials	TaxBasicAuthCredentials	The credential object for Basic Authentication

The API client can be initialized as follows:

import logging

from fdxapi.configuration import Environment
from fdxapi.fdxapi_client import FdxapiClient
from fdxapi.http.auth.bearer_auth import BearerAuthCredentials
from fdxapi.http.auth.tax_basic_auth import TaxBasicAuthCredentials
from fdxapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from fdxapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from fdxapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration

client = FdxapiClient(
    bearer_auth_credentials=BearerAuthCredentials(
        access_token='AccessToken'
    ),
    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
        )
    )
)

Authorization

This API uses the following authentication schemes.

• bearerAuth (OAuth 2 Bearer token)
• TaxBasicAuth (Basic Authentication)

List of APIs

• User Consent
• Account Information
• Account Statements
• Account Transactions
• Money Movement
• Personal Information
• Reward Program Categories
• Reward Program Information
• Event Notifications
• Fraud Notification
• Internal Transfers
• Payee Management
• Payment Initiation Parties
• Recurring Payments
• Payroll Information
• Submit Tax Forms
• Tax Forms
• Resource Information
• Meta
• Payments
• Recipients

SDK Infrastructure

Configuration

• ProxySettings
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime