IBAN Hesaplama API Belgesi

Bu API, IBAN Suite hizmetimizin bir parçasıdır

API entegrasyon kılavuzu

1. IBAN Hesaplama API'sı nedir?

IBAN Hesaplama (AKA IBAN Dönüşüm) motoru, müşterilerimizin yerel banka kodu ve hesap numarası kombinasyonlarını geçerli Uluslararası Banka Hesap Numaralarına (IBAN) dönüştürmelerini sağlayan bir yazılım sistemidir.

Sistem, müşterilerimizin manuel arayüzünün yanı sıra, şirketlerinin dahili sistemlerine entegrasyona izin veren bir API'ye izin verir.

Sistem ayrıca bankaları ve finansal kurumları tanır ve müşterilerimize detayları sunar.

2. Özellikler

IBAN Hesaplama motorumuzun bazı temel özellikleri aşağıdadır:

Yerel banka kodu / hesap numarası sağlama toplamlarını doğrulama (* bkz. Desteklenen Ülkeler)
Yerel banka / şube koduna göre banka hakkında bilgi alma
Verilen banka / şube kodu ve hesap numarası için otomatik olarak geçerli bir IBAN formatı oluşturur
Sistem çoklu yanıt biçimlendirmesini destekler (JSON / XML)

3. Desteklenen Ülkeler

IBAN Hesaplama API'si şu anda aşağıdaki ülkeleri ve bir IBAN hesaplamak için API'mızın gerektirdiği alanları desteklemektedir.

Ülke kodu	Ülke adı	Bank kodu	Şube	Hesap	Basamak kontrolü **
AT	Avusturya	EVET		EVET
BE	Belçika	EVET		EVET	EVET
CH	İsviçre	EVET		EVET
DE	Almanya	EVET		EVET
EE	Estonya			EVET
ES	İspanya	EVET	EVET	EVET	EVET
FI	Finlandiya			EVET	EVET
FR	Fransa	EVET	EVET	EVET	EVET
GB	Büyük Britanya	EVET		EVET	EVET
HU	Macaristan			EVET	EVET
IE	İrlanda	EVET		EVET	EVET
IT	İtalya	EVET	EVET	EVET	EVET
MC	Monako	EVET	EVET	EVET	EVET
MR	Moritanya	EVET	EVET	EVET
MT	Malta	EVET		EVET
NO	Norveç			EVET	EVET
PT	Portekiz	EVET	EVET	EVET	EVET
SM	San Marino	EVET	EVET	EVET
CZ	Çek Cumhuriyeti	EVET		EVET	EVET
AL	Arnavutluk	EVET		EVET
SK	Slovak Cumhuriyeti	EVET		EVET	EVET
SI	Slovenya	EVET		EVET	EVET
PL	Polonya	EVET		EVET	EVET
PK	Pakistan	EVET		EVET
SE	İsveç	EVET		EVET	EVET
NL	Hollanda			EVET	EVET

Basamak Kontrolü sütunu, ülkenin hesap numarasını ve / veya banka kodunu basamak kontrolü doğrulamasını destekleyip desteklemediğini belirtir.

Basamak kontrolü doğrulama, yazım hatalarına karşı ekstra bir veri bütünlüğü koruması katmanıdır.

4. API Girişleri

API, giriş verileri için hem HTTP GET hem de POST isteğini kabul eder.
Kabul edilen parametreler aşağıdaki tabloda listelenmiştir:

Alan Adı	Tip	Açıklama
api_anahtarı	Provizyon	Kişisel API anahtarınız. Müşteri alanında elde edilir.
format	Provizyon	API yanıt formatı (xml veya json)
ülke	Provizyon	2 harfli ülke kodu (UK / US / DE / FR)
banka kodu	Provizyon	Benzersiz bir banka tanımlayıcısı. Her ülke için farklı ( isteğe bağlı ). Bazı ülkeler için sadece hesap numarası gerekir.
şube	Provizyon	Benzersiz bir yerel şube tanımlayıcısı (isteğe bağlı)
hesap	Provizyon	Kişisel hesap numarası
cd	Tam sayı	Bazı ülkelerde Basamak Kontrolü kullanılır.
ön ek	Tam sayı	Şu anda sadece Çek Cumhuriyeti için gerekli (isteğe bağlı)

İlk argüman API anahtarıdır, bu sistemimizin sizi bir kullanıcı olarak tanımlamasına ve API'ye erişmenize izin veren benzersiz bir koşuldur.

API, daha kolay entegrasyon sağlamak için çoklu yanıt formatlarını destekler. Şu anda, XML ve JSON desteklenmektedir.

Ülke argümanları, Birleşik Krallık için UK, Almanya için DE, Fransa için FR gibi 2 harfli bir ISO ülke kodundan oluşmalıdır.
Banka Kodları her ülke için farklı uzunluk ve yapıya sahiptir.

Şube Kodu isteğe bağlı bir argümandır, sadece bazı ülkeler için gereklidir (örneklere bakınız).
Hesap numarası tüm ülkeler için gereklidir ve bazı durumlarda IBAN hesaplamak için kullanılan tek parametredir.

Basamak Kontrolü, yalnızca bu tür doğrulama algoritmalarını yerel banka hesap numarası yapılarına dahil eden bazı ülkeler için gereklidir. (Örneklere bakınız)

Ön ek isteğe bağlı olarak yalnızca Çek Cumhuriyeti IBAN hesaplaması için gerekli bir alandır.

5. API Örnekleri

Aşağıdaki tabloda, her ülke için API’mize çalışan örnek GET sorgusunu bulabilirsiniz.

Ülke	Örnek sorgu (GET İSTEME)
AT	ülke=AT&format=json&bankakodu=12000&hesap=52700357958
BE	?ülke=BE&format=json&bankakodu=250&hesap=0135106&cd=70
CH	?ülke=CH&format=json&bankakodu=0240&hesap=240C08011570
DE	?ülke=DE&format=json&bankakodu=BLZ37010050&hesap=399509
EE	?ülke=EE&format=json&hesap=55000005511439
ES	?ülke=ES&format=json&bankakodu=0081&şube=1731&cd=91&hesap=0006040912
FI	?ülke=FI&format=json&hesap=52900261901092
FR	?ülke=FR&format=json&bankakodu=30056&şube=00264&hesap=02640016443
GB	?ülke=GB&format=json&bankakodu=090127&hesap=93496333
HU	?ülke=HU&format=json&hesap=107000240416330551100005
IE	?ülke=IE&format=json&bankakodu=905838&hesap=71924374
IT	?ülke=IT&format=json&ülke=IT&bankakodu=02008&şube=30545&hesap=000103685854
MC	?ülke=MC&format=json&ülke=MC&bankakodu=30002&şube=03260&hesap=0000079112A
MR	?ülke=MR&format=json&bankakodu=00012&şube=00001&hesap=00000078326
MT	?ülke=MT&format=json&bankakodu=07113&hesap=199008240010
NO	?ülke=NO&format=json&hesap=96803502045
PT	?ülke=PT&format=json&bankakodu=0038&şube=0000&cd=81&hesap=39551148771
PK	?ülke=PK&format=json&bankakodu=HABBPKKA&hesap=39551148771
SE	?ülke=SE&format=json&bankakodu=9150&hesap=0092395696
SM	?ülke=SM&format=json&ülke=SM&bankakodu=03034&şube=09800&hesap=000060164676
CZ	?ülke=CZ&format=json&önek=51&hesap=1707230277&bankakodu=0100
AL	?ülke=AL&format=json&bankakodu=20511117&hesap=374362CLPRCFEURC
SK	?ülke=SK&format=json&önek=&hesap=4110053902&bankakodu=3100
SI	?ülke=SI&format=json&bankakodu=33000&hesap=0000102423
PL	?ülke=PL&format=xml&bankakodu=11402004&hesap=0000360275244226
SE	?ülke=SE&format=json&bankakodu=9300&hesap=5913222524
NL	?ülke=NL&format=json&hesap=0006642318

6. API XML Yanıt Yapısı

İade edilen olası alanların ayrıntılı bir açıklaması aşağıdaki tabloda görülebilir:

Alan Adı	Tip	Açıklama
adres	Provizyon	Banka şubesi veya merkez adresi
banka	Provizyon	Banka veya finansal kurumun adı
bic	Provizyon	Bankanın BIC (Banka Kimlik Kodu)
şube	Provizyon	Banka kodu ile belirlenen şubenin adı
city	Provizyon	Şubenin bulunduğu şehrin adı.
ülke	Provizyon	Ülke kodunun iki harfli kısaltması, ör. US, UK, AU, FR… vb.
eposta	Provizyon	Banka veya şubeye atanmış irtibat e-posta adresi
faks	Provizyon	Banka / şubenin faks numarası
telefon	Provizyon	Bankanın / şubenin irtibat telefon numarası
eyalet	Provizyon	Banka / şube adresinin eyaleti
websitesi	Provizyon	Bankanın / şubenin web sitesi adresi
postakodu	Provizyon	Banka şubesi adresinin posta kodu

API sistemi, çeşitli programlama dillerinde ve platformlarında ayrıştırılması kolay olan XML veya JSON biçiminde sonuçlar üretir.

İngiltere SORT kodu ve Hesap Numarası araması için API’den alınan örnek bir XML yanıtı şöyle olacaktır:

Sorgu URL’si:

?api_anahtarı=9834hAHx78ba4g8habsdk&ülke=GB&format=json&bankakodu=110377&hesap=10218962

<sonuç>
<iban>GB20ULSB98006054100029</iban>
<hesap>54100029</hesap>
<sıralama_kodu>980060</sıralama_kodu>
<banka>ULSTER BANK LTD</banka>
<şube>BELFAST CITY OFFICE 1</şube>
<bic>ULSBGB2BXXX</bic>
<adres>PO BOX 232 11-16 DONEGALL SQUARE EAST </adres>
<şehir>BT1 5UB</şehir>
<ülke>GB<ülke/>
<telefon>028 90244112</telefon>
</sonuç>

Kullanıcı bir JSON formatı belirlediğinde aynı sorgunun cevabı şöyle olacaktır:

"iban":"GB20ULSB98006054100029","hesap":"54100029","sıralama_kodu":"980060","banka":"ULSTER BANK LTD","şube":"BELFAST CITY OFFICE 1","bic":"ULSBGB2BXXX","adres":"PO BOX 232 11-16 DONEGALL SQUARE EAST ","şehir":"BT1 5UB","ülke":"GB","telefon":"028 90244112"

7. API Hataları

Bir hata durumunda, IBAN Hesaplama API'si hata mesajını içeren bir XML veya JSON yanıtı verir.
<hata></hata> XML etiketleri, XML yanıtında başka hiçbir alan olmadan iade edilir.
Aşağıda, iade edilebilecek olası tüm hata mesajlarının bir açıklamasını bulabilirsiniz:

<hata>Hesap Numarası sağlama toplamı geçersiz.</hata>
<hata>Hesap Numarası (sağlama toplamı) doğru değil.</hata>
<hata>Hesap Numarası 11 karakter uzunluğunda olmalı</hata>
<hata>Hesap Numarası 14 karakter uzunluğunda olmalı</hata>
<hata>Hesap Numarası 24 karakter uzunluğunda olmalı</hata>
<hata>Hesap Numarası geçerli değil</hata>
<hata>Sıralama Kodunun Hesap Numarası geçerli değil</hata>
<hata>Hesap Numarası öneki çok uzun.</hata>
<hata>Hesap Numarası çok uzun.</hata>
<hata>Banka / Şube Kodu / KIB (sağlama toplamı) doğru değil.</hata>
<hata>Banka Kodu / Şube Kodu / Hesap Numarası çok uzun.</hata>
<hata>Banka Kodu / Şube Kodu (sağlama toplamı) doğru değil.</hata>
<hata>Banka kodu geçerli değil</hata>
<hata>Banka kodu çok uzun.</hata>
<hata>Banka Bulunamadı</hata>
<hata>Banka Tanınmıyor</hata>
<hata>BBAN / NIB (sağlama toplamı) doğru değil.</hata>
<hata>BKD / Banka Kodu geçerli değil</hata>
<hata>Şube / Ajans bulunamadı</hata>
<hata>Şube Kodu çok uzun.</hata>
<hata>Şube bulunamadı</hata>
<hata>Basamak sayısı çok uzun kontrol edin.</hata>
<hata>Clearingnummer / Hesap Numarası geçerli değil. Basamak kontrolü yanlış.</hata>
<hata>Clearingnummer / Banka Kodu tanımlanamıyor. IBAN hesaplanamadı.</hata>
<hata>Clearingnummer / Hesap Numarası çok uzun.</hata>
<hata>Bankanın ABI kodu/Banka kodu geçerli değil</hata>
<hata>Şubenin CAB kodu/Şube kodu geçerli değil</hata>
<hata>Ülke kodu geçerli değil</hata>
<hata>Ülke veya Banka desteklenmiyor</hata>
<hata>IBAN geçerli değil</hata>
<hata>Kontonummer/Hesap Numarası geçerli değil</hata>
<hata>Eksik alanlar</hata>
<hata>FR dışı IBAN</hata>
<hata>FR dışı IBAN ülkesi</hata>
<hata>Zorunlu alan eksik. Lütfen Banka Kodunu ve Hesap Numarasını giriniz</hata>
<hata>Zorunlu alanlar girilmedi.</hata>
<hata>RIB geçerli değil</hata>
<hata>Sıralama Kodu / Banka Kodu tanımlanamıyor. IBAN hesaplanamadı.</hata>
<hata>Sıralama Kodu bulunamadı</hata>