IBAN Calculati API Documentatie

Deze API is onderdeel van onze IBAN Suite service

API integratiegids

1. Wat is de IBAN-berekening API?

De IBAN-berekening (AKA IBAN Conversion) -engine is een softwaresysteem waarmee onze klanten binnenlandse bankcode- en rekeningnummercombinaties kunnen converteren naar gevalideerde International Bank Account Numbers (IBAN).

Het systeem biedt de handmatige interface van onze klanten en een API om integratie in de interne systemen van hun bedrijf mogelijk te maken.

Het systeem identificeert ook de banken en financiële instellingen en verstrekt de details aan onze klanten.

2. Eigenschappen

Hieronder staan enkele van de belangrijkste kenmerken van onze IBAN-berekeningsengine:

Valideert de lokale bankcode / rekeningnummercontrolesommen (* zie ondersteunde landen)
Informatie ophalen over de bank op basis van de lokale bank / filiaalcode.
Genereert automatisch een geldig IBAN-formaat voor de opgegeven bank- / filiaalcode en rekeningnummer
Systeem ondersteunt meerdere responsopmaak (JSON / XML)

3. Ondersteunde Landen

De IBAN-berekenings-API ondersteunt momenteel de volgende landen en de velden die onze API vereist om een IBAN te berekenen.

Landcode	Landnaam	bankcode	Branch	Rekening	Controleer cijfer **
AT	Oostenrijk	YES		YES
BE	België	JA		JA	JA
CH	Zwitserland	JA		JA
DE	Duitsland	JA		JA
EE	Estland			JA
EG	Egypt	YES	YES	YES
ES	Spanje	JA	JA	JA	JA
FI	Finland			JA	JA
FR	Frankrijk	JA	JA	JA	JA
GB	Groot Brittanie	JA		JA	JA
HU	Hongarije			JA	JA
IE	Ierland	JA		JA	JA
IT	Italie	JA	JA	JA	JA
MC	Monaco	JA	JA	JA	JA
MR	Mauritanie	JA	JA	JA
MT	Malta	JA		JA
NO	Noorwegen			JA	JA
PT	Portugal	JA	JA	JA	JA
SM	San Marino	JA	JA	JA
CZ	Tjechie	JA		JA	JA
AL	Albanie	JA		JA
SK	Slowakije	JA		JA	JA
SI	Slovenie	JA		JA	JA
PL	Polen	JA		JA	JA
PK	Pakistan	JA		JA
SE	Zweden	JA		JA	JAS
NL	Nederland			JA	JA

De kolom Controlecijfer geeft aan of het land accountnummer en / of cijfercontrole voor bankcodes ondersteunt.

De controle cijfers validatie is een extra laag van data-integriteitsbescherming tegen typefouten.

4. API Input

De API accepteert zowel HTTP GET- als POST-aanvraag voor invoergegevens.
De geaccepteerde parameters worden weergegeven in de onderstaande tabel:

Veldnaam	Type	Beschrijving
api_key	String	Uw persoonlijke API-sleutel. Verkregen in het klantengedeelte.
formaat	String	API-antwoordformaat (xml of json)
country	String	2-letterige landcode (VK / VS / DE / FR)
bankcode	String	Een unieke bankidentificatiecode. Anders voor elk land. (optioneel). Sommige landen hebben alleen een accountnummer nodig.
branch	String	Een uniek lokaal filiaal-ID (optioneel)
account	String	Persoonlijk accountnummer
cd	Integer	Controleer de cijfers die in sommige landen worden gebruikt.
prefix	Integer	Momenteel alleen vereist voor Tsjechië (optioneel)

Eerste argument is de API-sleutel, dit is een unieke tekenreeks waarmee ons systeem u als gebruiker kan identificeren en u toegang tot de API kan verlenen.

De API ondersteunt meerdere responsformaten om een eenvoudigere integratie te bieden. Momenteel worden XML en JSON ondersteund.

De argumenten voor het land moeten bestaan uit een 2-letterige ISO-landcode, zoals VK voor het Verenigd Koninkrijk, DE voor Duitsland, FR voor Frankrijk ...
Bankcode heeft verschillende lengtes en structuren voor elk land.

De filiaalcode is een optioneel argument en is alleen vereist voor sommige landen (zie Voorbeelden)
Het rekeningnummer is verplicht voor alle landen en in sommige gevallen is dit de enige parameter die wordt gebruikt om een IBAN te berekenen.

Controlecijfers zijnalleen vereist voor bepaalde landen die dergelijke validatie-algoritmen hebben opgenomen in hun nationale bankrekeningnummerstructuur. (zie Voorbeelden)

Prefix is een veld dat optioneel alleen voor de IBAN-berekening in de Tsjechische Republiek vereist is.

5. API Voorbeelden

In de onderstaande tabel kunt u de voorbeeldwerk-GET-query vinden voor onze API voor elk land.

Country	Example query (GET REQUEST)
AT	?country=AT&format=json&bankcode=12000&account=52700357958
BE	?country=BE&format=json&bankcode=250&account=0135106&cd=70
CH	?country=CH&format=json&bankcode=0240&account=240C08011570
DE	?country=DE&format=json&bankcode=BLZ37010050&account=399509
EE	?country=EE&format=json&account=55000005511439
ES	?country=ES&format=json&bankcode=0081&branch=1731&cd=91&account=0006040912
FI	?country=FI&format=json&account=52900261901092
FR	?country=FR&format=json&bankcode=30056&branch=00264&account=02640016443
GB	?country=GB&format=json&bankcode=090127&account=93496333
HU	?country=HU&format=json&account=107000240416330551100005
IE	?country=IE&format=json&bankcode=905838&account=71924374
IT	?country=IT&format=json&country=IT&bankcode=02008&branch=30545&account=000103685854
MC	?country=MC&format=json&country=MC&bankcode=30002&branch=03260&account=0000079112A
MR	?country=MR&format=json&bankcode=00012&branch=00001&account=00000078326
MT	?country=MT&format=json&bankcode=07113&account=199008240010
NO	?country=NO&format=json&account=96803502045
PT	?country=PT&format=json&bankcode=0038&branch=0000&cd=81&account=39551148771
PK	?country=PK&format=json&bankcode=HABBPKKA&account=39551148771
SE	?country=SE&format=json&bankcode=9150&account=0092395696
SM	?country=SM&format=json&country=SM&bankcode=03034&branch=09800&account=000060164676
CZ	?country=CZ&format=json&prefix=51&account=1707230277&bankcode=0100
AL	?country=AL&format=json&bankcode=20511117&account=374362CLPRCFEURC
SK	?country=SK&format=json&prefix=&account=4110053902&bankcode=3100
SI	?country=SI&format=json&bankcode=33000&account=0000102423
PL	?country=PL&format=xml&bankcode=11402004&account=0000360275244226
SE	?country=SE&format=json&bankcode=9300&account=5913222524
NL	?country=NL&format=json&account=0006642318

6. API XML Respons Structuur

Een gedetailleerde beschrijving van de mogelijke velden die worden geretourneerd, is te zien in de onderstaande tabel:

Veldnaam	Type	Beschrijving
address	String	Adres van het bankfiliaal of het hoofdkantoor
bank	String	Naam van de bank of financiële instelling
bic	String	BIC (Bank Identifier Code) van de bank
branch	String	Naam van het filiaal geïdentificeerd door de bankcode
city	String	De naam van de stad waarin het filiaal zich bevindt.
country	String	Twee letters afkorting van de landcode, bijvoorbeeld VS, VK, AU, FR ... enz.
e-mail	String	Benoemd contact-e-mailadres voor de bank of het filiaal
fax	String	Faxnummer van de bank / filiaal
phone	String	Contact telefoonnummer van de bank / filiaal
state	String	Staat van het bank- / filiaaladres
website	String	Website-adres van de bank / filiaal
zip	String	ZIP of postcode van het adres van de bankfiliaal

Het API-systeem levert resultaten op in XML- of JSON-indeling, die gemakkelijk te ontleden is in verschillende programmeertalen en platforms.

Een voorbeeld XML-antwoord van de API voor een SORT-code in het Verenigd Koninkrijk en het zoeken naar een accountnummer zou zijn:

Zoekopdracht URL:

?api_key=9834hAHx78ba4g8habsdk&country=GB&format=json&bankcode=110377&account=10218962

<result>
<iban>GB20ULSB98006054100029</iban>
<account>54100029</account>
<sort_code>980060</sort_code>
<bank>ULSTER BANK LTD</bank>
<branch>BELFAST CITY OFFICE 1</branch>
<bic>ULSBGB2BXXX</bic>
<address>PO BOX 232 11-16 DONEGALL SQUARE EAST </address>
<city>BT1 5UB</city>
<country>GB<country/>
<phone>028 90244112</phone>
</result>

Het antwoord voor dezelfde query als de gebruiker een JSON-indeling heeft opgegeven:

"iban":"GB20ULSB98006054100029","account":"54100029","sort_code":"980060","bank":"ULSTER BANK LTD","branch":"BELFAST CITY OFFICE 1","bic":"ULSBGB2BXXX","address":"PO BOX 232 11-16 DONEGALL SQUARE EAST ","city":"BT1 5UB","country":"GB","phone":"028 90244112"

7. API Fouten

In het geval van een fout retourneert de IBAN-berekening API een XML- of JSON-antwoord met het foutbericht.
De & lt; -fout & gt; & lt; / error & gt; XML-tags worden geretourneerd zonder andere velden in het XML-antwoord.
Hieronder vindt u een beschrijving van alle mogelijke foutmeldingen die kunnen worden teruggegeven:

& lt; fout & gt; rekeningnummer controlesom is ongeldig. </error>
<fout> rekeningnummer (controlesom) is niet correct. </error>
<fout> rekeningnummer moet elf tekens lang zijn </error>
<fout> rekeningnummer moet 14 tekens lang zijn </error>
<fout> rekeningnummer moet 24 tekens lang zijn </error>
<fout> rekeningnummer is niet geldig </error>
<fout> rekeningnummer van sorteercode is niet geldig </error>
<fout> Voorvoegsel rekeningnummer te lang. </error>
<fout> rekeningnummer te lang. </error>
<fout> Bank- / filiaalcode / KIB (controlesom) is niet correct. </error>
<fout> Bankcode / filiaalcode / rekeningnummer te lang. </error>
<fout> Bankcode / filiaalcode (controlesom) is niet correct. </error>
<fout> Bankcode niet geldig </error>
<fout> Bankcode te lang. </error>
<fout> Bank niet gevonden </error>
<fout> Bank niet herkend </error>
<fout> BBAN / NIB (controlesom) is niet correct. </error>
<fout> BLZ / bankcode niet geldig </error>
<fout> Filiaal / Agentschap niet gevonden </error>
<fout> Filiaalcode te lang. </error>
<fout> Filiaal niet gevonden </error>
<fout> Controleer cijfer te lang. </error>
<fout> Clearingnummer / rekeingnummer is niet geldig. Controlecijfer onjuist. ≪/error>
<fout> Clearingnummer / BankCode kan niet worden geïdentificeerd. IBAN kan niet worden berekend. ≪/error>
<fout> Clearingnummer of Rekeningnummer te lang. </error≪
<fout> Codice ABI della Banca / Bank Code niet geldig </error>
<fout> Codice CAB della Filiale / Filiaalcode niet geldig </error>
<fout> Landcode is niet geldig </error>
<fout> Land of bank niet ondersteund </error>
<fout> IBAN is niet geldig </error>
<fout> Kontonnummer / accountnummer is niet geldig </error>
<fout> Ontbrekende velden & lt; / error >
<fout> Niet-FR IBAN & lt; / error >
<fout> Niet-FR IBAN-land </error>
<fout> vereist veld ontbreekt. Voer bankcode en accountnummer in </error>
<fout> Verplichte velden niet ingediend. </error>
<fout> RIB is niet geldig </error≪
<fout> SortCode / BankCode kan niet worden geïdentificeerd. IBAN kan niet worden berekend. ≪/error>
<fout> Sorteercode kan niet worden gevonden </error>