HU
Ez az API az IBAN Suite szolgáltatásunk része
API integrációs útmutató
1. Mi az az IBAN Kalkulációs API?
Az IBAN Kalkulátor (vagy IBAN Konverter) egy olyan szoftver, amely lehetővé teszi ügyfeleink számára, hogy a hazai bankszámlák és kódok kombinációit érvényesített nemzetközi bankszámlákká (IBAN) alakítsák át.Rendszerünk segítségével ügyfeleink akár manuálisan, akár API-n keresztül tudják integrálni cégek belső rendszerébe az adatokat.
A rendszer azonosítja a bankokat és a pénzügyi intézményeket, és részleteket szolgáltat ügyfeleinknek.
2. Jellemzők
Alább találhatja a főbb jellemzőit az IBAN Kalkulátorunknak:- Erősítse meg a helyi banki kód/számlaszám ellenőrző összegeit (* lásd: Támogatott országok )
- A bankra vonatkozó információk lekérése a helyi bank/fiók kód alapján.
- Automatikusan létrehoz egy érvényes IBAN formátumot a mellékelt banki/fiókkódhoz és számlaszámhoz
- A rendszer több válaszformátumot is támogat ( JSON / XML )
3. Támogató Országok
Az IBAN Kalkulációs API jelenleg az alábbi országokban érhető el és az API által igényelt mezőket támogattja az IBAN kiszámításához.| Ország Kód | Ország | Banki Kód | Branch | Számla | Ellenőrző számjegy ** |
|---|---|---|---|---|---|
| AT | Ausztria | IGEN | IGEN | ||
| BE | Belgium | IGEN | IGEN | IGEN | |
| CH | Svájc | IGEN | IGEN | ||
| DE | Németország | IGEN | IGEN | ||
| EE | Észtország | IGEN | |||
| ES | Spanyolország | IGEN | IGEN | IGEN | IGEN |
| FI | Finnország | IGEN | IGEN | ||
| FR | Franciaország | IGEN | IGEN | IGEN | IGEN |
| GB | Nagy-Britannia | IGEN | IGEN | IGEN | |
| HU | Magyarország | IGEN | IGEN | ||
| IE | Írország | IGEN | IGEN | IGEN | |
| IT | Olaszország | IGEN | IGEN | IGEN | IGEN |
| MC | Monaco | IGEN | IGEN | IGEN | IGEN |
| MR | Mauritánia | IGEN | IGEN | IGEN | |
| MT | Málta | IGEN | IGEN | ||
| NO | Norvégia | IGEN | IGEN | ||
| PT | Portugália | IGEN | IGEN | IGEN | IGEN |
| SM | San Marino | IGEN | IGEN | IGEN | |
| CZ | Csehország | IGEN | IGEN | IGEN | |
| AL | Albánia | IGEN | IGEN | ||
| SK | Szlovákia | IGEN | IGEN | IGEN | |
| SI | Szlovénia | IGEN | IGEN | IGEN | |
| PL | Lengyelország | IGEN | IGEN | IGEN | |
| PK | Pakisztán | IGEN | IGEN | ||
| SE | Svédország | IGEN | IGEN | IGEN | |
| NL | Hollandia | IGEN | IGEN |
Az ellenőrző számok alkalmazásával az adatsértetlenség védelmének egy további réteget lehet biztosítani a gépelési hibák ellen.
4. API Bemenetek
Az API elfogadja a bemeneti adatok HTTP GET és POST kéréseit is.Az elfogadott paraméterek az alábbi táblázatban találhatók:
| Mező Neve | Típus | Leírás |
|---|---|---|
| api_key | String | Személyes API kulcs. A Kliens részlegen található. |
| format | String | API válaszformátuma (json vagy xml) |
| country | String | Az ország kétbetűs kódja (US / UK / FR / DE) |
| bankcode | String | A Bank egyedi azonosítója. Minden ország más. ( opcionális ). Néhány országban csak a számlaszámra van szükség. |
| branch | String | Helyi fiók egyedi azonosítója ( opcionális ) |
| account | String | Személyes számlaszám |
| cd | Integer | Néhány ország ellenőrző számjegyeket használ. |
| prefix | Integer | Jelenleg csak Csehországban van rá szükség ( opcionális ) |
Az API több válaszformátumot is támogat a könnyebb integráció érdekében. Jelenleg az XML és a JSON formátumok támogatottak.
Az ország argumentumnak kétbetűs ISO-országkódot kell tartalmaznia, mint például UK az Egyesült Királyságnak, DE Németország, FR Franciaország …
A Banki kód minden országban eltérő hosszúságú és szerkezetű.
A Branch kód opcionális és csak néhány országban szükséges
A számlaszám minden országban szükséges, és bizonyos esetekben ez az egyetlen paraméter, amely az IBAN kiszámításához szükséges.
Az ellenőrző számok csak bizonyos országokban szükségesek. Az ilyen országok beépítették az érvényesítési algoritmusokat a hazai bankszámlaszám-struktúrájukba. (lásd a példákat)
Az előtag egy olyan kritérium, amely csak a cseh IBAN-számításához szükséges.
5. API Példák
Nézze meg az alábbi táblázatban az API-hoz tartozó GET-lekérdezések országspecifikus példáit.| Ország | Példa lekérdezés (GET LEKÉRDEZÉS)) |
|---|---|
| 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 Válasz Struktúra
Nézze meg az alábbi táblázatban a lehetséges visszatérések részleteit:| Mező Neve | Típus | Leírás |
|---|---|---|
| address | String | Központ vagy bankfiók címe |
| bank | String | Pénzügyi intézmény vagy bank neve |
| bic | String | Bank azonosító kódja (BIC) |
| branch | String | Banki kóddal azonosított fióknév |
| city | String | A város neve, ahol a fióktelep található. |
| country | String | Az ország 2 betűs rövidített kódja, pl. UK, USA, FR, DE… stb. |
| String | Fiók vagy bank által megadott e-mail cím | |
| fax | String | Fiók/bank faxszáma. |
| phone | String | Fiók/bank telefonszáma/ branch |
| state | String | A bank/fiók címe |
| website | String | Bank/fiók honlapja |
| zip | String | Bank vagy fiók postai vagy irányítószám. |
Az Egyesült Királyság SORT kódjának és számlaszámának az API-ról származó XML-válasza:
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>
A lekérdezésre adott válasz, ha a felhasználó megadta a JSON formázást:
"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 Hibák
Ha hiba történt az IBAN Kalkulációs API során, az XML vagy a JSON válasz hibaüzenetet tartalmaz.Az <error></error> válasz XML-címkéket tartalmaz, amelyeken nincsenek más mezők.
Alább találja a lehetséges visszaadott hibaüzenetek leírását:
<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>