Ukrainian Payment Qr Invoices

IbanEx

IBAN 番号を扱うための Elixir ライブラリ（解析、検証、チェック、フォーマット）

IBAN とは？

IBAN（International Bank Account Number の略）は、最大 34 文字の英数字で構成される国際的に合意されたコードで、国際送金が正しく処理されるよう銀行を支援します。

IBAN は、数文字の英数字で、国際的な送金や受け取りに必要な国、銀行、口座の詳細をすべて含んでいます。このシステムはヨーロッパ全域で使われており、中東、北アフリカ、カリブ海地域の一部でも認められています。使用されているすべての国の IBAN の例をご覧ください。

使い方

IBAN の解析が成功するケース

    iex>  "FI2112345600000785" |> IbanEx.Parser.parse()
    {:ok, %IbanEx.Iban{
      iban: "FI2112345600000785",
      country_code: "FI",
      check_digits: "21",
      bank_code: "123456",
      branch_code: nil,
      national_check: "5",
      account_number: "0000078"
    }}

IBAN の解析でエラーになるケース

IBAN の国がサポートされているか確認する

    iex> {:error, unsupported_country_code} = IbanEx.Parser.parse("ZU21NABZ00000000137010001944")
    {:error, :unsupported_country_code}
    iex> IbanEx.Error.message(unsupported_country_code)
    "Unsupported country code"

IBAN の長さを検証して確認する

    iex> {:error, invalid_length} = IbanEx.Parser.parse("AT6119043002345732012")
    {:error, :invalid_length}
    iex> IbanEx.Error.message(invalid_length)
    "IBAN violates the required length"

    iex> {:error, length_to_long} = IbanEx.Validator.check_iban_length("AT6119043002345732012")
    {:error, :length_to_long}
    iex> IbanEx.Error.message(length_to_long)
    "IBAN longer then required length"
    iex> {:error, length_to_short} = IbanEx.Validator.check_iban_length("AT61190430023457320")
    {:error, :length_to_short}
    iex> IbanEx.Error.message(length_to_short)
    "IBAN shorter then required length"

IBAN のチェックサムを検証する

    iex> {:error, invalid_checksum} = IbanEx.Parser.parse("AT621904300234573201")
    {:error, :invalid_checksum}
    iex> IbanEx.Error.message(invalid_checksum)
    "IBAN's checksum is invalid"

インストール

mix.exs の依存関係リストに iban_ex を追加すると、パッケージをインストールできます。

def deps do
  [
    {:iban_ex, "~> 0.1.8"}
  ]
end

ExDoc でドキュメントを生成し、 HexDocs で公開できます。公開後、ドキュメントは https://hexdocs.pm/iban_ex でご覧いただけます。