Documentazione API Validazione IBAN



Specifiche di Integrazione delle API


1. Cosa è l'API di Validazione Inversa dell'IBAN?


L'IBAN inverso è un sistema online, che fornisce alle aziende un'interfaccia in cui possono effettuare validazioni ed identificazioni dell'IBAN in tempo reale.

Queste funzioni sono disponibili in forma di moduli add-on, che ampliano le funzionalità del portale.<

L'International Bank Account Number or IBAN è un modo standardizzato per esprimere numeri di conto bancario che funziona attraverso le frontiere.

Its structure is:

<Codice Paese ISO di due lettere> + <Checksum di due cifre] + <BBAN>


BBAN è il termine usato per descrivere il formato a livello nazionale per un numero di conto bancario, che varia da paese a paese (ed è stato creato a volte solo per avere la connettività IBAN!).
Si noti che un BBAN può avere il proprio algoritmo di checksum.

IBAN offre protezione di base, utilizzando il checksum, contro errori di trascrizione (es: copia umana). Fornisce inoltre un registro dei paesi di destinazione validi e i loro formati BBAN.
Così, quando si chiede al modulo API IBAN di 'convalidare' un IBAN assicura che questi controlli vengano superati.
Tuttavia, non si può garantire che un conto in banca in realtà esista - l'unica parte che può fare ciò è la banca ricevente o il paese.



2. Caratteristiche


L'API IBAN di convalida inversa consente di eseguire le seguenti query:




3. Utilizzo delle API


Il sistema API consente di automatizzare la convalida IBAN tramite una semplice richiesta HTTP GET o POST.
I parametri accettati sono elencati nella seguente tabella:

Nome Campo Lunghezza Tipo Descrizione
IBAN Max 100 String l'IBAN che vuoi validare.
api_key 128 String La tua API key personale.

*Per ottenere una chiave API inviaci una email a contact@iban.com o il

ESEMPIO – Validare un IBAN
Un esempio d'uso delle API di convalida IBAN con una richiesta GET può essere trovato qui sotto:
https://api.iban.com/clients/api/iban-api.php?api_key=BAPI_KEY&iban=IBAN

Dove:

Una volta che viene effettuata una richiesta HTTP GET o POST con la chiave API corretta, il sistema restituirà i risultati in formato XML. È possibile trovare una risposta XML di esempio nella sezione successiva “Struttura risposta XML API”



4. Struttura risposta XML API


Uno schema XML della risposta della API può essere trovato nell'archivio documentazione.
Una descrizione dettagliata dei campi restituiti può essere visualizzata nella tabella sottostante:
Nome Campo Lunghezza Tipo Descrizione
IBAN Max 100 String L'IBAN immesso viene visualizzato.
BANK_NAME 256 String Codice banca che identifica la banca che possiede l'IBAN
SEPA 5 String Indica ce l'IBAN supporta pagamenti SEPA. Restituisce VERO o FALSO
COUNTRY 32 String Nome intero del paese di origine e.g. “Stati Uniti;
COUNTRY_CODE 2 String Abbreviazione di due lettere del codice paese e.g. US, UK, AU, FR … etc.
CITY 128 String Nome della città della banca emittente.
ADDRESS 128 String Indirizzo della banca emittente.
SWIFT 128 String Codice SWIFT della banca emittente.
VALID 5 String Vero/Falso se il checksums IBAN è corretto.

Il sistema API restituisce i risultati in formato XML, che è facile da analizzare per una moltitudine di linguaggi di programmazione e piattaforme.

Una risposta XML di esempio da API per una ricerca del codice SORT potrebbe essere:

<result>
<iban>DE08500700100094201100</iban>
<bank_name>DEUTSCHE BANK AG</bank_name>
<country>GERMANY</country>
<country_code>DE</country_code>
<city>60262 FRANKFURT AM MAIN</city>
<address>TAUNUSANLAGE 12</address>
<swift>DEUTDEFFXXX</swift>
<sepa>TRUE</sepa>
<valid>TRUE</valid>
</result>



5. API Errors


In caso di errore l'API IBAN restituisce una risposta XML che contiene il messaggio di errore.

I tag XML vengono restituiti senza altri campi nella risposta XML.

Qui di seguito potete trovare una descrizione di tutti i possibili messaggi di errore che potrebbero essere restituiti:

<error>Subscription Expired</error>
<error>Invalid API Key</error>
<error>No IBAN specified</error>