Especificaciones de integración del API

1. ¿Qué hace el API de recuperación de IBAN?

Este API proporciona la funcionalidad única de recuperar hasta dos caracteres desconocidos de cualquier número de cuenta bancaria internacional.
Esta función se puede utilizar en los casos en que algunas partes del IBAN son ilegibles o cuando se valida la entrada del usuario.
El sistema considera el formato y la longitud específicos del país para asegurar que se produzca la mínima cantidad de sugerencias. Todas las posibles permutaciones de dígitos y letras de acuerdo con el esquema de formateo internacional se prueban con el algoritmo de dígitos de verificación modulust.
Casos de uso:

- Caracteres ilegibles: al digitalizar IBAN desde soportes de papel, es posible que la impresión degradada produzca caracteres ilegibles. Nuestro sistema le permite colocar un signo de interrogación "?" en el lugar de los caracteres desconocidos. Nuestro motor de validación genera entonces todas las combinaciones válidas posibles para ese IBAN.

- Suposiciones con fundamento: si tiene un IBAN inválido, puede hacer una estimación fundamentada de las posiciones en las que se pudo producir el error realizando múltiples intentos de recuperación con marcadores de comodín "?" en diferentes posiciones.

2. Características

El API de recuperación de IBAN le permite lo siguiente:

• Obtener una lista de IBAN válidos que sugieren la posible variante correcta.
• Extraer el código bancario local a partir del IBAN original enviado.
• Extraer el código de sucursal local a partir del IBAN original enviado.
• Extraer el número de cuenta local a partir del IBAN original enviado.

3. Solicitudes de API de recuperación

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

Nombre de campo	Longitud	Tipo	Descripción
IBAN	Máx. 100	Cadena	El IBAN enmascarado que desea validar. Utilice "?" (signo de interrogación) en lugar del carácter desconocido. Por ejemplo: DE79850?0300310018056?
api_key	128	Cadena	Su llave API personal.
format	5	Cadena	Formato de la respuesta XML y JSON admitida.

*Para obtener una llave API, póngase en contacto con nosotros mediante contact@iban.com o compre una suscripción en nuestra página de pedidos

EJEMPLO: recuperación de un IBAN
A continuación se muestra un ejemplo de uso del API de validación IBAN con una solicitud GET:

https://api.iban.com/clients/api/recover-iban.php?api_key=key&format=xml&iban=IBAN

En donde:

• key es su llave API
• IBAN enviado para su validación por el módulo API. Ejemplo: CH8?0853410203475000?
• xml es el formato de respuesta. También se puede especificar una palabra clave json para obtener una respuesta formateada en json.

Una vez que se realiza una petición HTTP GET o POST con la clave API correcta, el sistema devolverá los resultados en el formato especificado. Puede encontrar una respuesta de ejemplo en la siguiente sección "Estructura de respuesta del API".

4. Respuesta de la API de recuperación

A continuación se muestra un esquema XSD de la respuesta del API:

En la siguiente tabla puede ver una descripción detallada de los campos de objeto format_data devueltos:

Nombre del campo	Longitud	Tipo	Descripción
country	Máx. 2	Cadena	El código ISO de 2 letras del país.
iban_length	Máx. 2	Entero	La longitud exacta de todos los IBAN para este país.
format_template	Máx. 2	Cadena	Una plantilla con la longitud exacta del IBAN que muestra los diferentes caracteres dentro de cada posición. C = Mixto (Alfabeto + 0-9), A = Carácter (alfabético), N = Dígito (0-9).
bank_code	Máx. 99	Cadena	El código de identificación del banco local para este IBAN.
branch_code	Máx. 99	Cadena	El código de sucursal local para este IBAN.
account_number	Máx. 99	Cadena	El número de cuenta local para este IBAN.

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

	
		CH
		21
		CCNNNNNNNCCCCCCCCCCCC
		85341
		
		0203475000
	
	
		CH810853410203475000K
		CH860853410203475000R
		CH8908534102034750002
	
	

5. Códigos de estado del API de recuperación

El API de recuperación de IBAN devuelve los siguientes códigos de error

Código de estado	Tipo	Descripción
301	Error de cuenta	Llave API inválida
302	Error de cuenta	Subscripción expirada
303	Error de cuenta	No hay consultas disponibles
304	Error de cuenta	No tiene acceso a este API
401	Error de entrada	Faltan campos obligatorios.
402	Error de entrada	Demasiados comodines. Se permite un máximo de dos comodines.
403	Error de entrada	Muy pocos comodines. Se requiere un mínimo de un comodín.