الانتقال إلى المحتوى الرئيسي
POST
curl
تُنهي نقطة النهاية Cancel a Bank Link في Didit رابطًا لم يُكمله الشخص، فيتوقف url والـ token الخاص به عن العمل. استخدمها عندما يتخلى المستخدم عن التدفق، أو عندما تنشئ رابطًا جديدًا للمستخدم نفسه. إلغاء رابط مكتمل لا يغيّر شيئًا، ويُرجع 200 مع بقاء الرابط كما هو. لإيقاف الوصول، استخدم إبطال بدلًا من ذلك.

التفويضات

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.

الترويسات

Idempotency-Key
string

مفتاح اختياري لأمان إعادة المحاولة تختاره لعملية واحدة، بحد أقصى 255 حرفًا (يصلح UUID). الطلب المكرَّر بالمفتاح نفسه والـ endpoint والاستعلام والمحتوى يُجاب بالاستجابة الأولى نفسها، بالحالة والمحتوى نفسيهما، ولا يُنفَّذ ولا يُحتسب مرة ثانية. استخدام المفتاح نفسه مع endpoint أو استعلام أو محتوى مختلف يعيد 409 مع idempotency_key_reused، وبينما الطلب الأول ما زال قيد التنفيذ يعيد 409 مع idempotency_key_in_progress ومعه Retry-After. لا يُخزَّن الطلب الفاشل (أي 4xx أو 5xx)، لذا يمكنك إرساله مرة أخرى بالمفتاح نفسه. المفاتيح تخص تطبيقك، سواء استدعيت بمفتاح API أو بـ token الوصول. راجع إعادة المحاولة وidempotency.

Required string length: 1 - 255

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

id
string<uuid>
مطلوب

معرّف الرابط.

الاستجابة

الرابط بعد أن أصبح cancelled، أو دون تغيير إذا كان نهائيًا بالفعل.

تشغيل واحد لـ Bank Link لشخص واحد: ربط بنك، أو تجديد ربط. أكِّد الرابط بنفسك باستخدام get_link، ولا تثق أبداً بمعرّف يرسله المتصفح.

id
string<uuid>
مطلوب

معرّف الرابط.

mode
enum<string>
مطلوب
الخيارات المتاحة:
connect,
renew
access
enum<string>
مطلوب
الخيارات المتاحة:
one_time,
ongoing
status
enum<string>
مطلوب

حالة الرابط. الحالات completed وcancelled وexpired وfailed نهائية.

الخيارات المتاحة:
created,
opened,
connecting,
completed,
cancelled,
expired,
failed
url
string<uri> | null
مطلوب

صفحة التحقق المستضافة التي يُوجَّه إليها الشخص. تُعاد فقط عند إنشاء الرابط؛ وتكون null في القراءات اللاحقة لأن الرمز لا يُخزَّن.

client_token
string | null
مطلوب

token الخاص بـ Bank Link المضمّن في Didit، وهو غير متاح بعد: افتح url حالياً. يُعاد عند إنشاء الرابط فقط، وتكون القيمة null في القراءات اللاحقة. له غرض واحد وصلاحية قصيرة، ولا يحمل أي بيانات شخصية. لا تسجّله في السجلات أبداً.

expires_at
string<date-time>
مطلوب

متى يتوقف الرابط غير المستخدَم عن العمل.

connection_id
string<uuid> | null
مطلوب

الاتصال الذي أنشأه هذا الرابط أو جدّده، بمجرد أن تصبح status بقيمة completed.

check_id
string<uuid> | null
مطلوب

نتيجة الملكية لهذا الرابط، عندما يطلب ownership.compare بقيمة غير none.

reused
boolean
مطلوب

true عندما يكتمل الرابط بوصفه تجديداً لاتصال قائم، لأن الشخص يشارك بالفعل هذه الحسابات نفسها بالضبط (duplicates: reuse). لا تُفرض أي رسوم مرتين.

error
object | null
مطلوب

سبب فشل الرابط، عندما تكون status هي failed. وإلا فالقيمة null.

quote
object
مطلوب

سعر الرابط، ويُثبَّت عند إنشائه. يُحتسب الرسم وفق عرض السعر. لا تُحتسب أي رسوم عند عمليات القراءة.

vendor_data
string | null
مطلوب

مرجعك من الطلب.

آخر تعديل في ٢٢ نوفمبر ٢٠٢٦