FortisApimaticSDK 1.0.5

Getting Started with Fortis API

Install the Package

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

dotnet add package FortisApimaticSDK --version 1.0.5

You can also view the package at: https://www.nuget.org/packages/FortisApimaticSDK/1.0.5

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 FortisApi.Standard;
using FortisApi.Standard.Authentication;
using Microsoft.Extensions.Logging;

namespace ConsoleApp;

FortisApiClient client = new FortisApiClient.Builder()
    .UserIdCredentials(
        new UserIdModel.Builder(
            "user-id"
        )
        .Build())
    .UserApiKeyCredentials(
        new UserApiKeyModel.Builder(
            "user-api-key"
        )
        .Build())
    .DeveloperIdCredentials(
        new DeveloperIdModel.Builder(
            "developer-id"
        )
        .Build())
    .AccessTokenCredentials(
        new AccessTokenModel.Builder(
            "access-token"
        )
        .Build())
    .HttpClientConfig(httpClientConfig =>
        httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
    .Environment(FortisApi.Standard.Environment.Production)
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Configuration-Based Initialization

using FortisApi.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 = FortisApiClient
    .FromConfiguration(configuration.GetSection("FortisApi"));

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.

• user-id (Custom Header Signature)
• user-api-key (Custom Header Signature)
• developer-id (Custom Header Signature)
• access-token (Custom Header Signature)

List of APIs

• Async Processing
• Declined Recurring Transactions
• Device Terms
• Full Boarding
• 3 DS Authentication
• 3 DS Transactions
• Merchant Deposits
• On Boarding
• Payment Card Reader Token
• Quick Invoices
• Transaction ACH Retries
• Transactions-ACH
• Transactions-Cash
• Transactions-Credit Card
• Transactions-EBT Card
• Transactions-Read
• Level 3 Data
• Transactions-Updates
• User Verifications
• Apple Pay Validate Merchant
• Merchant Details
• Batches
• Contacts
• Elements
• Locations
• Paylinks
• Recurring
• Signatures
• Tags
• Terminals
• Tickets
• Tokens
• Users
• Webhooks

SDK Infrastructure

Configuration

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

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiResponse
• ApiHelper