SK
Toto API je súčasťou nášho IBAN Balíčka služieb
API integračná príručka
1. Čo je rozhranie API na výpočet IBAN?
IBAN kalkulácia (alebo tiež IBAN konverzia) je softvérový systém, ktorý umožňuje klientom konvertovať kombinácie tuzemských bankových kódov a čísel účtov do validovaných medzinárodných čísel bankového účtu (IBAN).Systém umožňuje používateľom manuálne rozhranie, ako aj rozhranie API umožňujúce integráciu do interných systémov spoločnosti.
Systém takisto identifikuje banky a finančné inštitúcie a poskytuje podrobnosti našim zákazníkom.
2. Vlastnosti
Nižšie sú uvedené niektoré z kľúčových funkcií nášho výpočtového programu IBAN:- Overenie kontrolných súčtov miestnych kódov bankového účtu / účtu (* pozri podporované krajiny)
- Načítať informácie o banke na základe kódu miestnej banky / pobočky.
- Automaticky generuje platný formát IBAN pre dodaný kód banky a pobočky a číslo účtu
- Systém podporuje formátovanie viacerých odpovedí (JSON / XML)
3. Podporované krajiny
Rozhranie API na výpočet IBAN v súčasnosti podporuje nasledujúce krajiny a polia vyžadované naším API na výpočet IBAN.| Kód krajiny | Názov krajiny | BANKOVÝ KÓD | Pobočka | Účet | Skontrolujte číslicu **|
|---|---|---|---|---|---|
| AT | Rakúsko | ÁNO | ÁNO | ||
| BE | Belgicko | ÁNO | ÁNO | ÁNO | |
| CH | Švajčiarsko | ÁNO | ÁNO | ||
| DE | Nemecko | ÁNO | ÁNO | ||
| EE | Estónsko | ÁNO | |||
| ES | Španielsko | ÁNO | ÁNO | ÁNO | ÁNO |
| FI | Fínsko | ÁNO | ÁNO | ||
| FR | Francúzsko | ÁNO | ÁNO | ÁNO | ÁNO |
| GB | Veľká Británia | ÁNO | ÁNO | ÁNO | |
| HU | Maďarsko | ÁNO | ÁNO | ||
| IE | Írsko | ÁNO | ÁNO | ÁNO | |
| IT | Taliansko | ÁNO | ÁNO | ÁNO | ÁNO |
| MC | Monako | ÁNO | ÁNO | ÁNO | ÁNO |
| MR | Mauritánia | ÁNO | ÁNO | ÁNO | |
| MT | Malta | ÁNO | ÁNO | ||
| NO | Nŕsko | ÁNO | ÁNO | ||
| PT | Portugalsko | ÁNO | ÁNO | ÁNO | ÁNO |
| SM | San Maríno | ÁNO | ÁNO | ÁNO | |
| CZ | Česká Republika | ÁNO | ÁNO | ÁNO | |
| AL | Albánsko | ÁNO | ÁNO | ||
| SK | Slovenská Republika | ÁNO | ÁNO | ÁNO | |
| SI | Slovinsko | ÁNO | ÁNO | ÁNO | |
| PL | PoĽsko | ÁNO | ÁNO | ÁNO | |
| PK | Pakistan | ÁNO | ÁNO | ||
| SE | Švédsko | ÁNO | ÁNO | ÁNO | |
| NL | Holandsko | ÁNO | ÁNO |
Kontrola kontrolných číslic predstavuje ďalšiu ochranu integrity údajov pred chybami pri písaní.
4. API Inputs
Rozhranie API prijíma vstupné dáta ako HTTP GET a POSTPrijaté parametre sú uvedené v nasledujúcej tabuľke:
| Názov Poľa | Typ | Popis |
|---|---|---|
| api_key | String | Váš osobný kľúč API. Získané v oblasti klienta. |
| format | String | Formát odpovede API (xml alebo json) |
| country | String | 2-miestny kód krajiny (UK/US/DE/FR) |
| bankcode | String | Jedinečný identifikátor banky. Rôzne pre každú krajinu. (voliteľné). Niektoré krajiny vyžadujú len číslo účtu. |
| branch | String | Jedinečný identifikátor lokálnej pobočky (voliteľné) |
| account | String | Číslo osobného účtu |
| cd | Integer | Kontrola čísla používané v niektorých krajinách. |
| prefix | Integer | V súčasnosti sa vyžaduje iba pre Českú republiku (voliteľné) |
Rozhranie API podporuje viacero formátov odpovedí, aby sa zabezpečila ľahšia integrácia. V súčasnosti sú podporované XML a JSON.
Argumenty krajiny musia pozostávať z 2-miestneho ISO kódu krajiny, ako napríklad GB pre Spojené kráľovstvo, DE pre Nemecko, FR pre Francúzsko ...
Kód banky má pre každú krajinu inú dĺžku a štruktúru
Pobočkový kód je voliteľný argument, ktorý sa vyžaduje len v niektorých krajinách (pozri príklady)
Číslo účtu je potrebné pre všetky krajiny a v niektorých prípadoch je to jediný parameter použitý na výpočet IBAN
Kontrola číslic je potrebná iba pre určité krajiny, ktoré začlenili takéto validačné algoritmy do svojej domácej štruktúry bankového účtu. (pozri príklady)
Predpona je pole, ktoré sa voliteľne vyžaduje iba pre výpočet IBAN v Českej republike.
5. API Príklady
V tabuľke nižšie nájdete príklady pracovného dotazu GET na naše rozhranie API pre každú krajinu.| Krajina | Príklad dotazu (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 Štruktúra Odpovedí
Podrobný opis možných vrátených polí nájdete v nasledujúcej tabuľke:| Názov Poľa | Typ | Popis |
|---|---|---|
| address | String | Adresa pobočky alebo ústredia banky |
| bank | String | Názov banky alebo finančnej inštitúcie |
| bic | String | BIC (Bank Identifier Code) banky |
| branch | String | Názov pobočky označenej bankovým kódom |
| city | String | Názov mesta, v ktorom je pobočka umiestnená. |
| country | String | Dvojpísmenová skratka kódu krajiny, napr. USA, UK, AU, FR ... atď. |
| String | Vymenovaná kontaktná e-mailová adresa banky alebo pobočky | |
| fax | String | Číslo faxu banky / pobočky |
| phone | String | Kontaktné telefónne číslo banky / pobočky |
| state | String | Stav adresy banky / pobočky |
| website | String | Internetová stránka banky / pobočky |
| zip | String | PSČ alebo poštové číslo adresy banky |
Vzorová odpoveď XML z rozhrania API pre britský kód SORT a hľadanie čísla účtu by bola:
Webová adresa dopytu:
?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>
Odpoveď pre ten istý dotaz, ak používateľ zadá formát JSON, bude:
"iban":"GB20ULSB98006054100029","účet":"54100029","zoraďovací_kód":"980060","banka":"ULSTER BANK LTD","pobočka":"BELFAST KANCELÁRIA 1","bic":"ULSBGB2BXXX","addresa":"PO BOX 232 11-16 DONEGALL SQUARE EAST ","mesto":"BT1 5UB","krajina":"GB","telefón":"028 90244112"
7. API Chyby
V prípade chyby API výpočtu IBAN vráti odpoveď XML alebo JSON obsahujúce chybové hlásenie<error></error> značky XML sa vrátia bez akýchkoľvek iných polí v odpovedi XML
Nižšie nájdete popis všetkých možných chybových hlásení, ktoré je možné obdržať:
<error>Kontrolný súčet Čísla účtu je neplatný.</error>
<error>Číslo účtu (kontrolný súčet) nie je správne.</error>
<error>Číslo účtu musí mať dĺžku 11 znakov</error>
<error>Číslo účtu musí mať dĺžku 14 znakov</error>
<error>Číslo účtu musí mať dĺžku 24 znakov</error>
<error>Číslo účtu nie je platné</error>
<error>Číslo účtu Triediaceho Kódu nie je platné</error>
<error>Číslo prefixu účtu je príliš dlhé.</error>
<error>Číslo účtu je príliš dlhé.</error>
<error>Kód banky / Pobočky / KIB (kontrolný súčet) nie je správny.</error>
<error>Kód banky / kód pobočky / číslo účtu je príliš dlhé.</error>
<error>Kód banky / kód pobočky (kontrolný súčet) nie je správny.</error>
<error>Kód banky nie je platný</error>
<error>Kód banky je príliš dlhý.</error>
<error>Banka sa nenašla</error>
<error>Banka nebola rozpoznaná</error>
<error>BBAN / NIB (kontrolný súčet) nie je správny.</error>
<error>BLZ / bankový kód nie je platný</error>
<error>Pobočka / agentúra nebola nájdená</error>
<error>Kód pobočky je príliš dlhý.</error>
<error>Pobočka nebola nájdená</error>
<error>Skontrolujte číslo je príliš dlhé.</error>
<error>Čistiace číslo / Číslo účtu nie je platné. Nesprávna kontrolná číslica.</error>
<error>Čistiace číslo / Kód banky nemožno identifikovať. IBAN nie je možné vypočítať.</error>
<error>Čistiace číslo alebo číslo účtu sú príliš dlhé.</error>
<error>ABI kód banky / bankového kódu nie je platný</error>
<error>Kód pobočky / pobočkového kódexu CAB nie je platný</error>
<error>Kód krajiny nie je platný</error>
<error>Krajina alebo banka nie je podporovaná</error>
<error>IBAN nie je platný</error>
<error>Číslo Kontonummer / Číslo účtu nie je platné</error>
<error>Chýbajúce polia</error>
<error>Žiadny FR IBAN</error>
<error>Žiadny FR IBAN krajiny</error>
<error>Požadované pole chýba. Zadajte kód banky a číslo účtu</error>
<error>Povinné polia neboli odoslané.</error>
<error>RIB nie je platný</error>
<error>Triediaci kód / Kód banky nie je možné identifikovať. IBAN nie je možné vypočítať.</error>
<error>Triediaci kód sa nenašiel</error>