API dokumentacija za IBAN izračun

Ta API je del naše IBAN Suitestoritve

Priročnik za integracijo API-ja

1. Kaj je IBAN API izračun?

IBAN izračun (ali IBAN konverzija) je programska oprema, ki našim strankam omogoča pretvorbo domačih bančnih kod in številk računov v preverjene mednarodne številke bančnih računov (IBAN).

Sistem strankam nudi uporabniški vmesnik in API, ki omogoča integracijo z notranjimi sistemi vašega podjetja.

Sistem tudi identificira banke in finančne institucije ter strankam zagotavlja podrobne informacije.

2. Značilnosti

Spodaj je navedenih nekaj ključnih značilnosti našega sistema za IBAN izračun:

Preverite šifro lokalno banko / šifro računa (* glejte Podprte države)
Prenesite bančne podatke na podlagi kode lokalne banke / podružnice.
Samodejno ustvari veljavno obliko IBAN-a za dano kodo banke / podružnice in številko računa
Sistem podpira oblikovanje z več odgovori (JSON / XML)

3. Podprte države

API za IBAN izračun trenutno podpira naslednje države in polja, ki jih naš API potrebuje za izračun IBAN-a.

Koda države	Ime države	Bančna koda	Podružnica	Račun	Kontrolna številka **
AT	Avstrija	DA		DA
BE	Belgija	DA		DA	DA
CH	Švica	DA		DA
DE	Nemčija	DA		DA
EE	Estonija			DA
ES	Španija	DA	DA	DA	DA
FI	Finska			DA	DA
FR	Francija	DA	DA	DA	DA
GB	Velika Britanija	DA		DA	DA
HU	Madžarska			DA	DA
IE	Irska	DA		DA	DA
IT	Italija	DA	DA	DA	DA
MC	Monako	DA	DA	DA	DA
MR	Mavretanija	DA	DA	DA
MT	Malta	DA		DA
NO	Norveška			DA	DA
PT	Portugalska	DA	DA	DA	DA
SM	San Marino	DA	DA	DA
CZ	Češka	DA		DA	DA
AL	Albanija	DA		DA
SK	Slovaška	DA		DA	DA
SI	Slovenija	DA		DA	DA
PL	Poljska	DA		DA	DA
PK	Pakistan	DA		DA
SE	Švedska	DA		DA	DA
NL	Nizozemska			DA	DA

V stolpcu "Kontrolna številka" je navedeno, ali država podpira številko računa in / ali preverjanje veljavnosti številke bančne kode.

Preverjanje veljavnosti kontrolnih številk je dodatna zaščita podatkov pred napakami v tipkanju.

4. API Vnosi

API sprejema tako HTTP GET kot POST zahtevo za vhodne podatke.
Sprejeti parametri so navedeni v spodnji tabeli:

Naziv polja	Tip	Opis
api_key	String	Vaš osebni API ključ. Na voljo je v območju stranke.
format	String	Format odgovora API-ja ( xml ali json )
country	String	Dvočrkovna koda države ( UK/US/DE/FR )
bankcode	String	Edinstven bančni identifikator. Drugačen za vsako državo. ( neobvezno ). Nekatere države zahtevajo samo številko računa.
branch	String	Edinstveni identifikator lokalne podružnice (neobvezno)
account	String	Številka osebnega računa
cd	Integer	Kontrolne številke, ki se uporabljajo v nekaterih državah.
prefix	Integer	Trenutno je potrebno samo za Češko (neobvezno)

Prvi argument je API ključ; to je edinstven niz, ki vam pomaga, da vas sistem prepozna kot uporabnika in vam omogoči dostop do API-ja

Za omogočanje lažje integracije, API podpira več formatov odziva. Trenutno sta podprta XML in JSON.

Argumenti držav morajo vsebovati dvočrkovno ISO kodo države, kot je UK za Združeno kraljestvo, DE za Nemčijo, FR za Francijo ...
Bančna koda ima različno dolžino in strukturo za vsako državo.

Koda podružnice je neobvezen argument, ki je potreben le za nekatere države (glej Primeri)
Številka računa je potrebna za vse države in v nekaterih primerih je to edini parameter, ki se uporablja za izračun IBAN-a.

Kontrolne številke so potrebne le za nekatere države, ki so vključile takšne validacijske algoritme v številko domačega bančnega računa. (glej Primeri)

"Prefix" je polje, ki je potreben le za izračun IBAN-a Ćeške.

5. API Primeri

V spodnji tabeli lahko najdete primer dela poizvedbe GET za naš API za vsako državo.

Država	Primer poizvedbe (GET ZAHTEVA)
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 struktura odgovora

Podroben opis možnih vrnjenih polj je prikazan v spodnji tabeli:

Naziv polja	Tip	Opis
address	String	Naslov podružnice ali sedeža banke
bank	String	Ime banke ali finančne institucije
bic	String	BIC ((Bančna identifikacijska koda) banke
branch	String	Ime podružnice, označene z bančno kodo
city	String	Ime mesta, v katerem se nahaja podružnica.
country	String	Dvočrkovna kratica države, npr. US, UK, AU, FR … itd.
email	String	Izbran kontaktni e-poštni naslov za banko ali podružnico
fax	String	Številka faksa banke / podružnice
phone	String	Kontaktna telefonska številka banke / podružnice
state	String	Država naslova banke / podružnice
website	String	Naslov spletne strani banke / podružnice
zip	String	poštna številka naslova banke / podružnice

Sistem API vrne rezultate v formatu XML ali JSON, ki ga je možno enostavno razčleniti v različnih programskih jezikih in platformah.

Primer XML odgovora iz API-ja za kodo SORT v Združenem kraljestvu in iskanje številke računa je:

URL poizvedbe:

?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>

Odgovor za isto poizvedbo, če je uporabnik izbral format JSON, bo:

"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 napake

V primeru napake API za izračun IBAN-a vrne XML ali JSON odgovor, ki vsebuje sporočilo o napaki.
XML oznake se v XML odgovoru vrnejo brez drugih polj.
Spodaj lahko najdete opis vseh možnih sporočil o napakah:

<error>Kontrolna številka računa je neveljavna.</error>
<error>Številka računa (kontrolna številka) ni pravilna.</error>
<error>Številka računa mora biti dolga 11 znakov</error>
<error>Številka računa mora biti dolga 14 znakov</error>
<error>Številka računa mora biti dolga 24 znakov</error>
<error>Številka računa ni veljavna</error>
<error>Koda številke računa je neveljavna</error>
<error>Predpona številke računa je predolga.</error>
<error>Številka računa je predolga.</error>
<error>Koda banke / podružnice / KIB (kontrolna številka) ni pravilna.</error>
<error>Koda banke / podružnice / številka računa je predolga.</error>
<error>Koda banke / koda podružnice (kontrolna številka) ni pravilna.</error>
<error>Koda banke je neveljavna</error>
<error>Koda banke je predolga.</error>
<error>Banka ni najdena</error>
<error>Banka ni prepoznana</error>
<error>BBAN / NIB (kontrolna številka) ni pravilen.</error>
<error>BLZ/koda banke ni pravilna</error>
<error>Podružnica/Agencia ni najdena</error>
<error>Koda podružnice je predolga.</error>
<error>Podružnica ni najdena</error>
<error>Kontrolna cifra je predolga.</error>
<error>Clearingnummer/Številka računa ni veljavna. Kontrolna cifra ni pravilna.</error>
<error>Clearingnummer / Bančne kode ni mogoče identificirati. IBAN ni mogoče izračunati.</error>
<error>Clearingnummer ali številka računa je predolga.</error>
<error>Codice ABI della Banca/koda banke ni veljavna</error>
<error>Codice CAB della Filiale/koda podružnice ni veljavna</error>
<error>Koda države ni veljavna</error>
<error>Država ali banka ni podprta</error>
<error>IBAN ni veljaven</error>
<error>Kontonummer/številka računa ni veljavna</error>
<error>Manjkajoča polja</error>
<error>Ne-FR IBAN</error>
<error>Ne-FR IBAN država</error>
<error>Zahtevano polje manjka. Vnesite bančno kodo in številko računa</error>
<error>Zahtevana polja manjkajo.</error>
<error>RIB je neveljaven</error>
<error>Oznake / kode banke ni mogoče prepoznati. IBAN ni mogoče izračunati.</error>
<error>Oznake banke ni mogoče najti</error>