IbanNet

To use IbanNet within a .NET application using Microsoft.Extensions.DependencyInjection, install the IbanNet.DependencyInjection.ServiceProvider package and register the services in your service collection. This provides access to IBAN validation, parsing, registry management, and generation via dependency injection.

// Basic registration
services.AddIbanNet();

// Registration with custom configuration
services.AddIbanNet(opts => opts
    .UseRegistryProvider(new SwiftRegistryProvider())
    .WithRule<MyCustomRule>()
);

To validate IBAN user input within a FluentValidation rule, use the Iban() extension method on a property rule. This method requires an instance of IIbanValidator to be passed into your validator's constructor.

Implementation Steps

1. Define your model containing the IBAN string.
2. Create a validator inheriting from AbstractValidator<T>.
3. Inject IIbanValidator into the constructor.
4. Apply .Iban(ibanValidator) to the relevant property rule.

public class InputModel
{
    public string BackAccountNumber { get; set; }
}

public class InputModelValidator : AbstractValidator<InputModel>
{
    public InputModelValidator(IIbanValidator ibanValidator)
    {
        RuleFor(x => x.BankAccountNumber).NotNull().Iban(ibanValidator);
    }
}

The IbanNet example web app demonstrates how to integrate IbanNet validation into different ASP.NET Core hosting models, including RazorPages, MVC controllers, and API controllers.

To run the application, you must select one of the available Debug configurations in your IDE (such as Visual Studio) to choose which validation framework you want to test with IbanNet:

1. Debug DataAnnotations: Tests integration with standard .NET DataAnnotations.
2. Debug FluentValidation: Tests integration with the FluentValidation library.

After selecting a configuration, run or debug the web application as usual.

# Select a Debug-configuration and then run/debug the web application.
# Options:
# - Debug DataAnnotations
# - Debug FluentValidation

To use IbanNet services within an Autofac IoC container, install the IbanNet.DependencyInjection.Autofac package. You can register the core services using the RegisterIbanNet() extension method on the Autofac ContainerBuilder.

container.RegisterIbanNet();

Before using the FluentValidation integration, you must register the IbanNet services and your validators in the .NET Core dependency injection container. Ensure you call AddIbanNet() to provide the necessary IIbanValidator implementation.

services.AddIbanNet();
services.AddTransient<IValidator<InputModel>, InputModelValidator>();
services.AddFluentValidation();

Use the [Iban] attribute to enable automatic IBAN validation for properties within your models. This attribute is compatible with ASP.NET (Core) and Microsoft Data Annotations. When used in a controller, the validation logic is automatically triggered during model binding, and the result is accessible via ModelState.IsValid.

public class InputModel
{
    [Iban]
    [Required]
    public string BackAccountNumber { get; set; }
}

[ApiController]
public class MyController : ControllerBase
{
    [HttpPost]
    public ActionResult Save(InputModel model)
    {
        if (ModelState.IsValid)
        {
            // ..
        }
    }
}

You can customize the IbanNet service registration by passing an options configuration lambda to RegisterIbanNet. This allows you to provide custom registry providers or add custom validation rules.

container
    .RegisterIbanNet(opts => opts
        .UseRegistryProvider(new SwiftRegistryProvider())
        .WithRule<MyCustomRule>()
    );

To convert a string into a strongly-typed Iban object, use the IIbanParser interface. The IbanParser constructor typically accepts an IbanRegistry (such as IbanRegistry.Default). The TryParse method handles strings with or without spaces and returns a boolean indicating success. Once parsed, you can format the Iban object using different IbanFormat options, such as IbanFormat.Obfuscated.

Iban iban;
IIbanParser parser = new IbanParser(IbanRegistry.Default);
bool success = parser.TryParse("NL91 ABNA 0417 1643 00", out iban);
if (success)
{
    Console.WriteLine(iban.ToString(IbanFormat.Obfuscated)); // XXXXXXXXXXXXXX4300
}

You can validate an International Bank Account Number (IBAN) by implementing the IIbanValidator interface. Use the IbanValidator class to perform the validation and check the IsValid property of the returned ValidationResult object.

IIbanValidator validator = new IbanValidator();
ValidationResult validationResult = validator.Validate("NL91ABNA0417164300");
if (validationResult.IsValid)
{
    // ..
}

When you call RegisterIbanNet(), the following interfaces are registered in the Autofac container:

• IIbanValidator: Used for validating IBAN strings.
• IIbanGenerator: Used for generating IBANs.
• IIbanParser: Used for parsing IBAN strings into structured data.

When calling AddIbanNet(), the following services are registered in the DI container and can be injected into your classes:

• IIbanValidator: Used for validating IBAN strings.
• IIbanParser: Used for parsing IBAN strings into structured data.
• IIbanRegistry: Manages IBAN country/format registries.
• IIbanGenerator: Used for generating valid IBANs.