Documentación de la API de recuperación de carácter IBAN



Especificación de integración API


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


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

- Caracteres ilegibles - Cuando la digitalización de los portadores de papel IBAN es posible para la impresión degradada para producir caracteres ilegibles. Nuestro sistema le permite colocar un signo de interrogación "?" en lugar de los caracteres desconocidos. Nuestro motor de validación genera todas las posibles combinaciones válidas para este IBAN.
- Invitado educado - Si tiene un código IBAN no válido, puede hacer conjeturas sobre que posiciones puede estar el error ser mediante la ejecución de múltiples intentos de recuperación con marcadores comodín "?" en diferentes posiciones.





2. Características


La API IBAN recuperación le permite hacer lo siguiente:




3. Solicitudes del API de recuperación


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

Nombre del campo Longitud Tipo Descripción
IBAN Max 100 String El IBAN enmascarado que desea validar. Utilizar "?" (Signo de interrogación) en lugar del carácter desconocido. Por ejemplo: DE79850?0300310018056?
api_key 128 String Su clave de API personal.
format 5 String Formato compatible de la respuesta XML y JSON.

* Para obtener una clave de API, por favor, póngase en contacto con nosotros en contact@iban.com o adquiera una suscripción en nuestra página de pedidos

Ejemplo - Recuperar un IBAN
Un ejemplo de uso de la API de Validación IBAN con una petición GET se puede encontrar a continuación:

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

Dónde:

Una vez que una solicitud HTTP GET o POST se hace con la clave de API correcta, el sistema devolverá los resultados en el formato especificado. Usted puede encontrar una respuesta de la muestra en la siguiente sección "Estructura de respuesta de la API"



4. Respuesta de la API de recuperación


Un esquema XSD de la respuesta de la API se puede encontrar a continuación:


  
    
      
        
          
            
              
              
              
              
              
              
            
          
        
        
          
            
              
            
          
        
        
      
    
  


Una descripción detallada de los campos del objeto format_data devueltos puede verse en la tabla siguiente:
Nombre del campo Longitud Tipo Descripción
country Max 2 String Las 2 letras del código ISO del país.
iban_length Max 2 Integer La longitud exacta de todos los IBAN para este país.
format_template Max 2 String Una plantilla con la longitud exacta del IBAN mostrando los diferentes personajes en el interior por posiciones. C = mixto (Alfabeto + 0-9), A = Carácter (alfabética), N = dígito (0-9).
bank_code Max 99 String El código de identificación del banco local para este IBAN.
branch_code Max 99 String El identificador de sucursal local de este IBAN.
account_number Max 99 String El número de cuenta bancaria local para este IBAN.


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



	
		CH
		21
		CCNNNNNNNCCCCCCCCCCCC
		85341
		
		0203475000
	
	
		CH810853410203475000K
		CH860853410203475000R
		CH8908534102034750002
	
	






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


La API de recuperación IBAN devuelve los siguientes códigos de error.
Código de estado Tipo Descripción
301 Error cuenta Clave API no es válida
302 Error cuenta Suscripción vencida
303 Error cuenta No hay consultas disponibles
304 Error cuenta Usted no tiene acceso a esta API
401 Error de entrada Campos necesarios que faltan.
402 Error de entrada Demasiados comodines. Máximo de dos comodines permitido.
403 Error de entrada Muy pocos comodines. Se requiere un mínimo de uno comodines.