FdxApimaticSDK 0.0.1

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

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package FdxApimaticSDK --version 0.0.1

You can also view the package at: https://www.nuget.org/packages/FdxApimaticSDK/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 Initialization

using FdxV660Api.Standard;
using FdxV660Api.Standard.Authentication;
using FdxV660Api.Standard.Models;
using Microsoft.Extensions.Logging;
using System.Collections.Generic;

namespace ConsoleApp;

FdxV660ApiClient client = new FdxV660ApiClient.Builder()
    .OauthFapi1AdvancedCredentials(
        new OauthFapi1AdvancedModel.Builder(
            "OAuthClientId",
            "OAuthClientSecret",
            "OAuthRedirectUri"
        )
        .OauthScopes(
            new List<OauthScopeOauthFapi1Advanced>
            {
                OauthScopeOauthFapi1Advanced.Fdxaccountbasicread,
                OauthScopeOauthFapi1Advanced.Fdxaccountdetailedread,
            })
        .Build())
    .OauthFapi1BaselineCredentials(
        new OauthFapi1BaselineModel.Builder(
            "OAuthClientId",
            "OAuthClientSecret"
        )
        .OauthScopes(
            new List<OauthScopeOauthFapi1Baseline>
            {
                OauthScopeOauthFapi1Baseline.Fdxnotificationspublish,
                OauthScopeOauthFapi1Baseline.Fdxnotificationssubscribe,
            })
        .Build())
    .TaxBasicAuthCredentials(
        new TaxBasicAuthModel.Builder(
            "Username",
            "Password"
        )
        .Build())
    .HttpClientConfig(httpClientConfig =>
        httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
    .Environment(FdxV660Api.Standard.Environment.Production)
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Configuration-Based Initialization

using FdxV660Api.Standard;
using Microsoft.Extensions.Configuration;

namespace ConsoleApp;

// Build the IConfiguration using .NET conventions (JSON, environment, etc.)
var configuration = new ConfigurationBuilder()
    .AddJsonFile("config.json")
    .AddEnvironmentVariables() // [optional] read environment variables
    .Build();

// Instantiate your SDK and configure it from IConfiguration
var client = FdxV660ApiClient
    .FromConfiguration(configuration.GetSection("FdxV660Api"));

See the Configuration-Based 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

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• LogBuilder
• LogRequestBuilder
• LogResponseBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiResponse
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter