Getting Started with FDX API

Introduction

Financial Data Exchange V6.2.0 Consent API

Install the Package

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

npm install [email protected]

For additional package details, see the Npm page for the [email protected] 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: 0 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | logging | PartialLoggingOptions | Logging Configuration to enable logging | | bearerAuthCredentials | BearerAuthCredentials | The credential object for bearerAuth | | taxBasicAuthCredentials | TaxBasicAuthCredentials | The credential object for taxBasicAuth |

The API client can be initialized as follows:

import { Client, Environment, LogLevel } from 'fdx-api-sdk-ts';

const client = new Client({
  bearerAuthCredentials: {
    accessToken: 'AccessToken'
  },
  taxBasicAuthCredentials: {
    username: 'Username',
    password: 'Password'
  },
  timeout: 0,
  environment: Environment.Production,
  logging: {
    logLevel: LogLevel.Info,
    logRequest: {
      logBody: true
    },
    logResponse: {
      logHeaders: 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

• HttpClientOptions
• RetryConfiguration
• ProxySettings
• PartialLoggingOptions
• PartialRequestLoggingOptions
• PartialResponseLoggingOptions
• LoggerInterface

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError