الانتقال إلى المحتوى الرئيسي
GET
curl
يعيد endpoint Get an Institution من Didit بنكًا واحدًا مع إمكاناته وحالة تشغيله. القيمة التي لم تُلاحَظ مطلقًا تكون null، وليست قيمة مُقدَّرة.

التفويضات

x-api-key
string
header
مطلوب

مفتاح API الخاص بتطبيقك، ويمكن الحصول عليه من Developers -> API keys في Business Console. يملك المفتاح الأساسي صلاحية وصول كاملة. يمكن تقييد المفتاح المسمّى: بلا صلاحية، أو قراءة، أو كتابة لكل مورد، ويمكن قصره على بعض سير العمل أو على الجلسات المعتمدة، وعلى قائمة من عناوين IP، وعلى تاريخ انتهاء. يعني الرمز 401 أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية. ويعني الرمز 403 أنه لم يُرسل أي مفتاح، أو أن المفتاح لا يملك صلاحية لهذا المورد أو الإجراء، أو أن الطلب صدر من عنوان خارج قائمة IP الخاصة به. ويعني الرمز 404 على مسار جلسة أن الجلسة خارج سير عمل المفتاح أو حالاته المسموح بها. يتلقى المفتاح الذي لا يملك وصولًا إلى الوسائط عناوين URL للصور والفيديو وملفات PDF بقيمة null، ويتلقى المفتاح الذي لا يملك صلاحية كتابة الجلسات روابط الجلسات والرموز بقيمة null. راجع https://docs.didit.me/console/api-keys.

معلمات المسار

id
string
مطلوب

معرّف المؤسسة، مثل es-banco-norte.

الاستجابة

المصرف.

بنك وما يدعمه. تأتي القيم من بيانات القدرات المرصودة، وتُحدَّث يومياً. القيمة التي لم تُرصد أبداً تكون null، لا تخميناً.

id
string
مطلوب

معرّف Didit للبنك، وهو معرّف نصي ثابت.

مثال:

"es-banco-norte"

name
string
مطلوب
country
string
مطلوب
Pattern: ^[A-Z]{3}$
logo_url
string<uri> | null
مطلوب
timezone
string | null
مطلوب

المنطقة الزمنية وفق IANA التي تكون فيها تواريخ البنك.

segments
enum<string>[]
مطلوب
الخيارات المتاحة:
personal,
business
access
enum<string>[]
مطلوب

تُدرج القيمة ongoing فقط حيث يكون الوصول المستمر مفعّلًا للبنك.

الخيارات المتاحة:
one_time,
ongoing
ongoing_access
boolean
مطلوب

هل الوصول المستمر متاح لدى هذا البنك.

أطول مدة موافقة يسمح بها البنك، بالأيام. تكون null عندما لا تتوفر ملاحظة لها.

history_days_max
integer | null
مطلوب

أطول فترة من السجل التاريخي يقدمها البنك، بالأيام. تكون null عندما لا تكون مرصودة.

pending_transactions
boolean | null
مطلوب

هل يُبلغ البنك عن المعاملات المعلّقة.

pending_linkage
boolean | null
مطلوب

هل يربط البنك المعاملة المعلّقة بالمعاملة المقيّدة، وهو ما يحدد قيمة pending_id.

balance_types
enum<string>[]
مطلوب
الخيارات المتاحة:
booked,
available,
expected
transaction_fields
string[]
مطلوب

حقول المعاملة التي يُعرف أن البنك يرسلها. كل حقل آخر تكون قيمته null.

sign_in
enum<string> | null
مطلوب

كيف يسجل الشخص الدخول إلى البنك.

الخيارات المتاحة:
redirect,
app_approval,
credentials,
null
requires_end_user_email
boolean | null
مطلوب

هل تتطلب Bank Link عنوان بريد إلكتروني موثّقًا للشخص.

corporate_accounts
boolean | null
مطلوب

هل حسابات الشركات مدعومة.

bank_account_selection
boolean | null
مطلوب

هل يختار الشخص الحسابات لدى البنك بدلًا من اختيارها في Bank Link.

هل يطلب البنك تأكيدًا إضافيًا واحدًا لإتاحة السجل الأقدم.

reconfirmation
boolean | null
مطلوب

هل يمكن تأكيد التجديد على شاشة Didit دون تسجيل الدخول إلى البنك.

sync_frequency_hours
integer | null
مطلوب

عدد الساعات بين عمليات المزامنة التلقائية حيث يسمح البنك بوتيرة أسرع. تعني null الإعداد اليومي الافتراضي.

health
enum<string>
مطلوب
الخيارات المتاحة:
operational,
degraded,
down
آخر تعديل في ٢٢ نوفمبر ٢٠٢٦