IBAN-i arvutuse API dokumentatsioon

See API on osa meie IBAN Suite'i teenusest

API integreerimisjuhend

1. Mis on IBAN Calculation API?

IBAN Calculation (AKA IBAN Conversion) arvutusmootor on tarkvarasüsteem, mis võimaldab meie klientidel teisendada kodumaised pangakoodide ja kontonumbrite kombinatsioonid valideeritud rahvusvahelisteks pangakontonumbriteks (IBAN).

Süsteemile sobib nii meie klientide manuaalne liides kui ka API, et võimaldada integreerimist oma ettevõtte sisesüsteemidesse.

Süsteem tuvastab ka pangad ja finantsasutused ning annab üksikasjad meie klientidele.

2. Funktsioonid

Allpool on toodud mõned meie IBAN-i arvutusmootori põhifunktsioonid:

Kohaliku pangakoodi/kontonumbri kontrollsummade valideerimine (* vt Toetatavad riigid)
Saate teavet panga kohta kohaliku panga/filiaali koodi alusel.
Loob sisestatud panga/filiaali koodi ja kontonumbri jaoks automaatselt kehtiva IBAN-vormingu
Süsteem toetab mitut vastusevormingut (JSON/XML)

3. Toetatavad riigid

IBAN Calculation API toetab praegu järgmisi riike ja välju, mida meie API vajab IBAN-i arvutamiseks.

Riigi kood	Riigi nimi	Pangakood	Filiaal	Konto	Kontrolli numbreid * *
AT	Austria	JAH.		JAH.
BE	Belgia	JAH.		JAH.	JAH.
CH	Šveits	JAH.		JAH.
DE	Saksamaa	JAH.		JAH.
EE	Eesti			JAH.
ES	Hispaania	JAH.	JAH.	JAH.	JAH.
FI	Soome			JAH.	JAH.
FR	Prantsusmaa	JAH.	JAH.	JAH.	JAH.
GB	Suurbritannia	JAH.		JAH.	JAH.
HU	Ungari			JAH.	JAH.
IE	Iirimaa	JAH.		JAH.	JAH.
IT	Itaalia	JAH.	JAH.	JAH.	JAH.
MC	Monaco	JAH.	JAH.	JAH.	JAH.
MR	Mauritaania	JAH.	JAH.	JAH.
MT	Malta	JAH.		JAH.
NO	Norra			JAH.	JAH.
PT	Portugal	JAH.	JAH.	JAH.	JAH.
SM	San Marino	JAH.	JAH.	JAH.
CZ	Tšehhi	JAH.		JAH.	JAH.
AL	Albaania	JAH.		JAH.
SK	Slovakkia	JAH.		JAH.	JAH.
SI	Sloveenia	JAH.		JAH.	JAH.
PL	Poola	JAH.		JAH.	JAH.
PK	Pakistan	JAH.		JAH.
SE	Rootsi	JAH.		JAH.	JAH.
NL	Holland			JAH.	JAH.

Veerg Kontrolli numbrit määrab, kas riik toetab kontonumbri ja/või pangakoodi kontrollnumbri valideerimist.

Kontrollnumbrite valideerimine on andmetervikluse kaitse lisakiht tippimisvigade eest.

4. API sisendid

API aktsepteerib nii HTTP GET kui ka POST sisendandmete taotlust.
Aktsepteeritud parameetrid on toodud alljärgnevas tabelis:

Välja nimi	Tüüp	Kirjeldus
api_key	Rida	Teie isiklik API võti. Saadud kliendi alal.
format	Rida	API vastusevorming (xml või json)
country	Rida	2-täheline riigikood (UK/US/DE/FR)
bankcode	Rida	Kordumatu pangaidentifikaator. Iga riigi puhul erinev. (Vabatahtlik). Mõned riigid nõuavad ainult kontonumbrit.
branch	Rida	Kordumatu kohaliku filiaali identifikaator (valikuline)
account	Rida	Isiklik kontonumber
cd	Täisarv	Kontrollige mõnes riigis kasutatavaid numbreid.
prefix	Täisarv	Praegu nõutav ainult Tšehhi Vabariigi puhul (vabatahtlik)

Esimene argument on API-võti, see on kordumatu rida, mis aitab meie süsteemil tuvastada teid kasutajana ja võimaldada juurdepääsu API-le.

API toetab integreerimise lihtsustamiseks mitut vastusevormingut. Praegu toetatakse XML-i ja JSON-i.

Riigi argumendid peavad koosnema 2-tähisest ISO riigikoodist, nagu Ühendkuningriik UK, Saksamaa DE, Prantsusmaa FR …
Pangakoodeks on igas riigis erineva pikkuse ja struktuuriga.

Filiaali kood on valikuline argument, mis on nõutav ainult mõne riigi puhul (vt näiteid)
Konto number on nõutav kõigi riikide puhul ja mõnel juhul on see ainus parameeter, mida kasutatakse IBAN-i arvutamiseks.

Numbrite kontrollimine on nõutav ainult teatud riikide puhul, kes on sisestanud sellised valideerimisalgoritmid oma riigisisesesse pangakonto numbristruktuuri. (Vt Näited)

Prefix on väli, mida on valikuliselt vaja ainult Tšehhi Vabariigi IBANi arvutamiseks.

5. API näited

Allolevast tabelist leiate meie API-le iga riigi kohta käiva GET-päringu näite.

Riik	Näidispäring (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-vastuse struktuur

Võimalike väljade üksikasjalik kirjeldus on esitatud järgmises tabelis:

Välja nimi	Tüüp	Kirjeldus
Aadress	Rida	Panga filiaali või peakorteri aadress
Pank	Rida	Panga või finantsasutuse nimi
BIC	Rida	Panga BIC-koos (panga tunnuskood)
Filiaal	Rida	Pangakoodiga identifitseeritud filiaali nimi
Linn	Rida	Selle linna nimi, kus filiaal asub.
Riik	Rida	Riigikoodi kaks tähtlühendit, nt USA, UK, AU, FR … jne.
E-post	Rida	Panga või filiaali määratud kontakti meiliaadress
Faks	Rida	Panga/filiaali faksinumber
Telefon	Rida	Panga/filiaali telefoni number
Halduspiirkond	Rida	Panga/filiaali halduspiirkond
Veebisait	Rida	Panga/filiaali veebisaidi aadress
Zip	Rida	Panga filiaali aadressi sihtnumber

API süsteem tagastab tulemid XML - või JSON-vormingus, mida on lihtne sõeluda mitmesugustes programmeerimiskeeltes ja platvormides.

Inglismaa Ühendkuningriigi SORT-koodi ja kontonumbri otsingu API XML-vastus on järgmine: päringu URL:

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

Sama päringu vastus, kui kasutaja määras JSON-i vormingu, on:

"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 tõrked

Tõrke korral tagastab IBAN Calculation API XML-vastuse või JSON-i vastuse, mis sisaldab tõrketeadet.
<error> </error> XML-sildid tagastatakse ilma XML-vastuse muude väljadeta.
Allpool leiate kõigi võimalike tõrketeadete kirjelduse:

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