Validación de IBAN Documentación API V2



Especificación para integración de API


1. ¿Qué hay de nuevo en la API V2 de Validación IBAN?


Estamos trabajando constantemente para mejorar nuestros servicios y para ofrecer mejores soluciones de validación de pago.
Hemos desarrollado una nueva versión de la API de Validación IBAN que tiene algunas ventajas importantes sobre la antigua API.

Estas son algunas de las características clave de la versión 2 del API:

Flexible - soporta el formato XML y JSON
Modular - Se han integrado nuevas validaciones internas a nivel de cuenta
Mejor Estructurada - Hemos separado los datos bancarios y las validaciones
Códigos de estado - Códigos de estado específicos se han introducido para facilitar el análisis de errores y resultados de la validación.





2. Caracteristicas


El API V2 de Validación IBAN te permite hacer lo siguiente::


* Las validaciones del código de banco y número de cuenta pueden ser solamente para ciertos bancos y países.

3. Solicitudes del API V2


El sistema API permite automatizar la validación de 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 que desea validar.
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 adquiere una suscripción desde nuestra página de pedidos

Ejemplo - Validar 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/ibanv2.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 muestra de la respuesta en la siguiente sección "Estructura de respuesta de la API



4. Respuesta V2 API


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


  
    
      
        
          
            
              
              
              
              
              
              
              
              
              
              
              
              
              
              
            
          
        
        
          
            
              
              
              
              
              
            
          
        
        
          
            
              
                
                  
                    
                    
                  
                
              
            
          
        
        
      
    
  

Una descripción detallada de los campos devueltos del objeto bank_data puede verse en la tabla siguiente:
Nombre del campo Longitud Tipo Descripción
BIC Max 11 String El código BIC del banco/sucursal o entidad emisora.
BANK Max 256 String Código bancario que identifica al banco que emitió el IBAN
BRANCH Max 256 String Nombre de la sucursal bancaria específica, si está disponible
COUNTRY Max 32 String Nombre completo del país de origen, por ejemplo "Estados Unidos"
COUNTRY_ISO 2 String Abreviatura de dos letras del código de país, por ejemplo US, UK, AU, FR ... etc.
CITY Max 128 String Nombre de la ciudad de la ubicación del banco emisor.
STATE Max 128 String Nombre de la ciudad de la ubicación del banco emisor.
ZIP Max 11 String Código postal de la ciudad.
ADDRESS Max 128 String La dirección del banco emisor.
Phone Max 128 String Teléfono primario de contacto del banco/sucursal.
FAX Max 128 String Número principal de fax para el banco actual / rama.
WWW Max 128 String Sitio web principal para el banco o institución actual.
EMAIL Max 128 String Correo electrónico principal de contacto para el banco/sucursal actual.
ACCOUNT Max 128 String El número de cuenta bancaria doméstico extraída del IBAN.


Una descripción detallada de los campos devueltos del objeto sepa_data se puede ver en la siguiente tabla:
Nombre del campo Longitud Tipo Descripción
SCT Max 3 String Ya sea que este banco soporte transferencias SEPA.
SDD Max 3 String Ya sea que este banco soporte Débito Directo SEPA.
COR1 Max 3 String Ya sea que este banco sea compatible con SEPA COR 1.
B2B Max 3 String Ya sea que este banco soporte SEPA de empresa a empresa.
SCC Max 3 String Ya sea que este banco soporte Compensación de tarjeta SEPA.


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


	
		BARCGB22
		CHELTENHAM
		BARCLAYS BANK PLC
		
Leicester LE87 2BB 0345 7345345 United Kingdom GB 30093459
YES YES YES YES NO 002 Account Number check digit is correct 001 IBAN Check digit is correct 005 IBAN structure is correct 003 IBAN Length is correct




5. Códigos de estado del API V2


Validaciones matemáticas del dígito de verificación son devueltas en el objeto "validations"


Código de estado Tipo Descripción
301 Error de cuenta La clave API no es válida
302 Error de cuenta Suscripción vencida
303 Error de cuenta No hay consultas disponibles
304 Error de cuenta Usted no tiene acceso a esta API
201 Validación fallida El Dígito de verificación del número de cuenta no es correcto
202 Validación fallida El dígito de verificación IBAN no es correcto
203 Validación fallida La longitud IBAN no es correcta
205 Validación fallida La estructura IBAN no es correcta
001 Éxito en validación IBAN Dígito de verificación es correcto
002 Éxito en validación Dígito de verificación del número de cuenta es correcto
003 Éxito en validación La longitud IBAN es correcta
004 Éxito en validación El número de cuenta no es compatible con el dígito de verificación
005 Éxito en validación La estructura IBAN es correcta