API de Validação IBAN V2



Especificação de integração da API


1. O que há de novo na API de Validação IBAN V2?


Estamos constantemente trabalhando para melhorar nossos serviços e para fornecer as melhores soluções de validação de pagamento possíveis.
Desenvolvemos uma nova versão da nossa API de Validação IBAN que possui algumas ótimas vantagens em relação a API antiga.

Aqui estão algumas das principais funcionalidades da API V2::

Flexível - Suporta o formato XML e JSON
Modular - Novas validações a nível de conta doméstica foram integradas
Melhor Estruturada - Separamos os dados bancários e validações
Códigos de Status - Códigos de status específicos foram introduzidos para facilitar a análise de erros e dos resultados de validação.





2. Recursos


A API de Validação IBAN V2 permite que você faça o seguinte:


*As validações de Código Bancário e de Número de Conta ocorrem apenas para um certo número de bancos e países.

3. Requisições da API V2


O sistema da API permite que você automatize a validação do IBAN através de uma simples requisição HTTP GET ou POST.
Os parâmetros aceitos estão listados na tabela abaixo:

Nome do Campo Comprimento Tipo Descrição
IBAN Max 100 String O IBAN que você deseja validar.
api_key 128 String Sua chave API pessoal.
format 5 String Formato da resposta em XML ou JSON.

*Para obter uma chave API, por favor, entre em contato através do contact@iban.com ou adquira uma assinatura em nossa página de vendas

EXEMPLO - Validar um IBAN
Um exemplo de uso da API de Validação com um pedido GET pode ser encontrado abaixo:

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

Onde:

Quando uma solicitação HTTP GET ou POST é feita com a chave de API correta, o sistema irá retornar os resultados no formato especificado. Você pode encontrar uma resposta de exemplo na seguinte seção “Estrutura de Resposta API”



4. Resposta da API V2


Um schema XSD da resposta da API pode ser encontrado abaixo:


  
    
      
        
          
            
              
              
              
              
              
              
              
              
              
              
              
              
              
              
            
          
        
        
          
            
              
              
              
              
              
            
          
        
        
          
            
              
                
                  
                    
                    
                  
                
              
            
          
        
        
      
    
  

Uma descrição detalhada dos campos retornados de objetos bank_data pode ser vista na tabela abaixo:
Nome do Campo Comprimento Tipo Descrição
BIC Max 11 String O código BIC do banco/agência emissora ou instituição.
BANK Max 256 String Código do Banco que identifica o banco que emitiu o IBAN
BRANCH Max 256 String Nome da agência bancária específica, se disponível
COUNTRY Max 32 String O nome completo do país de origem, por exemplo "United States"
COUNTRY_ISO 2 String Código de abreviação do país de duas letras, por exemplo, US, UK, AU, FR ... etc
CITY Max 128 String O nome da cidade de localização do banco emissor.
STATE Max 128 String O nome do estado onde o banco/agência está localizado.
ZIP Max 11 String Código postal da cidade.
ADDRESS Max 128 String O endereço do banco emissor.
Phone Max 128 String Principal contato telefônico do banco/agência.
FAX Max 128 String Principal contato via fax do banco/agência
WWW Max 128 String Site principal do banco ou da instituição atual.
EMAIL Max 128 String Principal contato de e-mail do banco/agência
ACCOUNT Max 128 String O número de conta bancária doméstica extraído do IBAN.


Uma descrição detalhada dos campos retornados de objetos sepa_data pode ser vista na tabela abaixo:
Nome do Campo Comprimento Tipo Descrição
SCT Max 3 String Se este banco suporta SEPA Credit Transfer.
SDD Max 3 String Se este banco suporta SEPA Direct Debit
COR1 Max 3 String Se este banco suporta SEPA COR1.
B2B Max 3 String Se este banco suporta SEPA Business to Business.
SCC Max 3 String Se este banco suporta SEPA Card Clearing.


Uma resposta XML de exemplo da API de uma consulta de validação IBAN seria:


	
		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 Status da API V2


A verificação matemática das validações de dígitos são devolvidas no objeto "validations"


Código de Status Tipo Descrição
301 Erro de conta Chave API é inválida
302 Erro de conta A assinatura expirou
303 Erro de conta Nenhuma query disponível
304 Erro de conta Você não tem acesso à esta API
201 Falha na Validação O dígito de verificação do Número da Conta não está correto
202 Falha na Validação O dígito de verificação do IBAN não está correto
203 Falha na Validação O comprimento do IBAN não está correto
205 Falha na Validação A estrutura do IBAN não está correta
001 Sucesso na Validação O dígito de verificação IBAN está correto
002 Sucesso na Validação O dígito de verificação do Número de Conta está correto.
003 Sucesso na Validação O comprimento do IBAN está correto
004 Sucesso na Validação O Número de Conta não suporta o dígito de verificação
005 Sucesso na Validação A estrutura do IBAN está correta