Documentation ebics.iban
IBAN module of the Python EBICS package.
This module defines functions to check and create IBANs.
- ebics.iban.check_iban(iban, bic=None, country=None, sepa=False)¶
Checks an IBAN for validity.
Parameters: - iban – The IBAN to be checked.
- bic – If given, IBAN and BIC are checked in the context of each other.
- country – If given, the IBAN is checked in the context of this country. Must be an ISO-3166 ALPHA 2 code.
- sepa – If sepa evaluates to True, the IBAN is checked to be valid in the Single Euro Payments Area.
Returns: True on validity, False otherwise.
- ebics.iban.create_iban(bankcode, account, bic=False)¶
Creates an IBAN from a German bank code and account number.
The kontocheck package is required to perform this function. Ohterwise a RuntimeError is raised.
Parameters: - bankcode – The German bank code.
- account – The account number.
- bic – Flag if the corresponding BIC should be returned as well.
Returns: Either the IBAN or a 2-tuple in the form of (IBAN, BIC).
- ebics.iban.check_bic(bic, country=None)¶
Checks a BIC for validity.
Parameters: - bic – The BIC to be checked.
- country – If given, the BIC is checked in the context of this country. Must be an ISO-3166 ALPHA 2 code.
Returns: True on validity, False otherwise.
- ebics.iban.get_bic(iban)¶
Returns the corresponding BIC for a given IBAN.
The kontocheck package is required to perform this function. Ohterwise a RuntimeError is raised.
- ebics.iban.parse_iban(iban)¶
Splits a given IBAN into its fragments.
Returns a 4-tuple in the form of (COUNTRY, CHECKSUM, BANK_CODE, ACCOUNT_NUMBER)
- ebics.iban.get_bankname(iban)¶
Returns the bank name of a given German IBAN.
The kontocheck package is required to perform this function. Ohterwise a RuntimeError is raised.