Código Sort e Número Validação de Conta do Reino Unido



Especificações da API de Validação de Conta Bancária


1. O que é a API de Cálculo IBAN?


O Código SORT reverso é um sistema online, que fornece às empresas uma interface, onde eles podem executar em tempo real a validação e identificação do código SORT..

Estas funções aparecem sob a forma de módulos addon, que expandem a funcionalidade do seu portal.

O módulo SORT adiciona o acesso ao seu portal, à nossa extensa base de dados de código SORT. Você pode aceder aos dados através duma API, e fazer pedidos automáticos, ou integrar a base de dados de identificação de SORT/BIC na sua solução de software.



2. Características


O módulo SORT fornece-lhe as seguintes funcionalidades:




3. Função da API


O sistema API permite-lhe automatizar a validação do código Sort, através dum simples pedido HTTP GET ou POST.

Na tabela abaixo estão listados os parâmetros aceites:

Nome do campo Extensão Tipo Descrição
código_sort 6 String O código sort
conta 8 String Número da conta bancária
api_key 128 String A sua chave pessoal API.
Dentro do seu Portal Online pode encontrar a sua chave de API, que é utilizada para proteger os pedidos de busca .

EXEMPLO Pedido de validação de Código Sort e Número de Conta.
Abaixo pode ser encontrado um exemplo do uso da API do código SORT com um pedido GET:

https://api.iban.com/clients/api/sort-api-v3.php?api_key=[API_KEY]&sortcode=[SORT]&account=[CONTA]

Onde:


Pode encontrar uma resposta XML exemplo na próxima seção "Estrutura de Resposta XML da API"



4. Estrutura de Resposta XML da API


Pode ser encontrado um esquema de resposta da API XML no arquivo de documentação.
Na tabela abaixo poderá ser visualizada uma descrição detalhada dos campos devolvidos::

Nome do campo Extensão Tipo Descrição
CÓDIGO_SORT 8 ou 11 String O código BIC/SORT que procura é mostrado, se está à procura por código SORT. Se procura através do nome do banco, será mostrado o código SORT do banco e da agência correspondente.
BANCO 256 String Nome do banco ou instituição financeira que te este número BIC/SORT.
AGÊNCIA 128 String Nome da agência específica para o qual o código SORT/BIC é atribuído.
PAÍS 32 String Nome completo do país de origem, ex: “Estados Unidos”
CÓDIGO_DO_PAÍS 2 String Abreviatura de duas letras do código de país, ex: US, UK, AU, FR . etc.
CIDADE 128 String nome da cidade de localização da agência bancária.
MORADA_DE_AGÊNCIA 128 String A morada atual do banco e agência.
LOCALIZAÇÃO 128 Caractere Informações de localização adicional, caso estejam disponíveis.
O sistema API dá resultados no formato XML, que é fácil de analisar em várias linguagens e plataformas de programação.

A exemplo duma resposta XML da API para uma pesquisa do código Sort seria:

<result>
<código_sort >200415</código_sort_code>
<conta>38290008</conta>
<iban>GB37BARC20041538290008</iban>
<nome_de_banco>BARCLAYS BANK PLC</nome_de_banco>
<bic_de_banco>BARCGB21</ bic_de_banco >
<agência_bancária>BARCLAYBANK B'CARD N'PTON</agência_bancária>
<bic_de_agência>08L</bic_de_agência>
<morada_de_banco>DEPT AC BARCLAYCARD HOUSE</morada_do_banco>
<cidade_do_banco>NORTHAMPTON</cidade_do_banco>
<códigopostal_do_banco>NN4 7SG</códigopostal_do_banco>
<telephone_do_banco>01604 234234 </telephone_do_banco>
<débitos_diretos>OK</débitos_diretos>
<pagamentos_pfs ></pagamentos_pfs >
<chaps>OK</chaps>
</result>



5. Erros da API


No caso de ocorrer um erro na API de SORT ela dá uma resposta XML que contém a mensagem de erro.

As XML tags são entregues sem quaisquer outros campos na resposta XML.

Abaixo, pode ver uma descrição de todas as mensagens de erro possíveis que podem ser dadas:

<error> Subscrição Expirada </error>
<error> Chave API Inválida </error>
<error>O número da conta não é válido!</error>
<error>Não foi possível encontrar o código Sort</error>
<error> Não tem mais consultas disponíveis, precisa comprar consultas adicionais.</error>