الانتقال إلى المحتوى الرئيسي
GET
curl
يعيد نقطة النهاية «الحصول على اتصال بنكي» في Didit اتصالاً بنكياً واحداً مع حالته وتواريخ الموافقة وحالة المزامنة وملخصات الحسابات والتكلفة. يخبرك sync.initial_status بالوقت الذي تصبح فيه أولى البيانات قابلة للقراءة، وconsent.expires_at بالوقت الذي يجب فيه التجديد، وsync.budgets بعدد مرات التحديث التي لا يزال البنك يسمح بها. راجع الاتصالات.

التفويضات

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<uuid>
مطلوب

معرّف الاتصال.

الاستجابة

الاتصال.

إذن الشخص لتطبيقك بقراءة بنك واحد. تحافظ عملية التجديد على معرّف الربط ومعرّف كل حساب. يتضمّن الربط المحذوف الحقول id وstatus وstatus_reason وcreated_at وerasure فقط، ولا تظهر فيه أي حقول أخرى، ولا تبقى فيه أي بيانات عن البنك أو الشخص أو الحسابات.

id
string<uuid>
مطلوب

معرّف الاتصال.

status
enum<string>
مطلوب

pending: المزامنة الأولى قيد التشغيل. active: الموافقة سارية. renewal_required: انتهت الموافقة أو يطلب البنك من الشخص تسجيل الدخول مجددًا، والبيانات قابلة للقراءة كما في آخر مزامنة ولا يُحتسب أي مبلغ. paused: الرصيد منخفض للشهر. revoked: أوقف الشخص أو البنك أو أنت الوصول. deleted: لا يبقى سوى id وstatus وstatus_reason وcreated_at وerasure. failed: لم تنجح المزامنة الأولى قط.

الخيارات المتاحة:
pending,
active,
renewal_required,
paused,
revoked,
deleted,
failed
status_reason
enum<string> | null
مطلوب

سبب وجود الاتصال بهذه الحالة. الحالة paused_by_customer محجوزة. في الاتصال ذي الحالة deleted: deleted_by_customer أو consent_lapsed أو retention_elapsed أو application_deleted.

الخيارات المتاحة:
collection_complete,
consent_expired,
consent_lapsed,
bank_requires_sign_in,
revoked_by_end_user,
revoked_by_bank,
revoked_by_customer,
insufficient_balance,
paused_by_customer,
first_sync_failed,
deleted_by_customer,
retention_elapsed,
application_deleted,
null
erasure
object | null
مطلوب

يُضبط بعد delete_connection، وإلا فهو null.

created_at
string<date-time>
مطلوب
environment
enum<string>
الخيارات المتاحة:
live,
sandbox
access
enum<string>
الخيارات المتاحة:
one_time,
ongoing
institution
object

المصرف المرتبط به الاتصال أو الرابط.

segment
enum<string> | null
الخيارات المتاحة:
personal,
business,
null
data
enum<string>[]

النطاقات التي وافق عليها الشخص.

الخيارات المتاحة:
accounts,
balances,
transactions

موافقة الشخص على هذا الربط.

sync
object

حالة مزامنة الاتصال.

accounts
object[]

ملخص لكل حساب في الاتصال. اقرأ الحساب كاملا باستخدام get_account.

ownership
object

المقارنة الاختيارية لصاحب الحساب مع شخص أو شركة.

end_user
object
manage_url
string<uri> | null

صفحة الوصول الخاصة بالشخص. تكون القيمة null إلى أن تصبح صفحة الوصول متاحة.

billing
object

ما تكلفة هذا الاتصال. لا تُحتسب أي رسوم على البيئة التجريبية أبدًا.

possible_duplicate_of
string<uuid> | null

يُضبط عندما قد يكون هذا الاتصال مكرراً لاتصال نشط آخر، ولم يسمح أي end_user.reference بتطابق مؤكد.

vendor_data
string | null
updated_at
string<date-time>
آخر تعديل في ٢٢ نوفمبر ٢٠٢٦