Finturest.Iban 1.0.0

Finturest IBAN API C# SDK

Official C# SDK for the Finturest IBAN API - supports .NET Standard 2.0+ and all modern .NET versions.

Overview

This SDK provides a fast and secure way to integrate Finturest IBAN validation, generation, and bank data lookup into your .NET applications. It supports .NET Standard 2.0 and later, ensuring compatibility with .NET Core and the latest .NET releases.

Features

• IBAN Format Validation: Validates IBAN structure based on official formats for 100+ countries.

• IBAN Generation: Dynamically generates valid IBANs using country-specific rules, given bank and account identifiers.

• Checksum Verification: Performs MOD-97 checksum validation to ensure IBAN authenticity.

• SEPA & Non-SEPA Coverage: Supports both SEPA and international IBANs for broad banking network compatibility.

• Real-Time Response: Get accurate validation, generation, and bank metadata in milliseconds for streamlined financial operations.

Installation

Using the .NET Core command-line interface (CLI) tools:

dotnet add package Finturest.Iban

Using the NuGet Command Line Interface (CLI):

nuget install Finturest.Iban

Using the Package Manager Console:

Install-Package Finturest.Iban

From within Visual Studio:

1. Open the Solution Explorer.
2. Right-click on a project within your solution.
3. Click on Manage NuGet Packages...
4. Click on the Browse tab and search for "Finturest.Iban".
5. Click on the Finturest.Iban package, select the appropriate version in the right-tab and click Install.

Usage

Registering

To use the Finturest.Iban client, register it in your application's dependency injection container using AddFinturestIban. This configures the services required to communicate with the Finturest IBAN API.

var services = new ServiceCollection();

services.AddFinturestIban(options =>
{
    options.ApiKey = "YOUR_API_KEY";
});

Note
IIbanServiceClient is registered in the DI container and should be resolved via dependency injection.
In ASP.NET Core applications, it's recommended to inject it through constructor injection.

Note
The abstractions for the Finturest Iban API client are provided in a separate package named Finturest.Iban.Abstractions.
You can reference this package in your business layer to avoid a tight dependency on the implementation.
Only the root application or composition root should reference the full Finturest.Iban package that contains the implementation.

Validating

To validate an IBAN using the Finturest IBAN API, create a ValidateIbanRequestModel and call the ValidateIbanRequestModel method on the IIbanServiceClient.

var serviceProvider = services.BuildServiceProvider();

var ibanServiceClient = serviceProvider.GetRequiredService<IIbanServiceClient>();

try
{
    var request = new ValidateIbanRequestModel
    {
        Iban = "FR7630006000011234567890189"
    };

    var result = await ibanServiceClient.ValidateIbanAsync(request);
    
    Console.WriteLine("IBAN is valid.");
}
catch (IbanException exception)
{
    Console.WriteLine("IBAN is invalid.");
}

Note
In production applications, avoid using BuildServiceProvider() manually.
Instead, use constructor injection to get IIbanServiceClient from the framework’s dependency injection system.

Generating

To generate an IBAN using the Finturest IBAN API, create a GenerateIbanRequestModel and call the GenerateIbanAsync method on the IIbanServiceClient.

try
{
    var request = new GenerateIbanRequestModel
    {
        CountryCode = "FR",
        BankIdentifier = "30006",
        BranchIdentifier = "00001",
        BankAccountNumber = "1234567890189"
    };

    var result = await ibanServiceClient.GenerateIbanAsync(request);
    
    Console.WriteLine($"IBAN: {result.Iban}"); // IBAN: FR7630006000011234567890189
}
catch (IbanException exception)
{
    Console.WriteLine("Invalid parameters.");
}

Subscription & Pricing

To get access to the Finturest IBAN API or subscribe to a plan, please visit the subscription page. An active subscription is required to access the API in production.

Manage subscriptions

API Key Generation

An API key is required to use the SDK and can be generated on your Finturest dashboard:

Generate API key

Documentation

For full API reference and usage guides, please visit the official Finturest IBAN API documentation:

View API reference

Contact

For support, questions, or inquiries, please contact us at: support@finturest.com