Calcul des IBAN Documentation de l'API



Guide d'intergration API


1. C'est quoi le calcul des IBAN API?


Le calcul de l'IBAN (AKA IBAN Conversion) est un logiciel qui permet à nos clients de convertir des combinaisons de nombre code et de compte bancaire en des numéros de compte bancaire International validés (IBAN).

Le système permet à nos clients interface manuelle ainsi qu'une API pour permettre l'intégration dans leurs systèmes internes de l'entreprise.

Le système identifie aussi les banques et les institutions financières et fournit des détails pour nos clients.



2. Caractéristiques


Voici quelques-unes des principales caractéristiques de notre moteur de calcul de l'IBAN:




3. Pays pris en charge


Le calcul API de l'IBAN supporte actuellement les pays suivants et les champs requis par notre API pour calculer un IBAN.

Code du pays nom du pays code Direction générale de la compte chiffre de contrôle
AT Autriche Oui   Oui  
BE Belgique Oui   Oui Oui
CH Suisse Oui   Oui  
DE Deutschland Oui   Oui  
EE Estonie     Oui  
ES Espagne Oui Oui Oui Oui
FI Finlande     Oui Oui
FR France Oui Oui Oui Oui
GB la Grande-Bretagne Oui   Oui Oui
HU Hongrie     Oui Oui
IE Irlande Oui   Oui Oui
IT Italie Oui Oui Oui Oui
MC Monaco Oui Oui Oui Oui
MU Mauritanie Oui Oui Oui  
MT Malte Oui   Oui  
NO la Norvège     Oui Oui
PT Portugal Oui Oui Oui Oui
SE Suède Oui   Oui  
SM San Marino Oui Oui Oui  
CZ République tchèque Oui   Oui Oui
AL Albanie Oui   Oui  
SK République slovaque Oui   Oui Oui
SI Slovénie Oui   Oui Oui
PL Pologne Oui   Oui Oui
SE Suède Oui   Oui Oui
NL Netherlandds Oui Oui
La colonne de chiffre de contrôle spécifie si le pays prend en charge le numero de compte et/ou les codes de validation bancaire.

La validation de chiffres de contrôle est une couche supplémentaire de protection de l'intégrité des données contre les fautes de frappe.



4. Entrées de l'API


L'API accepte à la fois HTTP GET et POST demande de données d'entrée.
Les paramètres acceptés sont listés dans le tableau ci-dessous:

Nom du champs Type Description
api_key String Votre clé API personnelle. Obtenu dans la zone client.
format String Format de reponse API ( xml or json )
country String 2 letter country code ( UK/US/DE/FR )
bankcode String Un identificateur unique de la Banque. Différentes pour chaque pays. (facultafif). Certains pays n'exigent que le numéro de compte.
branch String Un identifiant unique pour les agences locale unique ( facultafif )
account String Numero de compte personnel
cd Integer Chiffre de contrôle utilisés dans certains pays
prefix Integer Actuellement requis uniquement en République tchèque (facultatif)
Le premier argument est la clé API, il s'agit d'une chaîne unique qui permet à notre système de vous identifier en tant qu'utilisateur et permettre l'accès à l'API.

L'API prend en charge les formats de réponses multiples dans le but de fournir une intégration plus facile. Actuellement, XML et JSON sont pris en charge.

Les arguments de pays doivent être constitués d'un code de pays ISO à 2 lettres comme Uk pour le Royaume-Uni, DE pour l'Allemagne, FR pour la France …
Le code de la banque a une longueur différente et une structure pour chaque pays.

Le code de l'agence est un argument optionnel est nécessaire que pour certains pays (voir les exemples)
Le numéro de compte est nécessaire pour tous les pays et dans certains cas, il est le seul paramètre utilisé pour calculer l'IBAN.

Les chiffres de contrôle sont requis uniquement pour certains pays qui ont intégré ces algorithmes de validation dans leur structure de numéro national de compte bancaire. (voir exemples)

Préfix est un champ éventuellement nécessaire uniquement pour le calcul de l'IBAN en République tchèque.



5. Exemples d'API


Dans le tableau ci-dessous vous pouvez trouver l'exemple de requête GET à notre API pour chaque pays.

Pays Exemple requête (requête GET)
AT ?country=AT&format=json&bankcode=12000&account=52700357958
BE ?country=BE&format=json&bankcode=250&account=0135106&cd=70
CH ?country=CH&format=json&bankcode=0240&account=240C08011570
DE ?country=DE&format=json&bankcode=BLZ37010050&account=399509
EE ?country=EE&format=json&account=55000005511439
ES ?country=ES&format=json&bankcode=0081&branch=1731&cd=91&account=0006040912
FI ?country=FI&format=json&account=52900261901092
FR ?country=FR&format=json&bankcode=30056&branch=00264&account=02640016443
GB ?country=GB&format=json&bankcode=090127&account=93496333
HU ?country=HU&format=json&account=107000240416330551100005
IE ?country=IE&format=json&bankcode=905838&account=71924374
IT ?country=IT&format=json&country=IT&bankcode=02008&branch=30545&account=000103685854
MC ?country=MC&format=json&country=MC&bankcode=30002&branch=03260&account=0000079112A
MR ?country=MR&format=json&bankcode=00012&branch=00001&account=00000078326
MT ?country=MT&format=json&bankcode=07113&account=199008240010
NO ?country=NO&format=json&account=96803502045
PT ?country=PT&format=json&bankcode=0038&branch=0000&cd=81&account=39551148771
SE ?country=SE&format=json&bankcode=9150&account=0092395696
SM ?country=SM&format=json&country=SM&bankcode=03034&branch=09800&account=000060164676
CZ ?country=CZ&format=json&prefix=51&account=1707230277&bankcode=0100
AL ?country=AL&format=json&bankcode=20511117&account=374362CLPRCFEURC
SK ?country=SK&format=json&prefix=&account=4110053902&bankcode=3100
SI ?country=SI&format=json&bankcode=33000&account=0000102423
PL ?country=PL&format=xml&bankcode=11402004&account=0000360275244226
SE ?country=SE&format=json&bankcode=9300&account=5913222524
NL ?country=NL&format=json&account=0006642318




6. Structure de réponse d'API XML


Une description détaillée des champs possibles retournée peut être vu dans le tableau ci-dessous:

Nom du champs Type Description
address String l'adresse de l'agence bancaire ou du siège social
bank String Nom de la banque ou de l'institution financière
bic String BIC ( Bank Identifier Code ) de la banque
branch String Nom de l'agence identifiée pas le code bancaire
city String Nom de la ville où est localisée l'agence.
country String Deux lettre d'abbreviation du code de pays e.g. US, UK, AU, FR … etc.
email String Adresse Email désignée pour le contact de la banque ou de l'agence
fax String Numero de fax de la banque/agence
phone String Numero de telephone de contact de la banque / agence
state String État de la banque / adresse de l'agence
website String Le site web de la banque / agence
zip String code ZIP ou code Postal de l'adresse de l'agence de la Banque
Le système API renvoie les résultats au format XML ou JSON, ce qui est facile à analyser dans une variété de plates-formes et langages de programmation.

Un exemple de code XML réponse de l'API pour un code de tri de UK et recherche de numéro de compte serait :

URL de la requête :

?api_key=9834hAHx78ba4g8habsdk&Pays=GB&format=json&bankcode=110377&compte=10218962

<result>
<iban>GB20ULSB98006054100029</iban>
<account>54100029</account>
<sort_code>980060</sort_code>
<bank>ULSTER BANK LTD</bank>
<branch>BELFAST CITY OFFICE 1</branch>
<bic>ULSBGB2BXXX</bic>
<address>PO BOX 232 11-16 DONEGALL SQUARE EAST </address>
<city>BT1 5UB</city>
<country>GB<country/>
<phone>028 90244112</phone>
</result>

La réponse pour la même requête si l'utilisateur a spécifié un formatage JSON sera:

"iban":"GB20ULSB98006054100029","account":"54100029","sort_code":"980060","bank":"ULSTER BANK LTD","branch":"BELFAST CITY OFFICE 1","bic":"ULSBGB2BXXX","address":"PO BOX 232 11-16 DONEGALL SQUARE EAST ","city":"BT1 5UB","country":"GB","phone":"028 90244112"



7. Erreur API


En cas d'erreur, l'API de calcul IBAN retourne une réponse XML ou JSON qui contient le message d'erreur.
<error></error > balises XML sont retournés sans tous les autres champs dans la réponse XML.
Ci-dessous vous pouvez trouver une description de tout les messages d'erreur possible qui pourraient être retournée :

<error>Numéro de compte (checksum) est invalide.</error>
<error>Numéro de compte (checksum) n'est pas correct.</error>
<error>Le numéro de compte doit être de 11 caractères</error>
<error>Le numéro de compte doit être de 14 caractères</error>
<error>Le numéro de compte doit être de 24 caractères</error>
<error>Le numero de compte n'est pas valide</error>
<error>Numéro de compte de Code de tri n'est pas valide</error>
<error>Le numero de compte prefix est trop long.</error>
<error>Le numero de compte est trop long.</error>
<error>Bank/Branch Code / KIB (checksum) n'est pas correct.</error>
<error>Code de la banque/ Code de l'agence/ numero de compte trop long.</error>
<error>Code de la banque/ Code de l'agence(checksum) n'est pas correct.</error>
<error>Code de la banque n'est pas valide</error>
<error>Code la banque trop long.</error>
<error>Banque non trouvé</error>
<error>Banque non reconnue</error>
<error>BBAN / NIB (checksum) n'est pas correct.</error>
<error>BLZ/ Code de la banque non valide</error>
<error>Agence/Agencia non trouvé</error>
<error>Code de l'agence trop long.</error>
<error>Agence non trouvée</error>
<error>Chiffre de contrôle trop long.</error>
<error>Clearingnummer / compte Nombre non valide. Check digit incorrect.</error>
<error>Clearingnummer / BankCode non identifiés. IBAN ne peut pas être calculé.</error>
<error>Clearingnummer ou numero de compte trop long.</error>
<error>Codice ABI della Banca/Code de la banque non valide</error>
<error>Codice CAB della Filiale/Code de l'agence non valide</error>
<error>Code du pays non valide</error>
<error>Pays ou banque non pris en charge</error>
<error>IBAN n'est pas valide</error>
<error>Kontonummer/numero de compte non valide</error>
<error>champs manquants</error>
<error>Non FR IBAN</error>
<error>Non FR IBAN country</error>
<error> champs requis manquants. veuillez entrer le code de votre banque et votre numero de compte</error>
<error>Champs requis non présenté.</error>
<error>RIB non valide</error>
<error>Code de tri / Code de la banque non identifié. IBAN ne peut pas être calculée.</error>
<error>Code de tri non trouvé</error>