هذا API هو جزء من موقعنا IBAN جناح خدمة
دليل التكامل API
1. ما هو IBAN حساب API?
محرك حساب IBAN (تحويل AKA IBAN) هو نظام برمجي يسمح لعملائنا بتحويل رمز البنك المحلي ومجموعات أرقام الحسابات إلى أرقام حسابات مصرفية دولية معتمدة (IBAN).يسمح النظام لعملائنا بواجهة يدوية بالإضافة إلى واجهة برمجة التطبيقات للسماح بالتكامل في الأنظمة الداخلية لشركتهم.
يحدد النظام أيضًا البنوك والمؤسسات المالية ويوفر التفاصيل لعملائنا.
2. ميزات
فيما يلي بعض الميزات الرئيسية لمحرك حساب IBAN الخاص بنا:- التحقق من صحة المجموع الاختباري لرمز البنك المحلي / رقم الحساب (* انظر البلدان المدعومة)
- استرجع معلومات عن البنك بناءً على رمز البنك / الفرع المحلي.
- يقوم تلقائيًا بإنشاء تنسيق IBAN صالح لرمز البنك / الفرع الموفر ورقم الحساب
- يدعم النظام تنسيق استجابة متعددة ( JSON / XML )
3. البلدان المدعومة
يدعم IBAN API حاليًا البلدان التالية والحقول التي تتطلبها API الخاصة بنا لحساب IBAN.| رمز البلد | اسم البلد | رمز البنك | فرع | حساب | التحقق من الرقم ** |
|---|---|---|---|---|---|
| At | النمسا | نعم | نعم | ||
| Be | بلجيكا | نعم | نعم | نعم | |
| CH | سويسرا | نعم | نعم | ||
| DE | دويتشلاند | نعم | نعم | ||
| EE | استونيا | نعم | |||
| ES | اسبانيا | نعم | نعم | نعم | نعم |
| FI | فنلندا | نعم | نعم | ||
| FR | فؤنسا | نعم | نعم | نعم | نعم |
| GB | بريطنيا العظمي | نعم | نعم | نعم | |
| HU | المجر | نعم | نعم | ||
| IE | ايرلندا | نعم | نعم | نعم | |
| IT | ايطاليا | نعم | نعم | نعم | نعم |
| MC | موناكو | نعم | نعم | نعم | نعم |
| MR | موريتانيا | نعم | نعم | نعم | |
| MT | مالطا | نعم | نعم | ||
| NO | النرويج | نعم | نعم | ||
| PT | البرتغال | نعم | نعم | نعم | نعم |
| SM | سان مارينو | نعم | نعم | نعم | |
| CZ | جمهورية التشيك | نعم | نعم | نعم | |
| AL | البانيا | نعم | نعم | ||
| SK | جمهورية سلوفاكيا | نعم | نعم | نعم | |
| SI | سلوفنيا | نعم | نعم | نعم | |
| PL | بولندا | نعم | نعم | نعم | |
| PK | باكستان | نعم | نعم | ||
| SE | السويد | نعم | نعم | نعم | |
| NL | هولندا | نعم | نعم |
التحقق من صحة أرقام التحقق هو طبقة إضافية من حماية تكامل البيانات ضد أخطاء الكتابة.
4. API مدخلات
يقبل API كل من طلب HTTP GET و POST لبيانات الإدخال.يتم سرد المعلمات المقبولة في الجدول أدناه:
| اسم الحقل | نوع | وصف |
|---|---|---|
| api_key | String | مفتاح API الشخصي الخاص بك. تم الحصول عليها في منطقة العميل. |
| بنية | String | API استجابة بنية ( xml or json ) |
| البلد | String | 2 رسالة رمز البلد ( UK/US/DE/FR ) |
| رمز البنك | String | معرف بنك فريد. مختلفة لكل بلد. ( اختياري ). بعض الدول تتطلب فقط رقم الحساب. |
| فرع | String | معرف فرع محلي فريد ( اختياري ) |
| حساب | String | رقم الحساب الشخصي |
| cd | عدد صحيح | تحقق من الأرقام المستخدمة في بعض البلدان. |
| اختصار | عدد صحيح | مطلوب حاليا فقط لجمهورية التشيك ( اختياري ) |
الوسيطة الأولى هي مفتاح واجهة برمجة التطبيقات ، وهي سلسلة فريدة تساعد نظامنا في التعرف عليك كمستخدم وتتيح لك الوصول إلى واجهة برمجة التطبيقات.
يجب أن تتكون وسيطات الدولة من كود بلد ISO مكون من حرفين مثل المملكة المتحدة للمملكة المتحدة ، DE لألمانيا ، FR لفرنسا …
رمز البنك له طول وطريقة مختلفة لكل بلد.
رمز الفرع هو وسيطة اختيارية مطلوبة فقط في بعض البلدان (راجع الأمثلة)
رقم الحساب مطلوب لجميع البلدان ، وفي بعض الحالات يكون المعامل الوحيد المستخدم لحساب رقم الحساب المصرفي الدولي (IBAN).
أرقام الشيكات مطلوبة فقط لبعض البلدان التي أدمجت خوارزميات التحقق من الصحة في هيكل أرقام حساباتها البنكية المحلية. (راجع الأمثلة)
البادئة هي حقل اختياري ly مطلوب فقط لحساب جمهورية التشيك IBAN.
5. API امثلة
في الجدول أدناه ، يمكنك العثور على مثال عمل استعلام GET على واجهة برمجة التطبيقات لكل بلد.| بلد | استعلام مثال (الحصول على طلب) |
|---|---|
| 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. بنية استجابة XML لـ API
يمكن الاطلاع على وصف تفصيلي للحقول المحتملة التي تم إرجاعها في الجدول أدناه:| اسم الحقب | نوع | وصف |
|---|---|---|
| عنوان | String | عنوان الفرع أو المقر الرئيسي للبنك |
| بنك | String | اسم البنك أو المؤسسة المالية |
| bic | String | BIC (كود معرف البنك) للبنك |
| فرع | String | اسم الفرع الذي حدده رمز البنك |
| المدينة | String | اسم المدينة التي يقع فيها الفرع. |
| البلد | String | اختصار مؤلف من حرفين لرمز البلد ، على سبيل المثال US, UK, AU, FR … الخ. |
| البريد الالكتروني | String | عنوان البريد الإلكتروني للاتصال المعين للبنك أو الفرع |
| فاكس | String | رقم الفاكس للبنك / الفرع |
| الهاتف | String | الاتصال برقم الهاتف للبنك / الفرع |
| حالة | String | حالة البنك / عنوان الفرع |
| الموقع | String | عنوان موقع البنك / الفرع |
| zip | String | ZIP أو الرمز البريدي لعنوان فرع البنك |
سيكون رد XML عينة من API لرمز SORT المملكة المتحدة والبحث عن رقم الحساب:
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>
ستكون استجابة نفس الاستعلام إذا حدد المستخدم تنسيق JSON:
"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 اخطاء
في حالة حدوث خطأ ، تُرجع واجهة برمجة تطبيقات حساب IBAN استجابة XML أو JSON تحتوي على رسالة الخطأ.The <error></error> XML يتم إرجاع العلامات دون أي حقول أخرى في استجابة XML.
يمكنك العثور أدناه على وصف لجميع رسائل الخطأ المحتملة التي يمكن إرجاعها:
<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>