.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "CheckDigits::M97_002 3pm"
.TH CheckDigits::M97_002 3pm "2021-01-03" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
CheckDigits::M97_002 \- compute check digits for International Bank
Account Number (IBAN)
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Algorithm::CheckDigits;
\&
\&  $iban = CheckDigits(\*(Aqiban\*(Aq);
\&
\&  if ($iban\->is_valid(\*(AqDE88 2008 0000 09703 7570 0\*(Aq)) {
\&        # do something
\&  }
\&
\&  $cn = $iban\->complete(\*(AqDE00 2008 0000 09703 7570 0\*(Aq);
\&  # $cn = \*(AqDE88 2008 0000 09703 7570 0\*(Aq
\&
\&  $cd = $iban\->checkdigit(\*(AqDE88 2008 0000 09703 7570 0\*(Aq);
\&  # $cd = \*(Aq88\*(Aq
\&
\&  $bn = $iban\->basenumber(\*(AqDE88 2008 0000 09703 7570 0\*(Aq);
\&  # $bn = \*(AqDE00 2008 0000 09703 7570 0\*(Aq
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SS "\s-1ALGORITHM\s0"
.IX Subsection "ALGORITHM"
.IP "0" 4
The \s-1IBAN\s0 number must be prepared. The first two letters and the
checksum will be moved to the right end. The letters are substituted
according to the substitute table and the checksum is set to '00'.
.IP "1" 4
.IX Item "1"
The whole number is taken modulo 97.
.IP "2" 4
.IX Item "2"
The checksum is difference between 98 and the sum of step 2.
.IP "3" 4
.IX Item "3"
If the checksum is smaller then 10, a leading zero will be
prepended.
.SS "\s-1METHODS\s0"
.IX Subsection "METHODS"
.IP "is_valid($number)" 4
.IX Item "is_valid($number)"
Returns true only if \f(CW$number\fR consists solely of numbers and the last digit
is a valid check digit according to the algorithm given above.
.Sp
Returns false otherwise,
.IP "complete($number)" 4
.IX Item "complete($number)"
The check digit for \f(CW$number\fR is computed and concatenated to the end
of \f(CW$number\fR.
.Sp
Returns the complete number with check digit or '' if \f(CW$number\fR
does not consist solely of digits and spaces.
.IP "basenumber($number)" 4
.IX Item "basenumber($number)"
Returns the basenumber of \f(CW$number\fR if \f(CW$number\fR has a valid check
digit.
.Sp
Return '' otherwise.
.IP "checkdigit($number)" 4
.IX Item "checkdigit($number)"
Returns the checkdigits of \f(CW$number\fR if \f(CW$number\fR has a valid check
digit.
.Sp
Return '' otherwise.
.SS "\s-1EXPORT\s0"
.IX Subsection "EXPORT"
None by default.
.SH "AUTHOR"
.IX Header "AUTHOR"
Mathias Weidner, <mathias@weidner.in\-bad\-schmiedeberg.de>
.SH "THANKS"
.IX Header "THANKS"
Detlef Pilzecker pointed out to me that there may be more letters as the first
two in an \s-1IBAN\s0 number. He also made me aware of a faster method to compute the
check number than using Math::BigInt.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
perl,
CheckDigits,
\&\fIwww.pruefziffernberechnung.de\fR,
\&\fIwww.sic.ch/en/tkicch_home/tkicch_standardization/
tkicch_financialinstitutions_ibanipi.htm\fR.
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 156:" 4
.IX Item "Around line 156:"
Expected text after =item, not a number
.IP "Around line 160:" 4
.IX Item "Around line 160:"
Expected text after =item, not a number
.IP "Around line 164:" 4
.IX Item "Around line 164:"
Expected text after =item, not a number