LT
Ši API yra dalis mūsų IBAN komplekto paslaugos
API integracijos vadovas
1. Kas yra IBAN skaičiavimo API?
IBAN skaičiavimo sistema ( taip pat žinoma kaip IBAN konversijos sistema ) yra programinė įranga, leidžianti mūsų klientams konvertuoti vietinius banko kodus ir sąskaitos numerių derinius į patvirtintus tarptautinius banko sąskaitų numerius ( IBAN ).Sistema leidžia mūsų klientams rankinę sąsają ir API, leidžiančią integruotis į jų įmonės vidaus sistemas.
Sistema taip pat identifikuoja bankus ir finansines institucijas ir teikia informaciją mūsų klientams.
2. Funkcijos
Žemiau pateikiamos pagrindinės mūsų IBAN skaičiavimo sistemos funkcijos:- Patvirtinkite vietinį banko kodą/sąskaitos numerio kontrolines sumas (* žr. palaikomas šalis)
- Gaukite informaciją apie banką pagal vietinį banko/filialo kodą.
- Automatiškai generuoja galiojantį IBAN formatą tiekiamam banko/filialo kodui ir paskyros numeriui
- Sistema palaiko kelių atsakų formatavimą (JSON/XML)
3. Palaikomos šalys
Šiuo metu IBAN skaičiavimo API palaiko šias šalis ir laukus, kurių mūsų API reikalauja, kad apskaičiuotų IBAN.| Šalies kodas | Šalis | Banko kodas | Filialas | Sąskaita | Kontrolinis skaičius ** |
|---|---|---|---|---|---|
| AT | Austrija | TAIP | TAIP | ||
| BE | Belgija | TAIP | TAIP | TAIP | |
| CH | Šveicarija | TAIP | TAIP | ||
| DE | Vokietija | TAIP | TAIP | ||
| EE | Estija | TAIP | |||
| ES | Ispanija | TAIP | TAIP | TAIP | TAIP |
| FI | Suomija | TAIP | TAIP | ||
| FR | Prancūzija | TAIP | TAIP | TAIP | TAIP |
| GB | Didžioji Britanija | TAIP | TAIP | TAIP | |
| HU | Vengrija | TAIP | TAIP | ||
| IE | Airija | TAIP | TAIP | TAIP | |
| IT | Italija | TAIP | TAIP | TAIP | TAIP |
| MC | Monakas | TAIP | TAIP | TAIP | TAIP |
| MR | Mauritanija | TAIP | TAIP | TAIP | |
| MT | Malta | TAIP | TAIP | ||
| NO | Norvegija | TAIP | TAIP | ||
| PT | Portugalija | TAIP | TAIP | TAIP | TAIP |
| SM | San Marinas | TAIP | TAIP | TAIP | |
| CZ | Čekija | TAIP | TAIP | TAIP | |
| AL | Albanija | TAIP | TAIP | ||
| SK | Slovakija | TAIP | TAIP | TAIP | |
| SI | Slovėnija | TAIP | TAIP | TAIP | |
| PL | Lenkija | TAIP | TAIP | TAIP | |
| PK | Pakistanas | TAIP | TAIP | ||
| SE | Švedija | TAIP | TAIP | TAIP | |
| NL | Nyderlandai | TAIP | TAIP |
Kontrolinių skaičių patvirtinimas yra papildomas sluoksnis duomenų vientisumo apsaugos nuo spausdinimo klaidų.
4. API Įvestys
The API accepts both HTTP GET and POST request for input data.The accepted parameters are listed in the table below:
| Pavadinimas | Tipas | Aprašymas |
|---|---|---|
| api_key | String | Jūsų asmeninis API raktas. Gaunamas kliento zonoje. |
| format | String | API atsako formatas ( xml arba json ) |
| country | String | Dviejų raidžių šalies kodas ( UK/US/DE/FR ) |
| bankcode | String | Unikalus banko identifikatorius. Kiekvienoje šalyje skirtingas. ( neprivalomas ). Kai kuriose šalyse reikalingas tik sąskaitos numeris. |
| branch | String | Unikalus vietinio filialo identifikatorius ( neprivalomas ) |
| account | String | Asmeninis sąskaitos numeris |
| cd | Integer | Kai kuriose šalyse naudojami kontroliniai skaičiai. |
| prefix | Integer | Šiuo metu reikalaujama tik Čekijos Respublikai ( neprivaloma ) |
API palaiko kelis atsako formatus, kad būtų lengviau integruoti. Šiuo metu palaikoma XML ir JSON.
Šalies argumentas turi būti sudaryti iš dviejų raidžių ISO šalies kodo, pvz., Jungtinėms Karalystėms UK, Vokietijai DE, Prancūzijai FR…
Banko kodas yra skirtingo ilgio ir struktūros kiekvienoje šalyje.
Filialo kodas yra neprivalomas argumentas, reikalingas tik kai kuriose šalyse ( žr. pavyzdžius )
Sąskaitos numeris reikalingas visoms šalims ir kai kuriais atvejais tai yra vienintelis parametras, naudojamas apskaičiuoti IBAN.
Kontroliniai skaičiai reikalingi tik tam tikroms šalims, kurios tokius patvirtinimo algoritmus įtraukė į savo šalies banko sąskaitos numerio struktūrą. (žr. pavyzdžius)
Prefiksas yra laukas, reikalingas tik Čekijos IBAN skaičiavimams.
5. API pavyzdžiai
Toliau pateiktoje lentelėje galite rasti GET užklausos į mūsų API pavyzdį kiekvienai šaliai.| Šalis | Užklausos pavyzdys (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 atsako struktūra
Išsamų galimų laukų aprašymą galima pamatyti toliau pateiktoje lentelėje:| Pavadinimas | Tipas | Aprašymas |
|---|---|---|
| address | String | Banko filialo ar būstinės adresas |
| bank | String | Banko ar finansų įstaigos pavadinimas |
| bic | String | Banko BIC ( Banko identifikavimo kodas ) |
| branch | String | Banko kodu identifikuoto filialo pavadinimas |
| city | String | Miesto, kuriame yra filialas, pavadinimas. |
| country | String | Dviejų raidžių šalies kodo santrumpa, pvz. US, UK, AU, FR… ir t.t. |
| String | Paskirtas banko ar filialo kontaktinis el. pašto adresas | |
| fax | String | Banko/filialo fakso numeris |
| phone | String | Banko/filialo kontaktinis telefono numeris |
| state | String | Banko/filialo adreso būklė |
| website | String | Banko / filialo svetainės adresas |
| zip | String | Banko filialo adreso ZIP arba pašto kodas |
Jungtinių Karalysčių SORT kodo ir paskyros numerio paieškos XML atsakymas iš API būtų toks:
Užklausos 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>
Atsakymas iš tos pačios užklausos, jei vartotojas nurodytų JSON formatavimą:
"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 Klaidos
Klaidos atveju, IBAN skaičiavimo API grąžina XML arba JSON atsakymą, kuriame yra klaidos pranešimas.<error></error> XML žymės grąžinamos be jokių kitų laukų XML atsakyme.
Žemiau rasite visų galimų klaidų pranešimų, kuriuos gali grąžinti, aprašymą:
<error>Sąskaitos numerio kontrolinė suma negaliojanti.</error>
<error>Sąskaitos numeris (kontrolinė suma) netaisyklingas.</error>
<error>Sąskaitos numeris turi būti sudarytas iš 11 simbolių</error>
<error>Sąskaitos numeris turi būti sudarytas iš 14 simbolių</error>
<error>Sąskaitos numeris turi būti sudarytas iš 24 simbolių</error>
<error>Sąskaitos numeris negaliojantis</error>
<error>Sort kodo sąskaitos numeris negaliojantis</error>
<error>Sąskaitos numerio prefiksas per ilgas.</error>
<error>Account Number too long. Sąskaitos numeris per ilgas</error>
<error>Banko/filialo kodas/KIB (kontrolinė suma) netaisyklingas.</error>
<error>Banko kodas/filialo kodas/sąskaitos numeris per ilgas.</error>
<error>Banko kodas/filialo kodas (kontrolinė suma) netaisyklingas.</error>
<error>Banko kodas negaliojantis</error>
<error>Banko kodas per ilgas.</error>
<error>Bankas nerastas</error>
<error>Bankas neatpažintas</error>
<error>BBAN/NIB (kontrolinė suma) netaisyklinga.</error>
<error>BLZ/banko kodas negaliojantis</error>
<error>Filialas/agentūra nerasta</error>
<error>Filialo kodas per ilgas.</error>
<error>Filialas nerastas</error>
<error>Kontrolinis skaičius per ilgas.</error>
<error>Sort kodas/sąskaitos numeris negaliojantis. Kontrolinis skaičius netaisyklingas.</error>
<error>Sort/banko kodas neatpažintas. Neina apskaičiuoti IBAN.</error>
<error>Sort kodas arba sąskaitos numeris per ilgas.</error>
<error>Codice ABI della Banca/banko kodas negaliojantis</error>
<error>Codice CAB della Filiale/filialo kodas negaliojantis</error>
<error>Šalies kodas netaisyklingas</error>
<error>Šalis arba bankas nepalaikomas</error>
<error>Netaisyklingas IBAN</error>
<error>Netaisyklingas sąskaitos numeris</error>
<error>Trūksta laukų</error>
<error>Ne FR IBAN</error>
<error>Ne FR IBAN šalis</error>
<error>Trūksta būtino lauko. Įveskite banko kodą ir sąskaitos numerį</error>
<error>Privalomi laukai nepateikti.</error>
<error>Netaisyklingas RIB</error>
<error>Sort kodas/banko kodas neatpažintas. Neina apskaičiuoti IBAN.</error>
<error>Nerastas Sort kodas</error>