Iban

Index

Constructors

• constructor

Methods

• checksum
• client
• institution
• isDirect
• isIndirect
• isValid
• toAddress
• toString
• createIndirect
• fromAddress
• fromBban
• isDirect
• isIndirect
• isValid
• toAddress
• toIban

Constructors

publicconstructor

• new Iban(iban: string): Iban

• Construct a direct or indirect IBAN

  ---

  Parameters

  • iban: string

  Returns Iban

Methods

publicchecksum

• checksum(): string

• Returns the ibans checksum

  ---

  Returns string

publicclient

• client(): string

• Should be called to get client identifier within institution

  ---

  Returns string

publicinstitution

• institution(): string

• Returns institution identifier from iban

  ---

  Returns string

publicisDirect

• isDirect(): boolean

• check if iban number is direct

  ---

  Returns boolean

publicisIndirect

• isIndirect(): boolean

• check if iban number if indirect

  ---

  Returns boolean

publicisValid

• isValid(): boolean

• Should be called to check if iban is correct

  ---

  Returns boolean

publictoAddress

• toAddress(): string

• Get the clients direct address from iban

  ---

  Returns string

publictoString

• toString(): string

• Returns string

publicstaticcreateIndirect

• createIndirect(options: IbanOptions): Iban

• Should be used to create IBAN object for given institution and identifier

  ---

  Parameters

  • options: IbanOptions

  Returns Iban

publicstaticfromAddress

• fromAddress(address: string): Iban

• This method should be used to create iban object from an ethereum address

  ---

  Parameters

  • address: string

  Returns Iban

publicstaticfromBban

• fromBban(bban: string): Iban

• Convert the passed BBAN to an IBAN for this country specification. Please note that

  <i>

  “generation of the IBAN shall be the exclusive responsibility of the bank/branch servicing the account”

  </i>

  . This method implements the preferred algorithm described in http://en.wikipedia.org/wiki/International_Bank_Account_Number#Generating_IBAN_check_digits

  ---

  Parameters

  • bban: string

  Returns Iban

publicstaticisDirect

• isDirect(iban: string): boolean

• Parameters

  • iban: string

  Returns boolean

publicstaticisIndirect

• isIndirect(iban: string): boolean

• Parameters

  • iban: string

  Returns boolean

publicstaticisValid

• isValid(iban: string): boolean

• This method should be used to check if given string is valid iban object

  ---

  Parameters

  • iban: string

  Returns boolean

publicstatictoAddress

• toAddress(iban: string): string

• This method should be used to create an ethereum address from a direct iban address

  ---

  Parameters

  • iban: string

  Returns string

publicstatictoIban

• toIban(address: string): string

• This method should be used to create iban address from an ethereum address

  ---

  Parameters

  • address: string

  Returns string