IBAN_Calculator
View the WSDL for the service. Click on an operation name to view its details.
- validate_iban
- calculate_iban
- get_dutch_banks
- get_swiss_banks
- find_bank
- supported_countries
- country_supported
- get_form
Close
Name: validate_iban
Binding: IBAN_CalculatorBinding
Endpoint: https://ssl.ibanrechner.de:443/soap-12-2/index.php
SoapAction: https://ssl.ibanrechner.de/#validate_iban
Style: rpc
Input:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: validate_ibanRequest
parts:
iban: xsd:string
user: xsd:string
password: xsd:string
Output:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: validate_ibanResponse
parts:
return: tns:IBANValResStruct
Namespace: https://ssl.ibanrechner.de/
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Validates the given IBAN. The user ID and password you need to pass with the request are the same you use for logging in as a premium user. This service is available to all premium users who have paid their subscription fee. For more details on the subscription model, see www.iban-bic.com.
Output fields are:
iban: the IBAN that was validated.
result: 'passed' or 'failed' - for a valid or invalid IBAN
return_code: a condensed representation of the results of various checks. Not all checks have necessarily been done (see the other fields to find out). The condensed representation is a number which is 0 if all supported checks were done and passed. Otherwise, it is the sum of one or more of the following numbers: 1=automatically appended a subaccount number; 2=account number does not contain a checksum; 4=did not check the checksum; 8=did not check the bank code; 32=warning: a subaccount number might need to be appended, but you need to check if this is really the case; 128=checksum error in account number; 256=bank code not found in directory; 512=wrong length for IBAN; 1024=wrong length for bank code; 2048=IBAN checksum error (digits 3 and 4); 4096=missing input data (such as country code); 8192=this country is not (yet?) supported.
This condensed return code can be used for a simple check such as: if the sum is less than 32, the result can be assumed to be correct; if it is in the range from 32 to 127, it might be correct but should be checked; if it is 128 or higher, there seems to be a more serious error. There is one exception to this rule: if it is 65536, this means that the return code is not set at all. This should not happen - please notify us if it does.
checks: an array of the checks performed (can contain elements such as 'length', 'bank_code', 'account_number', 'iban_checksum').
bic_candidates: an array of BICs that are associated with the given national bank code. May be empty or may contain one or more elements. The BICstruct element has the attributes bic, wwwcount, sampleurl, and city. If a wwwcount greater than zero is given, the BIC was harvested from the Web (and found on as many pages as indicated by wwwcount, for example at the URL given by sampleurl). If wwwcount is zero, the BIC comes from a national bank or the ECB. If city is given, this also indicates that the BIC comes from a national bank or the ECB. The given city does not necessarily reflect the location of the given branch - it can also be the location of the headquarters.
country: the ISO country code (first two letters of the IBAN)
bank_code: the national bank code. Part of the BIC for NL (where no national bank code exists).
bank: bank name, if known
bank_address: some address data, if known
bank_url: URL of website, if known
branch: branch name, if known
branch_code: branch code, if known
in_scl_directory: if at least one BIC is returned, this field is set to 'yes' or 'no', depending on whether the first returned BIC is listed in the German Bundesbank's SCL directory. If no BIC is returned, this field is left blank.
sct: if in_scl_directory is set to 'yes', this field is set to 'yes' if a SEPA Credit Transfer is supported for the first returned BIC. If no SCT is supported, the field is set to 'no'. If no BIC is returned, the field is left blank.
sdd: if in_scl_directory is set to 'yes', this field is set to 'yes' if SEPA Direct Debit is supported for the first returned BIC. If no SDD is supported, the field is set to 'no'. If no BIC is returned, the field is left blank.
b2b: if in_scl_directory is set to 'yes', this field is set to 'yes' if SEPA Business to Business is supported for the first returned BIC. If no B2B is supported, the field is set to 'no'. If no BIC is returned, the field is left blank.
account_number: the national bank account number
account_validation_method: name of the validation algorithm for the national account number
account_validation: for German or Swiss account numbers, an explanation (in German)
length_check: 'passed' or 'failed' - for the right number of characters for the given country
account_check (not provided for every country): 'passed' or 'failed' (checksum validation; if the algorithm is unknown, or if there is no checksum, the result is 'passed' or empty).
bank_code_check (not provided for every country): lookup of national bank code was successful ('passed') or not ('failed')
iban_checksum_check: 'passed' or 'failed' (correctness of the two digits right after the country code in the IBAN)
data_age (not given for all countries): age of the BIC and other bank-related data (not defined for data harvested from the Web). Format: yyyymmdd.
IBANformat: a string describing the IBAN format for the given country, for example: 'DEkk BBBB BBBB CCCC CCCC CC'.
formatcomment: an explanation of the IBANformat string, for example: 'B = sort code (BLZ), C = account No.'
balance: the number of remaining calculations you can do before having to recharge your account. This does not apply to customers with a subscription which includes an unlimited number of calculations.
Name: validate_iban
Binding: IBAN_CalculatorBinding
Endpoint: https://ssl.ibanrechner.de:443/soap-12-2/index.php
SoapAction: https://ssl.ibanrechner.de/#validate_iban
Style: rpc
Input:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: validate_ibanRequest
parts:
iban: xsd:string
user: xsd:string
password: xsd:string
Output:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: validate_ibanResponse
parts:
return: tns:IBANValResStruct
Namespace: https://ssl.ibanrechner.de/
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Validates the given IBAN. The user ID and password you need to pass with the request are the same you use for logging in as a premium user. This service is available to all premium users who have paid their subscription fee. For more details on the subscription model, see www.iban-bic.com.
Output fields are:
iban: the IBAN that was validated.
result: 'passed' or 'failed' - for a valid or invalid IBAN
return_code: a condensed representation of the results of various checks. Not all checks have necessarily been done (see the other fields to find out). The condensed representation is a number which is 0 if all supported checks were done and passed. Otherwise, it is the sum of one or more of the following numbers: 1=automatically appended a subaccount number; 2=account number does not contain a checksum; 4=did not check the checksum; 8=did not check the bank code; 32=warning: a subaccount number might need to be appended, but you need to check if this is really the case; 128=checksum error in account number; 256=bank code not found in directory; 512=wrong length for IBAN; 1024=wrong length for bank code; 2048=IBAN checksum error (digits 3 and 4); 4096=missing input data (such as country code); 8192=this country is not (yet?) supported.
This condensed return code can be used for a simple check such as: if the sum is less than 32, the result can be assumed to be correct; if it is in the range from 32 to 127, it might be correct but should be checked; if it is 128 or higher, there seems to be a more serious error. There is one exception to this rule: if it is 65536, this means that the return code is not set at all. This should not happen - please notify us if it does.
checks: an array of the checks performed (can contain elements such as 'length', 'bank_code', 'account_number', 'iban_checksum').
bic_candidates: an array of BICs that are associated with the given national bank code. May be empty or may contain one or more elements. The BICstruct element has the attributes bic, wwwcount, sampleurl, and city. If a wwwcount greater than zero is given, the BIC was harvested from the Web (and found on as many pages as indicated by wwwcount, for example at the URL given by sampleurl). If wwwcount is zero, the BIC comes from a national bank or the ECB. If city is given, this also indicates that the BIC comes from a national bank or the ECB. The given city does not necessarily reflect the location of the given branch - it can also be the location of the headquarters.
country: the ISO country code (first two letters of the IBAN)
bank_code: the national bank code. Part of the BIC for NL (where no national bank code exists).
bank: bank name, if known
bank_address: some address data, if known
bank_url: URL of website, if known
branch: branch name, if known
branch_code: branch code, if known
in_scl_directory: if at least one BIC is returned, this field is set to 'yes' or 'no', depending on whether the first returned BIC is listed in the German Bundesbank's SCL directory. If no BIC is returned, this field is left blank.
sct: if in_scl_directory is set to 'yes', this field is set to 'yes' if a SEPA Credit Transfer is supported for the first returned BIC. If no SCT is supported, the field is set to 'no'. If no BIC is returned, the field is left blank.
sdd: if in_scl_directory is set to 'yes', this field is set to 'yes' if SEPA Direct Debit is supported for the first returned BIC. If no SDD is supported, the field is set to 'no'. If no BIC is returned, the field is left blank.
b2b: if in_scl_directory is set to 'yes', this field is set to 'yes' if SEPA Business to Business is supported for the first returned BIC. If no B2B is supported, the field is set to 'no'. If no BIC is returned, the field is left blank.
account_number: the national bank account number
account_validation_method: name of the validation algorithm for the national account number
account_validation: for German or Swiss account numbers, an explanation (in German)
length_check: 'passed' or 'failed' - for the right number of characters for the given country
account_check (not provided for every country): 'passed' or 'failed' (checksum validation; if the algorithm is unknown, or if there is no checksum, the result is 'passed' or empty).
bank_code_check (not provided for every country): lookup of national bank code was successful ('passed') or not ('failed')
iban_checksum_check: 'passed' or 'failed' (correctness of the two digits right after the country code in the IBAN)
data_age (not given for all countries): age of the BIC and other bank-related data (not defined for data harvested from the Web). Format: yyyymmdd.
IBANformat: a string describing the IBAN format for the given country, for example: 'DEkk BBBB BBBB CCCC CCCC CC'.
formatcomment: an explanation of the IBANformat string, for example: 'B = sort code (BLZ), C = account No.'
balance: the number of remaining calculations you can do before having to recharge your account. This does not apply to customers with a subscription which includes an unlimited number of calculations.
Close
Name: calculate_iban
Binding: IBAN_CalculatorBinding
Endpoint: https://ssl.ibanrechner.de:443/soap-12-2/index.php
SoapAction: https://ssl.ibanrechner.de/#calculate_iban
Style: rpc
Input:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: calculate_ibanRequest
parts:
country: xsd:string
bankcode: xsd:string
account: xsd:string
user: xsd:string
password: xsd:string
bic: xsd:string
legacy_mode: xsd:int
Output:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: calculate_ibanResponse
parts:
return: tns:IBANCalcResStruct
Namespace: https://ssl.ibanrechner.de/
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Calculates an IBAN for the given national account number. The user ID and password you need to pass with the request are the same you use for logging in as a premium user. This service is available to all premium users who have paid their subscription fee. For more details on the subscription model, see www.iban-bic.com.
Parameters are:
country - the 2-letter ISO country code.
bankcode - The national bank code (BC number for Switzerland). For the following countries, the whole national account number, including any bank codes and branch codes, should be passed with the account parameter, and the bankcode parameter should stay empty: IT, BE, ES, EE, SK, CZ, HU, LU, PL, FR, GR
account - the national account number
user - your unique user ID
password - your password
bic - the BIC (or at least a sufficiently long prefix) for GB, NL (GB: web crawl can be used, but does not provide all BICs. If the bic parameter is omitted, and the BIC is not found in the Web crawl, this will be shown with an error message in the output field result). This parameter is ignored for countries other than GB and NL.
legacy_mode: If set to 1 for Switzerland, the calculator does not use the external Java program provided by Swiss Interbank Clearing. This parameter has no effect for countries other than Switzerland. For Switzerland, the Java program validates account numbers, but is slower and requires all characters to be entered correctly (such as dots, hyphens etc.). The legacy mode is faster, but does not validate account numbers, and is less likely to produce correct results.
Output fields are:
result: 'passed' or 'failed' - for a valid or invalid account number/bank code/country combination
return_code: a condensed representation of the results of various checks. Not all checks have necessarily been done (see the other fields to find out). The condensed representation is a number which is 0 if all supported checks were done and passed. Otherwise, it is the sum of one or more of the following numbers: 1=automatically appended a subaccount number; 2=account number does not contain a checksum; 4=did not check the checksum; 8=did not check the bank code; 32=warning: a subaccount number might need to be appended, but you need to check if this is really the case; 128=checksum error in account number; 256=bank code not found in directory; 512=wrong length for account number; 1024=wrong length for bank code; 4096=missing input data (such as country code); 8192=this country is not (yet?) supported.
This condensed return code can be used for a simple check such as: if the sum is less than 32, the result can be assumed to be correct; if it is in the range from 32 to 127, it might be correct but should be checked; if it is 128 or higher, there seems to be a more serious error. There is one exception to this rule: if it is 65536, this means that the return code is not set at all. This should not happen - please notify us if it does.
iban: the calculated IBAN (if the national account number/bank code had the right length; an IBAN may be provided even if the account number validation fails.)
checks: an array of the checks performed (can contain elements such as 'length', 'bank_code', 'account_number').
bic_candidates: an array of BICs that are associated with the given national bank code. May be empty or may contain one or more elements. The bic element has the attributes bic, wwwcount, sampleurl, and city. If a wwwcount greater than zero is given, the BIC was harvested from the Web (and found on as many pages as indicated by wwwcount, for example on the page indicated by sampleurl). If wwwcount is zero, the BIC comes from a national bank or the ECB. If city is given, this also indicates that the BIC comes from a national bank or the ECB. The given city does not necessarily reflect the location of the given branch - it can also be the location of the headquarters.
country: the ISO country code (first two letters of the IBAN)
bank_code: the national bank code, if it exists. BIC for NL (where no national bank code exists), BC-Nummer for Switzerland. There are functions provided for obtaining Dutch BICs and Swiss BC numbers.
alternative_bank_code: very few banks embed a bank code in the IBAN that is different from the bank code communicated to clients. If this might be the case, this field is filled with the alternative possibility. Otherwise, it is empty.
bank: bank name, if known
bank_address: some address data, if known
bank_url: URL of website, if known
branch: branch name, if known
branch_code: branch code, if known
in_scl_directory: if at least one BIC is returned, this field is set to 'yes' or 'no', depending on whether the first returned BIC is listed in the German Bundesbank's SCL directory. If no BIC is returned, this field is left blank.
sct: if in_scl_directory is set to 'yes', this field is set to 'yes' if a SEPA Credit Transfer is supported for the first returned BIC. If no SCT is supported, the field is set to 'no'. If no BIC is returned, the field is left blank.
sdd: if in_scl_directory is set to 'yes', this field is set to 'yes' if SEPA Direct Debit is supported for the first returned BIC. If no SDD is supported, the field is set to 'no'. If no BIC is returned, the field is left blank.
b2b: if in_scl_directory is set to 'yes', this field is set to 'yes' if SEPA Business to Business is supported for the first returned BIC. If no B2B is supported, the field is set to 'no'. If no BIC is returned, the field is left blank.
account_number: the national bank account number
alternative_account_number: sometimes, a subaccount number needs to be appended to a German account number before it is embedded in an IBAN. If this is the case, the extended account number appears in this field.
account_validation_method: name of the validation algorithm for the national account number
account_validation: for German or Swiss account numbers, an explanation (in German)
length_check: 'passed', 'failed for bank code', or 'failed for account number' - for the right number of characters for the given country and account number/bank code
account_check (not provided for every country): 'passed' or 'failed'; for Germany also possible: passed after correction - in that case see alternative_account_number (checksum validation; if the algorithm is unknown, or if there is no checksum, the result is 'passed' or empty).
bank_code_check (not provided for every country): lookup of national bank code was successful ('passed') or not ('failed'); if an alternative bank code might be necessary for the IBAN, this information is added after the word 'passed' in this field.
bic_plausibility_check: NL only. Checks how often account numbers of the given bank actually have the given prefix. Since this does not guarantee anything, this check is ignored for the overall pass/fail decision that is reported in the result field. But for some Dutch banks, it can give you an idea of how likely it is that the right BIC was provided.
data_age (not given for all countries): age of the BIC and other bank-related data (not defined for data harvested from the Web). Format: yyyymmdd.
IBANformat: a string describing the IBAN format for the given country, for example: 'DEkk BBBB BBBB CCCC CCCC CC'.
formatcomment: an explanation of the IBANformat string, for example: 'B = sort code (BLZ), C = account No.'
balance: the number of remaining calculations you can do before having to recharge your account. This does not apply to customers with a subscription which includes an unlimited number of calculations.
Name: calculate_iban
Binding: IBAN_CalculatorBinding
Endpoint: https://ssl.ibanrechner.de:443/soap-12-2/index.php
SoapAction: https://ssl.ibanrechner.de/#calculate_iban
Style: rpc
Input:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: calculate_ibanRequest
parts:
country: xsd:string
bankcode: xsd:string
account: xsd:string
user: xsd:string
password: xsd:string
bic: xsd:string
legacy_mode: xsd:int
Output:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: calculate_ibanResponse
parts:
return: tns:IBANCalcResStruct
Namespace: https://ssl.ibanrechner.de/
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Calculates an IBAN for the given national account number. The user ID and password you need to pass with the request are the same you use for logging in as a premium user. This service is available to all premium users who have paid their subscription fee. For more details on the subscription model, see www.iban-bic.com.
Parameters are:
country - the 2-letter ISO country code.
bankcode - The national bank code (BC number for Switzerland). For the following countries, the whole national account number, including any bank codes and branch codes, should be passed with the account parameter, and the bankcode parameter should stay empty: IT, BE, ES, EE, SK, CZ, HU, LU, PL, FR, GR
account - the national account number
user - your unique user ID
password - your password
bic - the BIC (or at least a sufficiently long prefix) for GB, NL (GB: web crawl can be used, but does not provide all BICs. If the bic parameter is omitted, and the BIC is not found in the Web crawl, this will be shown with an error message in the output field result). This parameter is ignored for countries other than GB and NL.
legacy_mode: If set to 1 for Switzerland, the calculator does not use the external Java program provided by Swiss Interbank Clearing. This parameter has no effect for countries other than Switzerland. For Switzerland, the Java program validates account numbers, but is slower and requires all characters to be entered correctly (such as dots, hyphens etc.). The legacy mode is faster, but does not validate account numbers, and is less likely to produce correct results.
Output fields are:
result: 'passed' or 'failed' - for a valid or invalid account number/bank code/country combination
return_code: a condensed representation of the results of various checks. Not all checks have necessarily been done (see the other fields to find out). The condensed representation is a number which is 0 if all supported checks were done and passed. Otherwise, it is the sum of one or more of the following numbers: 1=automatically appended a subaccount number; 2=account number does not contain a checksum; 4=did not check the checksum; 8=did not check the bank code; 32=warning: a subaccount number might need to be appended, but you need to check if this is really the case; 128=checksum error in account number; 256=bank code not found in directory; 512=wrong length for account number; 1024=wrong length for bank code; 4096=missing input data (such as country code); 8192=this country is not (yet?) supported.
This condensed return code can be used for a simple check such as: if the sum is less than 32, the result can be assumed to be correct; if it is in the range from 32 to 127, it might be correct but should be checked; if it is 128 or higher, there seems to be a more serious error. There is one exception to this rule: if it is 65536, this means that the return code is not set at all. This should not happen - please notify us if it does.
iban: the calculated IBAN (if the national account number/bank code had the right length; an IBAN may be provided even if the account number validation fails.)
checks: an array of the checks performed (can contain elements such as 'length', 'bank_code', 'account_number').
bic_candidates: an array of BICs that are associated with the given national bank code. May be empty or may contain one or more elements. The bic element has the attributes bic, wwwcount, sampleurl, and city. If a wwwcount greater than zero is given, the BIC was harvested from the Web (and found on as many pages as indicated by wwwcount, for example on the page indicated by sampleurl). If wwwcount is zero, the BIC comes from a national bank or the ECB. If city is given, this also indicates that the BIC comes from a national bank or the ECB. The given city does not necessarily reflect the location of the given branch - it can also be the location of the headquarters.
country: the ISO country code (first two letters of the IBAN)
bank_code: the national bank code, if it exists. BIC for NL (where no national bank code exists), BC-Nummer for Switzerland. There are functions provided for obtaining Dutch BICs and Swiss BC numbers.
alternative_bank_code: very few banks embed a bank code in the IBAN that is different from the bank code communicated to clients. If this might be the case, this field is filled with the alternative possibility. Otherwise, it is empty.
bank: bank name, if known
bank_address: some address data, if known
bank_url: URL of website, if known
branch: branch name, if known
branch_code: branch code, if known
in_scl_directory: if at least one BIC is returned, this field is set to 'yes' or 'no', depending on whether the first returned BIC is listed in the German Bundesbank's SCL directory. If no BIC is returned, this field is left blank.
sct: if in_scl_directory is set to 'yes', this field is set to 'yes' if a SEPA Credit Transfer is supported for the first returned BIC. If no SCT is supported, the field is set to 'no'. If no BIC is returned, the field is left blank.
sdd: if in_scl_directory is set to 'yes', this field is set to 'yes' if SEPA Direct Debit is supported for the first returned BIC. If no SDD is supported, the field is set to 'no'. If no BIC is returned, the field is left blank.
b2b: if in_scl_directory is set to 'yes', this field is set to 'yes' if SEPA Business to Business is supported for the first returned BIC. If no B2B is supported, the field is set to 'no'. If no BIC is returned, the field is left blank.
account_number: the national bank account number
alternative_account_number: sometimes, a subaccount number needs to be appended to a German account number before it is embedded in an IBAN. If this is the case, the extended account number appears in this field.
account_validation_method: name of the validation algorithm for the national account number
account_validation: for German or Swiss account numbers, an explanation (in German)
length_check: 'passed', 'failed for bank code', or 'failed for account number' - for the right number of characters for the given country and account number/bank code
account_check (not provided for every country): 'passed' or 'failed'; for Germany also possible: passed after correction - in that case see alternative_account_number (checksum validation; if the algorithm is unknown, or if there is no checksum, the result is 'passed' or empty).
bank_code_check (not provided for every country): lookup of national bank code was successful ('passed') or not ('failed'); if an alternative bank code might be necessary for the IBAN, this information is added after the word 'passed' in this field.
bic_plausibility_check: NL only. Checks how often account numbers of the given bank actually have the given prefix. Since this does not guarantee anything, this check is ignored for the overall pass/fail decision that is reported in the result field. But for some Dutch banks, it can give you an idea of how likely it is that the right BIC was provided.
data_age (not given for all countries): age of the BIC and other bank-related data (not defined for data harvested from the Web). Format: yyyymmdd.
IBANformat: a string describing the IBAN format for the given country, for example: 'DEkk BBBB BBBB CCCC CCCC CC'.
formatcomment: an explanation of the IBANformat string, for example: 'B = sort code (BLZ), C = account No.'
balance: the number of remaining calculations you can do before having to recharge your account. This does not apply to customers with a subscription which includes an unlimited number of calculations.
Close
Name: get_dutch_banks
Binding: IBAN_CalculatorBinding
Endpoint: https://ssl.ibanrechner.de:443/soap-12-2/index.php
SoapAction: https://ssl.ibanrechner.de/#get_dutch_banks
Style: rpc
Input:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: get_dutch_banksRequest
parts:
user: xsd:string
password: xsd:string
Output:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: get_dutch_banksResponse
parts:
return: tns:BankResStruct
Namespace: https://ssl.ibanrechner.de/
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Returns a list of Dutch banks and their BICs.
Dutch national account numbers do not contain reliable information about the bank. There is a bank code (of variable length) embedded in Dutch account numbers, but it is possible for bank clients to keep an account number when switching banks, and therefore there exist accounts where the bank code does not match the bank. When calculating a Dutch IBAN, you need to pass an account number and a BIC to the function calculate_iban; the BIC can be picked from the list which is returned by the function get_dutch_banks.
Output fields:
result: empty if everything is okay, otherwise an error message.
banks: an array of bank structs with the fields:
* name: the name of the bank.
* bic: the BIC.
* bankcode: this field is left empty for Dutch banks.
* address: this field is left empty.
balance: the number of remaining calculations you can do before having to recharge your account. This does not apply to customers with a subscription which includes an unlimited number of calculations.
Name: get_dutch_banks
Binding: IBAN_CalculatorBinding
Endpoint: https://ssl.ibanrechner.de:443/soap-12-2/index.php
SoapAction: https://ssl.ibanrechner.de/#get_dutch_banks
Style: rpc
Input:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: get_dutch_banksRequest
parts:
user: xsd:string
password: xsd:string
Output:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: get_dutch_banksResponse
parts:
return: tns:BankResStruct
Namespace: https://ssl.ibanrechner.de/
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Returns a list of Dutch banks and their BICs.
Dutch national account numbers do not contain reliable information about the bank. There is a bank code (of variable length) embedded in Dutch account numbers, but it is possible for bank clients to keep an account number when switching banks, and therefore there exist accounts where the bank code does not match the bank. When calculating a Dutch IBAN, you need to pass an account number and a BIC to the function calculate_iban; the BIC can be picked from the list which is returned by the function get_dutch_banks.
Output fields:
result: empty if everything is okay, otherwise an error message.
banks: an array of bank structs with the fields:
* name: the name of the bank.
* bic: the BIC.
* bankcode: this field is left empty for Dutch banks.
* address: this field is left empty.
balance: the number of remaining calculations you can do before having to recharge your account. This does not apply to customers with a subscription which includes an unlimited number of calculations.
Close
Name: get_swiss_banks
Binding: IBAN_CalculatorBinding
Endpoint: https://ssl.ibanrechner.de:443/soap-12-2/index.php
SoapAction: https://ssl.ibanrechner.de/#get_swiss_banks
Style: rpc
Input:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: get_swiss_banksRequest
parts:
bank: xsd:string
user: xsd:string
password: xsd:string
Output:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: get_swiss_banksResponse
parts:
return: tns:BankResStruct
Namespace: https://ssl.ibanrechner.de/
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Returns a list of Swiss banks and their BC numbers.
Due to the large number of BC numbers, this function needs to be used in two steps:
1. If called with an empty bank name, get_swiss_banks returns a list of all names of Swiss banks, but still without BC numbers.
2. If called with one of the bank names that were obtained in step 1, the function returns all BC numbers for the given bank.
Output fields:
result: empty if everything is okay, otherwise an error message.
banks: an array of bank structs with the fields:
* name: the name of the bank.
* bic: if the function was called with a non-empty bank name, the BIC. Otherwise, this field is left empty.
* bankcode: if the function was called with a non-empty bank name as first parameter, the bankcode field contains a BC number. Otherwise, it is empty.
* address: empty.
balance: the number of remaining calculations you can do before having to recharge your account. This does not apply to customers with a subscription which includes an unlimited number of calculations.
Name: get_swiss_banks
Binding: IBAN_CalculatorBinding
Endpoint: https://ssl.ibanrechner.de:443/soap-12-2/index.php
SoapAction: https://ssl.ibanrechner.de/#get_swiss_banks
Style: rpc
Input:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: get_swiss_banksRequest
parts:
bank: xsd:string
user: xsd:string
password: xsd:string
Output:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: get_swiss_banksResponse
parts:
return: tns:BankResStruct
Namespace: https://ssl.ibanrechner.de/
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Returns a list of Swiss banks and their BC numbers.
Due to the large number of BC numbers, this function needs to be used in two steps:
1. If called with an empty bank name, get_swiss_banks returns a list of all names of Swiss banks, but still without BC numbers.
2. If called with one of the bank names that were obtained in step 1, the function returns all BC numbers for the given bank.
Output fields:
result: empty if everything is okay, otherwise an error message.
banks: an array of bank structs with the fields:
* name: the name of the bank.
* bic: if the function was called with a non-empty bank name, the BIC. Otherwise, this field is left empty.
* bankcode: if the function was called with a non-empty bank name as first parameter, the bankcode field contains a BC number. Otherwise, it is empty.
* address: empty.
balance: the number of remaining calculations you can do before having to recharge your account. This does not apply to customers with a subscription which includes an unlimited number of calculations.
Close
Name: find_bank
Binding: IBAN_CalculatorBinding
Endpoint: https://ssl.ibanrechner.de:443/soap-12-2/index.php
SoapAction: https://ssl.ibanrechner.de/#find_bank
Style: rpc
Input:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: find_bankRequest
parts:
searchterms: xsd:string
country: xsd:string
bankcode: xsd:string
maxitems: xsd:int
user: xsd:string
password: xsd:string
Output:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: find_bankResponse
parts:
return: tns:BankResStruct
Namespace: https://ssl.ibanrechner.de/
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Given some search terms (one or more words separated by space characters), optionally the country code (can be empty if all countries should be searched), optionally the bankcode (can be emtpy if the bank code is part of what the user is looking for), the maximum number of items to return, and user ID/password, returns a list of matching banks with additional information (varying by country, this information can include: national bank code, bank name, bank address, and BIC).
Output fields:
result: empty if everything is okay, otherwise an error message.
banks: an array of bank structs with the fields:
* name: the name of the bank.
* bic: the BIC.
* bankcode: the national bank code.
* address: any address data we have about the bank.
balance: the number of remaining calculations you can do before having to recharge your account. This does not apply to customers with a subscription which includes an unlimited number of calculations.
Name: find_bank
Binding: IBAN_CalculatorBinding
Endpoint: https://ssl.ibanrechner.de:443/soap-12-2/index.php
SoapAction: https://ssl.ibanrechner.de/#find_bank
Style: rpc
Input:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: find_bankRequest
parts:
searchterms: xsd:string
country: xsd:string
bankcode: xsd:string
maxitems: xsd:int
user: xsd:string
password: xsd:string
Output:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: find_bankResponse
parts:
return: tns:BankResStruct
Namespace: https://ssl.ibanrechner.de/
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Given some search terms (one or more words separated by space characters), optionally the country code (can be empty if all countries should be searched), optionally the bankcode (can be emtpy if the bank code is part of what the user is looking for), the maximum number of items to return, and user ID/password, returns a list of matching banks with additional information (varying by country, this information can include: national bank code, bank name, bank address, and BIC).
Output fields:
result: empty if everything is okay, otherwise an error message.
banks: an array of bank structs with the fields:
* name: the name of the bank.
* bic: the BIC.
* bankcode: the national bank code.
* address: any address data we have about the bank.
balance: the number of remaining calculations you can do before having to recharge your account. This does not apply to customers with a subscription which includes an unlimited number of calculations.
Close
Name: supported_countries
Binding: IBAN_CalculatorBinding
Endpoint: https://ssl.ibanrechner.de:443/soap-12-2/index.php
SoapAction: https://ssl.ibanrechner.de/#supported_countries
Style: rpc
Input:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: supported_countriesRequest
parts:
supported_condition: xsd:string
language: xsd:string
user: xsd:string
password: xsd:string
Output:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: supported_countriesResponse
parts:
return: tns:CountryResStruct
Namespace: https://ssl.ibanrechner.de/
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Input:
- a condition for what you consider 'supported'. You may build an overall condition by combining various conditions with AND, OR, and parentheses. The following conditions are available:
* IBAN: an IBAN is calculated and returned.
* unique_BIC: if a BIC code exists, it is returned. Only one BIC code is returned in this case.
* some_BICs: zero, one, or more BIC candidates may be returned. Countries which fulfil the condition 'unique_BIC' are considered to also fulfil 'some_BICs'.
* name_based_BICs: zero, one, or more BIC candidates may be returned. Unlike 'some_BICs', these may have been picked based not on one BIC/bank code directory, but by combining two directories based on the bank names, which is slightly more error-prone. Countries which fulfil the condition 'some_BICs' are considered to also fulfil 'name_based_BICs'.
* account_validated: if a checksum exists in an account number, it will be checked.
* bankcode_validated: the bank code is validated by looking it up in a table of bank codes.
If left blank, the default condition is 'IBAN AND some_BICs AND (account_validated OR bankcode_validated)'.
- language: the desired language for the human-readable list of countries which will be returned.
Returns "OK" in the "result" field if there was no error (or an error message otherwise), and a list of all supported countries both as a list of 2-digit country codes and as a list of human-readable country names.
Name: supported_countries
Binding: IBAN_CalculatorBinding
Endpoint: https://ssl.ibanrechner.de:443/soap-12-2/index.php
SoapAction: https://ssl.ibanrechner.de/#supported_countries
Style: rpc
Input:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: supported_countriesRequest
parts:
supported_condition: xsd:string
language: xsd:string
user: xsd:string
password: xsd:string
Output:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: supported_countriesResponse
parts:
return: tns:CountryResStruct
Namespace: https://ssl.ibanrechner.de/
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Input:
- a condition for what you consider 'supported'. You may build an overall condition by combining various conditions with AND, OR, and parentheses. The following conditions are available:
* IBAN: an IBAN is calculated and returned.
* unique_BIC: if a BIC code exists, it is returned. Only one BIC code is returned in this case.
* some_BICs: zero, one, or more BIC candidates may be returned. Countries which fulfil the condition 'unique_BIC' are considered to also fulfil 'some_BICs'.
* name_based_BICs: zero, one, or more BIC candidates may be returned. Unlike 'some_BICs', these may have been picked based not on one BIC/bank code directory, but by combining two directories based on the bank names, which is slightly more error-prone. Countries which fulfil the condition 'some_BICs' are considered to also fulfil 'name_based_BICs'.
* account_validated: if a checksum exists in an account number, it will be checked.
* bankcode_validated: the bank code is validated by looking it up in a table of bank codes.
If left blank, the default condition is 'IBAN AND some_BICs AND (account_validated OR bankcode_validated)'.
- language: the desired language for the human-readable list of countries which will be returned.
Returns "OK" in the "result" field if there was no error (or an error message otherwise), and a list of all supported countries both as a list of 2-digit country codes and as a list of human-readable country names.
Close
Name: country_supported
Binding: IBAN_CalculatorBinding
Endpoint: https://ssl.ibanrechner.de:443/soap-12-2/index.php
SoapAction: https://ssl.ibanrechner.de/#country_supported
Style: rpc
Input:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: country_supportedRequest
parts:
country: xsd:string
user: xsd:string
password: xsd:string
Output:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: country_supportedResponse
parts:
return: tns:CountryResStruct
Namespace: https://ssl.ibanrechner.de/
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: THIS IS A LEGACY FUNCTION. PLEASE DO NOT USE IT ANYMORE. USE supported_countries INSTEAD.
Input: a 2-digit country code (as it is used in IBANs). Returns "yes" or "no" as information about the specified country, and also a list of all supported countries as 2-digit country codes. Because you get the full list, you do not have to specify any country in the request. If you do not specify a country, this function still returns the list of all supported countries.
Name: country_supported
Binding: IBAN_CalculatorBinding
Endpoint: https://ssl.ibanrechner.de:443/soap-12-2/index.php
SoapAction: https://ssl.ibanrechner.de/#country_supported
Style: rpc
Input:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: country_supportedRequest
parts:
country: xsd:string
user: xsd:string
password: xsd:string
Output:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: country_supportedResponse
parts:
return: tns:CountryResStruct
Namespace: https://ssl.ibanrechner.de/
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: THIS IS A LEGACY FUNCTION. PLEASE DO NOT USE IT ANYMORE. USE supported_countries INSTEAD.
Input: a 2-digit country code (as it is used in IBANs). Returns "yes" or "no" as information about the specified country, and also a list of all supported countries as 2-digit country codes. Because you get the full list, you do not have to specify any country in the request. If you do not specify a country, this function still returns the list of all supported countries.
Close
Name: get_form
Binding: IBAN_CalculatorBinding
Endpoint: https://ssl.ibanrechner.de:443/soap-12-2/index.php
SoapAction: https://ssl.ibanrechner.de/#country_supported
Style: rpc
Input:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: get_formRequest
parts:
params: tns:Map
user: xsd:string
password: xsd:string
Output:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: get_formResponse
parts:
return: tns:Form
Namespace: https://ssl.ibanrechner.de/
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Input: params is an array of key-value-pairs. For the first call, it should contain something like this (in PHP notation): ("country"=>"DE", "language"=>0). The country should be given using the 2-letter notation which is also used for the IBANs. The desired language of the field labels should be given using the same numbers that you can see on iban-rechner.de when hovering over the language links on the top right (thus e. g. 0 for German).
This function returns an array of fields as well as the information whether another iteration is needed. The latter is given in the field "done" as "no" or "yes". Every field (element of the field array) has the properties:
id: an identifier.
type: hidden/text/select/submit/static for a hidden field, text edit field, drop-down box, submit button, or static text, respectively.
value: a value (possibly empty).
label: text which should be shown to the left of the field (or on it, if it happens to be a button).
optionids: an array of numerical IDs. This array has the same length as the "options" array (see below). One of these IDs should be returned if the corresponding item from the "options" array was chosen.
options: an array of strings containing the possible values for a drop-down box.
length: the maximum expected length of the value. A 0 should be interpreted as "not applicable" or "not specified".
newline: yes or no; it is suggested to place this field into the same row as the previous one if "newline" is no, and to start a new line otherwise.
If "done" is "no", this function should be called again. All fields which were returned in the previous call of get_form should be passed back to it as part of the array of key-value-pairs. For each such pair, the key should equal the "id" property of the field, and the value should equal either a user-supplied value (for editable fields) or the value which has been returned by get_form (for hidden or static fields).
If "done" is "yes", this means that now you can call the function calculate_iban; the list of returned fields now corresponds with the parameters of calculate_iban.
Name: get_form
Binding: IBAN_CalculatorBinding
Endpoint: https://ssl.ibanrechner.de:443/soap-12-2/index.php
SoapAction: https://ssl.ibanrechner.de/#country_supported
Style: rpc
Input:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: get_formRequest
parts:
params: tns:Map
user: xsd:string
password: xsd:string
Output:
use: encoded
namespace: https://ssl.ibanrechner.de/
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: get_formResponse
parts:
return: tns:Form
Namespace: https://ssl.ibanrechner.de/
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Input: params is an array of key-value-pairs. For the first call, it should contain something like this (in PHP notation): ("country"=>"DE", "language"=>0). The country should be given using the 2-letter notation which is also used for the IBANs. The desired language of the field labels should be given using the same numbers that you can see on iban-rechner.de when hovering over the language links on the top right (thus e. g. 0 for German).
This function returns an array of fields as well as the information whether another iteration is needed. The latter is given in the field "done" as "no" or "yes". Every field (element of the field array) has the properties:
id: an identifier.
type: hidden/text/select/submit/static for a hidden field, text edit field, drop-down box, submit button, or static text, respectively.
value: a value (possibly empty).
label: text which should be shown to the left of the field (or on it, if it happens to be a button).
optionids: an array of numerical IDs. This array has the same length as the "options" array (see below). One of these IDs should be returned if the corresponding item from the "options" array was chosen.
options: an array of strings containing the possible values for a drop-down box.
length: the maximum expected length of the value. A 0 should be interpreted as "not applicable" or "not specified".
newline: yes or no; it is suggested to place this field into the same row as the previous one if "newline" is no, and to start a new line otherwise.
If "done" is "no", this function should be called again. All fields which were returned in the previous call of get_form should be passed back to it as part of the array of key-value-pairs. For each such pair, the key should equal the "id" property of the field, and the value should equal either a user-supplied value (for editable fields) or the value which has been returned by get_form (for hidden or static fields).
If "done" is "yes", this means that now you can call the function calculate_iban; the list of returned fields now corresponds with the parameters of calculate_iban.