Documentación de la API de Validación de IBAN



Especificación de integración de la API


1. ¿Cuál es la API de validación inversa de IBAN


El IBAN invertido es un sistema en línea, que ofrece a las empresas una interfaz en línea donde se puede realizar la validación de IBAN en tiempo real y la identificación.

Estas funciones se presentan en forma de módulos adicionales, que amplían la funcionalidad de su portal.

El número internacional de cuenta bancaria o IBAN es una manera estandarizada de explicar un número de cuenta bancaria que funciona a través de las fronteras.

Su estructura es:

<Código de País ISO de dos letras> + <Dos Dígitos de Control] + <BBAN>


BBAN es el término utilizado para describir el formato de nivel nacional para un número de cuenta bancaria, que varía según los países (y fue creado a veces sólo para conseguir conectividad IBAN!).
Tenga en cuenta que un BBAN puede tener su propio algoritmo de control.

IBAN ofrece una protección básica, mediante la suma de control, contra los errores de transcripción (es decir: la copia humana). También proporciona un registro de los países de destino válidos y sus formatos BBAN.
Por lo tanto, cuando usted solicita al módulo IBAN de la API para "validar" un IBAN, este asegura que se pasen estas comprobaciones.
Sin embargo, no puede garantizar que realmente existe una cuenta bancaria - la única parte que puede hacer eso es el banco o país receptor.



2. Características


La API de Validación inversa de IBAN le permite hacer las siguientes consultas:




3. Uso de la API


El sistema API permite automatizar la validación de IBAN a través de una sencilla solicitud HTTP GET o POST.
Los parámetros aceptados se enumeran en la tabla siguiente:

Nombre del campo Longitud Tipo Descripción
IBAN Máximo 100 Cadena El IBAN que quieres validar
api_key 128 Cadena Tú clave personal de la API.

*Para obtener una clave de API, por favor contáctenos a contact@iban.com

Ejemplo - Validar un IBAN
Un ejemplo de uso de la API de Validación de IBAN con una petición GET se puede encontrar a continuación:
https://api.iban.com/clients/api/iban-api.php?api_key=BAPI_KEY&iban=IBAN

Donde:

Una vez que una solicitud HTTP GET o POST se realiza con una clave de la API correcta, el sistema devolverá los resultados en un formato XML. Usted puede encontrar una respuesta XML de ejemplo en la siguiente sección “Estructura de la Respuesta XML de la API”



4. Estructura de la Respuesta XML de la API


Un esquema XML de la respuesta de la API se puede encontrar en el archivo de documentación.
Una descripción detallada de los campos devuelto se puede ver en la tabla siguiente:
Nombre del campo Longitud Tipo Descripción
IBAN Máximo 100 Cadena El IBAN que has enviado se muestra.
NOMBRE_BANCO 256 Cadena Código de Banco identificando el banco que posee el IBAN
SEPA 5 Cadena Indicador si este IBAN admite pagos SEPA. Valores Verdadero o Falso
PAÍS 32 Cadena Nombre completo del país de origen e.g. “Estados Unidos”
COUNTRY_CODE 2 Cadena Abreviatura de dos letras del código de país e.g. US, UK, AU, FR … etc.
CIUDAD 128 Cadena El nombre de la ciudad de la ubicación del banco emisor.
DIRECCIÓN 128 Cadena La dirección del banco emisor.
SWIFT 128 Cadena El código SWIFT banco emisor.
VÁLIDO 5 Cadena Verdadero/Falso resulta si las sumas de comprobación IBAN son correctos.

El sistema de la API devuelve los resultados en formato XML, que es fácil de analizar en una variedad de lenguajes y plataformas de programación.

Una respuesta XML de ejemplo de la API para una consulta de validación IBAN sería:

<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. Errores de la API


En caso de un error, la API del IBAN devuelve una respuesta XML que contiene el mensaje de error.

El <error></error> etiquetas XML de error se devuelven sin otros campos en la respuesta XML.

A continuación puede encontrar una descripción de todos los mensajes de error posibles que podrían ser devueltos:

<error>Suscripción Expirada</error>
<error>Clave de API no válida</error>
<error>No IBAN especificado</error>