Dokumentation för IBAN-beräkningsAPI
Detta API är en del av vår IBAN-svit-tjänst
Integreringsguide för API
1. Vad är IBAN-beräkningsAPI?
IBAN-beräkningsmaskinen ( även känd som IBAN-konvertering ) är ett mjukvarusystem som gör det möjligt för våra klienter att konvertera inhemska bankkod och kontonummer-kombinationer till giltiga internationella bankkontonummer ( IBAN ).
Systemet tillåter våra klienter att ha ett manuellt gränssnitt liksom ett API för att göra det möjligt att integrera i deras företags interna system.
Systemet identifierar även baker och finansinstitut och ger detaljerna till våra kunder.
2. Funktioner
Nedan följer några av de viktigaste funktionerna hos vår IBAN-beräkningsmaskin:
- Validera lokal bankkod / kontrollsummor för kontonummer ( * se Stödda Länder )
- Hämta information avseende bank baserat på lokal bank/filialkod.
- Automatiskt generera ett giltigt IBAN-format för angiven bank/filialkod och kontonummer
- Systemet stöder flera olika svarsformat ( JSON / XML )
3. Stödda Länder
IBAN-beräkningsAPIet stöder för närvarande följande länder och fälten som krävs av vårt API för att beräkna en IBAN.
Landkod |
Land |
Bankkod |
Filial |
Konto |
Kontrollsiffra ** |
AT |
Österrike |
JA |
|
JA |
|
BE |
Belgien |
JA |
|
JA |
JA |
CH |
Schweiz |
JA |
|
JA |
|
DE |
Tyskland |
JA |
|
JA |
|
EE |
Estland |
|
|
JA |
|
ES |
Spanien |
JA |
JA |
JA |
JA |
FI |
Finland |
|
|
JA |
JA |
FR |
Frankrike |
JA |
JA |
JA |
JA |
GB |
Storbritannien |
JA |
|
JA |
JA |
HU |
Ungern |
|
|
JA |
JA |
IE |
Irland |
JA |
|
JA |
JA |
IT |
Italien |
JA |
JA |
JA |
JA |
MC |
Monaco |
JA |
JA |
JA |
JA |
MR |
Mauritanien |
JA |
JA |
JA |
|
MT |
Malta |
JA |
|
JA |
|
NO |
Norge |
|
|
JA |
JA |
PT |
Portugal |
JA |
JA |
JA |
JA |
SM |
San Marino |
JA |
JA |
JA |
|
CZ |
Tjeckien |
JA |
|
JA |
JA |
AL |
Albanien |
JA |
|
JA |
|
SK |
Slovakien |
JA |
|
JA |
JA |
SI |
Slovenien |
JA |
|
JA |
JA |
PL |
Polen |
JA |
|
JA |
JA |
PK |
Pakistan |
JA |
|
JA |
|
SE |
Sverige |
JA |
|
JA |
JA |
NL |
Nederländerna |
|
|
JA |
JA |
Kontrollsifferkolonnen specificerar om landet stöder kontonummer och/eller bankkodvalidering me kontrollsiffor.
Kontrollsiffervalideringen är ett extra lager av dataintegritetsskydd mot inmatningsfel.
4. API-inmatningar
APIet accepterar både HTTP GET och POST.begäran för inmatningsdata.
Accepterade parametrar är listade i tabellen nedan:
Fältnamn |
Typ |
Beskrivning |
api_key |
Sträng |
Din personliga API-nyckel. Kan fås i klientarean. |
format |
Sträng |
API-responsformat ( xml or json ) |
country |
Sträng |
Landskod med 2 bokstäver ( UK/US/DE/FR ) |
bankcode |
Sträng |
En unik bankidentifierare. Olika för varje land. ( valfritt ). Vissa länder kräver bara kontonummer. |
branch |
Sträng |
En unik identifierare för lokal filial ( valfritt ) |
account |
Sträng |
Personligt kontonummer |
cd |
Integer |
Kontrollsiffror som används i vissa länder. |
prefix |
Integer |
Krävs för närvarande bara för Tjeckien ( valfritt ) |
Första argumentet är API-nyckeln, detta är en unik sträng vilken hjälper vårt system att identifiera dig som en användare och låter dig få åtkomst till APIet.
APIet stöder flera svars för att göra integration lättare. För närvarande stöds XML och JSON.
Landsargumenten måste bestå av ISO-landskoden på 2 bokstäver såsom UK för Storbritannien, DE för Tyskland, FR för Frankrike …
Bankkod har olika längd och struktur för varje land.
Filialkod är ett valfritt argument som bara behövs för vissa länder ( hänvisa till Exempel )
Kontonummer krävs för alla länder och i vissa fall är det den enda parametern som används för att beräkna en IBAN.
Kontrollsiffror krävs bara för vissa länder som har byggt in sådana valideringsalgoritmer i sin inhemska bankkontonummerstruktur. ( hänvisa till Exempel )
Prefix är ett valfritt fält som enbart krävs för tjeckiska IBAN-beräkningar.
5. API-exempel
I tabellen nedan kan du finna exempel på fungerande GET-sökning till vårt API för vart land.
Land |
Exempel på sökning (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-svarsstruktur
En detaljerad beskrivning av möjliga fält som returneras kan ses i tabellen nedan:
Fältnamn |
Typ |
Beskrivning |
address |
Sträng |
Adress till bankfilial eller högkvarteret |
bank |
Sträng |
Name på bank eller finansinstitut |
bic |
Sträng |
Banks BIC ( Bank Identifier Code ) |
branch |
Sträng |
Namn på filialen som identifierats av bankkoden |
city |
Sträng |
Stad i vilken filialen är lokaliserad. |
country |
Sträng |
Förkortning med två bokstäver för landskoden t.ex. US, UK, AU, FR … osv. |
email |
Sträng |
Angiven e-postadress för kontakt för bank eller filial |
fax |
Sträng |
Fax-nummer till banken/filialen |
phone |
Sträng |
Kontakttelefonnummer för banken / filialen |
state |
Sträng |
Bank/filialadress stat |
website |
Sträng |
Bank / filials hemsida |
zip |
Sträng |
Postnummer eller postkod för bank/filialadressen |
API-systemet returnerar resultat i XML eller JSON-format, vilka lätt kan tolkas av ett antal olika programmeringsspråk och plattformar.
Ett emepel på XML-svar frå APIet för en sorteringskod och kontonummerssökning i Storbritannien skulle vara:
Sök-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>
Svaret för samma sökning om användaren specificerade an JSON-formattering skulle vara:
"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-fel
Vid fel returnerar IBAN-beräkningsAPIet ett XML eller JSON-svar som innehåller felmeddelandet.
<error></error> XML-taggarna returneras utan andra fält i XML-svaret.
Nedan kan du finna en beskrivning på alla möjliga felmeddelanden som kan returneras:
<error>Ogiltigt kontrollsumma för kontonummer.</error>
<error>Felaktig (kontrollsumma) för kontonummer.</error>
<error>Kontonummer måste vara 11 tecken långt</error>
<error>Kontonummer måste vara 14 tecken långt</error>
<error>Kontonummer måste vara 24 tecken långt</error>
<error>Ogiltigt kontonummer</error>
<error>Kontonummer för sorteringskod ogiltigt</error>
<error>Kontonummerprefix för långt.</error>
<error>Kontonummer för långt.</error>
<error>Bank/Filialkod / KIB (kontrollsumma) inte korrekt.</error>
<error>Bankkod/ Filialkod/ Kontonummer för långt.</error>
<error>Bankkod/ Filialkod (kontrollsumma) inte korrekt.</error>
<error>Bankkod inte giltig</error>
<error>Bankkod för lång.</error>
<error>Bank kan inte hittas</error>
<error>Bank kan inte kännas igen</error>
<error>BBAN / NIB (kontrollsumman) är inte korrekt.</error>
<error>BLZ/Bankkod inte giltig</error>
<error>Filial/Agencia inte funnen</error>
<error>Filialkod för lång.</error>
<error>Filial inte funnen</error>
<error>Kontrollsiffra för lång.</error>
<error>Clearingnummer/Kontonummer inte giltig. Felaktig kontrollsiffra.</error>
<error>Clearingnummer / Bankkod kan inte identifieras. IBAN kan inte beräknas.</error>
<error>Clearingnummer eller kontonummer för långt.</error>
<error>Codice ABI della Banca/Bankkod inte giltig</error>
<error>Codice CAB della Filiale/Filialkod inte giltig</error>
<error>Landskod är inte giltig</error>
<error>Land eller bank inte stödd</error>
<error>IBAN är inte giltig</error>
<error>Kontonummer/kontonummer är inte giltigt</error>
<error>Saknade fält</error>
<error>Icke-FR IBAN</error>
<error>Icke-FR IBAN-land</error>
<error>Krävda fält saknas. Vänligen ange bankkod och kontonummer</error>
<error>Krävda fält inte överförda.</error>
<error>RIB är inte giltig</error>
<error>Sorteringskod / bankkod kan inte identifieras. IBAN kan inte beräknas.</error>
<error>Sorteringskod kan inte hittas</error>