Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/skwasjer/IbanNet

C# .NET IBAN validator, parser, builder and generator
https://github.com/skwasjer/IbanNet

builder c-sharp csharp dotnet dotnet-core dotnet-standard generator iban iban-validator parser validator

Last synced: about 1 month ago
JSON representation

C# .NET IBAN validator, parser, builder and generator

Host: GitHub
URL: https://github.com/skwasjer/IbanNet
Owner: skwasjer
License: apache-2.0
Created: 2017-12-25T00:17:03.000Z (about 7 years ago)
Default Branch: main
Last Pushed: 2024-06-21T16:33:58.000Z (6 months ago)
Last Synced: 2024-06-23T05:52:24.531Z (6 months ago)
Topics: builder, c-sharp, csharp, dotnet, dotnet-core, dotnet-standard, generator, iban, iban-validator, parser, validator
Language: C#
Homepage:
Size: 1.87 MB
Stars: 118
Watchers: 10
Forks: 31
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Support: SupportedCountries.md

Awesome Lists containing this project

README

        # IbanNet 

IbanNet is a .NET library providing functionality to validate and parse an [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) also known as IBAN. 

Additionally, IbanNet provides:

- the `Iban` primitive type, which can be used as a drop in replacement for a `string` in your domain. 

- a builder to construct IBAN's from a Basic Bank Account Number (BBAN).

- a generator to assist with (unit) testing.

---

[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://stand-with-ukraine.pp.ua)

[![Main workflow](https://github.com/skwasjer/IbanNet/actions/workflows/main.yml/badge.svg)](https://github.com/skwasjer/IbanNet/actions/workflows/main.yml)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=skwasjer_IbanNet&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=skwasjer_IbanNet)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=skwasjer_IbanNet&metric=coverage)](https://sonarcloud.io/component_measures?id=skwasjer_IbanNet&metric=coverage)

| | | |

|---|---|---|

| `IbanNet` | [![NuGet](https://img.shields.io/nuget/v/IbanNet.svg)](https://www.nuget.org/packages/IbanNet/) [![NuGet](https://img.shields.io/nuget/dt/IbanNet.svg)](https://www.nuget.org/packages/IbanNet/) | [Documentation](../../wiki)

| `IbanNet.DataAnnotations` | [![NuGet](https://img.shields.io/nuget/v/IbanNet.DataAnnotations.svg)](https://www.nuget.org/packages/IbanNet.DataAnnotations/) [![NuGet](https://img.shields.io/nuget/dt/IbanNet.DataAnnotations.svg)](https://www.nuget.org/packages/IbanNet.DataAnnotations/) | [Documentation](../../wiki/IbanNet.DataAnnotations) |

| `IbanNet.DependencyInjection.Autofac` | [![NuGet](https://img.shields.io/nuget/v/IbanNet.DependencyInjection.Autofac.svg)](https://www.nuget.org/packages/IbanNet.DependencyInjection.Autofac/) [![NuGet](https://img.shields.io/nuget/dt/IbanNet.DependencyInjection.Autofac.svg)](https://www.nuget.org/packages/IbanNet.DependencyInjection.Autofac/) | [Documentation](../../wiki/Dependency-injection) |

| `IbanNet.DependencyInjection.ServiceProvider` | [![NuGet](https://img.shields.io/nuget/v/IbanNet.DependencyInjection.ServiceProvider.svg)](https://www.nuget.org/packages/IbanNet.DependencyInjection.ServiceProvider/) [![NuGet](https://img.shields.io/nuget/dt/IbanNet.DependencyInjection.ServiceProvider.svg)](https://www.nuget.org/packages/IbanNet.DependencyInjection.ServiceProvider/) | [Documentation](../../wiki/Dependency-injection) |

| `IbanNet.FluentValidation` | [![NuGet](https://img.shields.io/nuget/v/IbanNet.FluentValidation.svg)](https://www.nuget.org/packages/IbanNet.FluentValidation/) [![NuGet](https://img.shields.io/nuget/dt/IbanNet.FluentValidation.svg)](https://www.nuget.org/packages/IbanNet.FluentValidation/) | [Documentation](../../wiki/IbanNet.FluentValidation) |

## Example with validator

```csharp

IIbanValidator validator = new IbanValidator();

ValidationResult validationResult = validator.Validate("NL91ABNA0417164300");

if (validationResult.IsValid)

{

    // ..

}

```

## Example with `Iban` type

```csharp

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

}

```

### Contributions

Please check out the [contribution guidelines](./CONTRIBUTING.md).

### Other info

- [Changelog](./CHANGELOG.md)

- [IbanNet supported countries](SupportedCountries.md)

- [Fiddle](https://dotnetfiddle.net/JeGa9x)