UKModulusCheck


Validator

Namespace: UkModulusCheck

The F# API of the library

Functions and values

Function or valueDescription
loadRules path
Signature: path:string -> Result<ValidationRule list,exn>

Loads rules for specific sort code ranges from file (valacdos.txt)

Parameters

  • path - path to the file containing rules from VocaLink

Output type

  • Result<ValidationRule list, exn>
loadSubstitutions path
Signature: path:string -> Result<SortCodeSubstitution list,exn>

Loads sort code substitution table from file (scsubtab.txt)

Parameters

  • path - path to the file containing substitutions from VocaLink

Output type

  • Result<SortCodeSubstitution list, exn>
validateAccountNo (...)
Signature: rulesTable:seq<ValidationRule> -> substitutionTable:seq<SortCodeSubstitution> -> sortCode:SortCode -> accountNo:AccountNumber -> ValidationResult

Runs modulus check on UK sort code and account number given the rules and substitution tables.

Parameters

  • rulesTable - collection containing information about which algorithm and weightings to use for given sort code
  • substitutionTable - collection containing sort codes which need to be substituted for check purposes
  • sortCode - sort code to check
  • accountNo - account number to check

Output type

  • ValidationResult
Fork me on GitHub