Dokumentacija API-ja za Izračun IBAN-a

Ovaj API je dio naše IBAN Suite usluge

API vodič za integraciju

1. Što je API za izračun IBAN-a?

BAN izračun (IBAN Konverzija) je softverski sustav koji omogućava našim klijentima pretvaranje domaćih bankovnih kodova i brojeva računa u potvrđene brojeve međunarodnih bankovnih računa (IBAN).

Sustav omogućava klijentima korisničko sučelje, kao i API koji omogućuje integraciju u interne sustave vaše tvrtke.

Sustav također identificira banke i financijske institucije i pruža detalje našim klijentima.

2. Značajke

Slijedi nekoliko ključnih značajki našeg IBAN-ovog proračunskog sustava:

  • Provjerite lokalne šifre banke / šifre računa (* pogledajte Podržane zemlje)
  • Preuzmite podatke o banci na temelju lokalne banke / podružnice.
  • Automatski generirajte važeći IBAN format za isporučenu šifru banke / podružnice i broj računa
  • Sustav podržava oblikovanje više odgovora(JSON / XML)


3. Podržane Zemlje

API za IBAN Izračun API trenutačno podržava sljedeće zemlje i područja koja zahtijevaju naš API za izračun IBAN-a.

Kod Zemlje Naziv Zemlje Bankovni Kod Područje Račun Provjera Broja **
AT Austrija DA   DA  
BE Belgija DA   DA DA
CH Švicarska DA   DA  
DE Njemačka DA   YES  
EE Estonija     DA  
ES Španjolska DA DA DA DA
FI Finska     DA DA
FR Francuska DA DA DA DA
GB Velika Britanija DA   DA DA
HU Mađarska     DA DA
IE Irska DA   DA DA
IT Italija DA DA DA DA
MC Monako DA DA DA DA
MR Mauritanija DA DA DA  
MT Malta DA   DA  
NO Norveška     DA DA
PT Portugal 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
Stupac Provjera znamenki određuje ako zemlja podržava broj računa i / ili potvrdu znamenki provjere bankovnih šifri.

Provjera kontrolne znamenke je dodatni sloj zaštite integriteta podataka od pogrešaka pri upisivanju.

4. API Unosi

API prihvaća i HTTP GET i POST zahtjev za ulazne podatke. .
Prihvaćeni parametri navedeni su u donjoj tablici:

Naziv Polja Tip Opis
api_key Niz Vaš osobni API ključ. Dobiva se na području klijenta.
format niz Format odgovora API-ja (xml ili json)
zemlja Niz Kratica zemlje s 2 slova( UK/US/DE/FR )
bankcode Niz Jedinstveni identifikator banke. Razlikuje se za svaku zemlju. (izborno). Neke zemlje zahtijevaju samo broj računa.
podružnica Niz Jedinstveni identifikator lokalne podružnice (neobavezno)
račun Niz Broj osobnog računa
cd Integer Provjerite znamenke koje se koriste u nekim zemljama.
prefix Integer Trenutno se traži samo za Češku (neobavezno)
Prvi argument je ključ API-ja, to je jedinstveni niz koji pomaže našem sustavu da vas identificira kao korisnika i dopušta vam pristup API-ju.

API podržava više formata odgovora kako bi se olakšala integracija.Trenutno su podržani XML i JSON.

Argumenti zemalja moraju se sastojati od ISO kodova od 2 slova ISO, kao što su UK za Ujedinjeno Kraljevstvo, DE za Njemačku, FR za Francusku…
Bankovni kod ima različitu duljinu i strukturu za svaku zemlju.

Kod podružnice izborni je argument potreban samo za neke zemlje (pogledajte Primjere)
Broj računa je potreban za sve zemlje, a u nekim je slučajevima to jedini parametar koji se koristi za izračun IBAN-a.

Provjera znamenki potrebna je samo za određene zemlje koje su ugradile takve algoritme za potvrdu u strukturi brojeva domaćih bankovnih računa.(pogledajte Primjere)

Prefiks je polje po izboru samo za izračun IBAN-a u Češkoj.

5. API Primjeri

U donjoj tablici možete pronaći primjer radnog GET upita našem API-ju za svaku zemlju.

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

6. API XML Struktura Odgovora

Detaljni opis mogućih povratnih polja može se vidjeti u donjoj tablici:

Naziv Polja Tip Opis
adresa Niz Adresa poslovnice ili sjedišta banke
banka Niz Naziv banke ili financijske institucije
bic Niz BIC (Bank Identifier Code) banke
podružnica Niz Naziv podružnice identificiran bankovnim kodom
grad Niz Naziv grada u kojem se nalazi poslovnica.
zemlja Niz Kratica s dva slova šifre zemlje, npr. SAD, Velika Britanija, AU, FR... itd.
email Niz Imenovana adresa e-pošte za kontakt banke ili podružnice
fax Niz Broj faxa banke/podružnice
telefon Niz Kontakt broj banke / podružnice
država Niz Država adrese banke / podružnice
web stranica Niz Adresa web stranice banke / podružnice
Poštanski broj String Poštanski broj poslovnice banke
API sustav vraća rezultate u XML ili JSON format, koji je jednostavan za analizu na različitim programskim jezicima i platformama.

Primjer XML odgovora iz API-ja za SORT kôd Ujedinjenog Kraljevstva i pretraživanje broja računa bio bi:

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

Odgovori za isti upit ako korisnik odredi JSON oblikovanje:

"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. Pogreške API-ja

U slučaju pogreške, IBAN Calculation API vraća XML ili JSON odgovor koji sadrži poruku o pogrešci.
<error></error> XML oznake vraćaju se bez ikakvih drugih polja u XML odgovoru. .
U nastavku možete pronaći opis svih mogućih poruka o pogreškama koje se mogu vratiti:

<error>Account Number checksum is invalid.</error>
<error>Account Number (checksum) is not correct.</error>
<error>Account Number has to be 11 characters long</error>
<error>Account Number has to be 14 characters long</error>
<error>Account Number has to be 24 characters long</error>
<error>Account Number is not valid</error>
<error>Account Number of Sort Code is not valid</error>
<error>Account Number prefix too long.</error>
<error>Account Number too long.</error>
<error>Bank/Branch Code / KIB (checksum) is not correct.</error>
<error>Bank Code/ Branch Code/ Account Number too long.</error>
<error>Bank Code/ Branch Code (checksum) is not correct.</error>
<error>Bank Code not valid</error>
<error>Bank Code too long.</error>
<error>Bank Not Found</error>
<error>Bank Not Recognized</error>
<error>BBAN / NIB (checksum) is not correct.</error>
<error>BLZ/Bank Code not valid</error>
<error>Branch/Agencia not found</error>
<error>Branch Code too long.</error>
<error>Branch not found</error>
<error>Check Digit too long.</error>
<error>Clearingnummer/Account Number is not valid. Check digit incorrect.</error>
<error>Clearingnummer / BankCode can not be identified. IBAN can not be calculated.</error>
<error>Clearingnummer or Account Number too long.</error>
<error>Codice ABI della Banca/Bank Code not valid</error>
<error>Codice CAB della Filiale/Branch Code not valid</error>
<error>Country code is not valid</error>
<error>Country or Bank not supported</error>
<error>IBAN is not valid</error>
<error>Kontonummer/Account Number is not valid</error>
<error>Missing fields</error>
<error>Non FR IBAN</error>
<error>Non FR IBAN country</error>
<error>Required field is missing. Please enter Bank Code and Account Number</error>
<error>Required fields not submitted.</error>
<error>RIB is not valid</error>
<error>SortCode / BankCode can not be identified. IBAN can not be calculated.</error>
<error>Sort code cannot be found</error>