mimir

README

Mimir  

What is Mimir ?

Mimir is a lightweight library that exposes some functions to validate some banking informations.

Disclaimer

This library is still in development, so it might be possible that some methods change over time.

Methods available

As the project just started, it is quite poor in methods.
Stay tuned for updates !

Method Name	Short Description
IsIBANValid	Validate an IBAN
GetCheckDigits	Compute check digits from a valid IBAN
FormatIBAN	Format IBAN based on its structure
PrintFormatIBAN	Format IBAN as it would be printed
GetCountryConfiguration	Get country configuration and informations
SplitIBAN	Split the IBAN based on its structure

Supported countries

Please visit SUPPORTED_COUNTRIES.md

Use

Get

$ go get -u github.com/vdlbk/mimir

Examples

Validate an IBAN

package main

import (
	"fmt"
	"github.com/vdlbk/mimir"
)

func main(){
	IBAN := "FR1420041010050500013M02606"
	
	err := mimir.IsIBANValid(IBAN)
	fmt.Println(err) // nil
	
	badIBAN := "FR1420041010050500013M02605"
	
	err = mimir.IsIBANValid(badIBAN)
	fmt.Println(err) // IBAN invalid checksum
}

Documentation

Index

• Constants
• func FormatIBAN(iban string) (string, error)
• func GetCheckDigits(iban string) (string, string, error)
• func GetCountryConfiguration(countryCode string) (*configuration, error)
• func IsIBANValid(iban string) error
• func PrintFormatIBAN(iban string) (string, error)
• func SplitIBAN(iban string) ([]string, []string, error)

Constants

const (
	// ErrIBANTooshort is the error when a IBAN is too short for the validation process
	ErrIBANTooshort = mimirError("IBAN is too short")

	// ErrIBANIncorrectLength is the error when a IBAN does not have the required length
	ErrIBANIncorrectLength = mimirError("IBAN incorrect length")

	// ErrIBANInvalidChecksum is the error when a IBAN is invalid
	ErrIBANInvalidChecksum = mimirError("IBAN invalid checksum")

	// ErrCountryCodeDoesNotExist is the error when you lookup for a country code that does not exists
	ErrCountryCodeDoesNotExist = mimirError("Country Code does not exist")
)

Errors

const (
	AccountNumberDigitKey                = "a" // alphanumeric
	NationalBankCodeDigitKey             = "b" // numeric
	CountryCodeDigitKey                  = "c" // alphabetic
	CheckDigitKey                        = "k" // checksum
	NationalIdentificationNumberDigitKey = "i"
	CurrencyDigitKey                     = "m" // alphanumeric
	AccountHolderDigitKey                = "n"
	ReserveNumberDigitKey                = "o" // always 0
	BranchCodeDigitKey                   = "s" // counter code
	AccountTypeDigitKey                  = "t"
	SWIFTBICCodeDigitKey                 = "w" // alphanumeric
	NationalCheckDigitKey                = "x" // numeric
)

Structure digit keys

Functions

func FormatIBAN

func FormatIBAN(iban string) (string, error)

FormatIBAN formats the given IBAN with the different parts that are defined in its structure.

func GetCheckDigits

func GetCheckDigits(iban string) (string, string, error)

GetCheckDigits compute the check digits from a given IBAN. Returns the computed digits, the IBAN set with the check digits or an error if something goes wrong.

func GetCountryConfiguration

func GetCountryConfiguration(countryCode string) (*configuration, error)

GetCountryConfiguration returns ISO 13616-Compliant IBAN Formats from a given country code If the countryCode does not exist in the list, returns an error `ErrCountryCodeDoesNotExist`

func IsIBANValid

func IsIBANValid(iban string) error

IsIBANValid checks if the given IBAN is valid based on the country its belong to.

func PrintFormatIBAN

func PrintFormatIBAN(iban string) (string, error)

PrintFormatIBAN formats the given IBAN based on the regular way to print it depending the country. It will use the PrintFormat of the configuration to insure the result.

func SplitIBAN

func SplitIBAN(iban string) ([]string, []string, error)

SplitIBAN splits a given IBAN depending the structure of its country. It returns a list of digit keys, a list that contains each part of the structure or an error if something went wrong.