Documentation de l'API de la Validation IBAN



specification de l'intégration de l'API


1. Quel est l'API de Validation IBAN inversée?


IBAN inversé est un système en ligne qui offre aux entreprises une interface en ligne où ils peuvent performer l'identification et la validation IBAN en temps réel.

Ces fonctions se présentent sous la forme de modules, qui étendent les fonctionnalités de votre portail.

Le numero de compte bancaire international ou l'IBAN est une méthode standardisée d'expliquer un numéro de compte bancaire qui fonctionne au-delà des frontières.

Sa structure est:

<Code de pays ISO à deux lettres> + <Somme de contrôle à deux chiffres] + <BBAN>


BBAN est le terme utilisé pour décrire le format au niveau national pour un numéro de compte bancaire, qui varie selon les pays (et a parfois créé juste pour obtenir la connectivité IBAN!).
Notez qu'un BBAN peut avoir son propre algorithme de checksum.

IBAN fournit une protection de base, à l'aide de la somme de contrôle, contre les erreurs de transcription (c'est à dire: reproduction humaine). Il fournit également un registre des pays de destination valide et leurs formats BBAN.
Ainsi, lorsque vous demandez le module API IBAN pour 'valider' un IBAN il s'assure que ces contrôles sont passés.
Toutefois, il ne peut pas assurer qu'il existe réellement un compte bancaire - le seul parti qui peut faire qui est la banque ou le pays.



2. Caractéristiques


L'API de Validation IBAN inversé vous permet d'effectuer les requêtes suivantes:




3. Usage de l'API


Le système d'API vous permet d'automatiser la validation de l'IBAN via un HTTP GET ou simplement une requête POST.
Les paramètres acceptés sont listés dans le tableau ci-dessous:
Nom de champ longueur type Description
IBAN Max 100 String l'IBAN que vous voulez valider.
api_key 128 String Votre clé API personnelle.

*Pour obtenir une clé API, veuillez nous contacter contact@iban.com ou le

EXAMPLE – Validater un IBAN
Un exemple d'utilisation de l'API de Validation IBAN avec une demande GET se trouvent ci-dessous:
https://api.iban.com/clients/api/iban-api.php?api_key=BAPI_KEY&iban=IBAN

Où:

Une fois qu'une requête HTTP GET ou POST est faite avec la bonne clé API, le système renvoie les résultats au format XML. Vous pouvez trouver un exemple de réponse XML dans la section suivante « API XML Structure d'intervention »



4. API XML Structure d'intervention


Un schéma XML de la réponse de l'API se trouvent dans les Archives de documentation.
Une description détaillée des champs retourné peut être vu dans le tableau ci-dessous :
nom de domaine longueur type Description
IBAN Max 100 String l'IBAN que vous avez présenté s'affiche.
BANK_NAME 256 String Le code de la banque identifiant la Banque détenante de l'IBAN
SEPA 5 String Indicateur si les paiements SEPA de ce soutien IBAN. Valeurs vrai ou fausse
COUNTRY 32 String Nom complet du pays d'origine par exemple & ldquo; États-Unis & rdquo;
COUNTRY_CODE 2 String abréviation de deux lettres du code de pays par exemple, US,UK,UA,FR-A € |. Etc
CITY 128 String Le nom de la ville de la banque émettrice & rsquo;. situation s
ADDRESS 128 String L'adresse de la banque émettrice.
SWIFT 128 String Code SWIFT de la banque émettrice.
VALID 5 String Vrai/Faux Résultat si les checksums IBAN sont corrects.

Le système API renvoie les résultats au format XML, ce qui est facile à analyser dans une variété de plates-formes et de langages de programmation.

Une réponse simple XML de l'API pour une requête de validation IBAN :

<result>
<iban>DE08500700100094201100</iban>
<bank_name>DEUTSCHE BANK AG</bank_name>
<country>GERMANY</country>
<country_code>DE</country_code>
<city>60262 FRANKFURT AM MAIN</city>
<address>TAUNUSANLAGE 12</address>
<swift>DEUTDEFFXXX</swift>
<sepa>TRUE</sepa>
<valid>TRUE</valid>
</result>



5. API Errors


En cas d'erreur l'IBAN API retourne une réponse XML contenant 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 toute erreur possible des messages qui pourraient être retournée :

<error>Subscription Expired</error>
<error>Invalid API Key</error>
<error>No IBAN specified</error>