الانتقال إلى المحتوى الرئيسي
توثيق الواجهة البرمجية

4 نقاط نهاية

المعاملات

كل ما دخل وخرج: مدفوعات واستردادات ودفعات نحو البنك ورسوم. مع تفاصيل العملية وخطها الزمني.

عناوين النقاط وأوصافها تأتي من عقد OpenAPI، بالإنجليزية — فلا يمكن أن تحيد عن الواجهة.

بكلمات بسيطة

السجل الوحيد لكل درهم يتحرك — للمتابعة والمطابقة.

متى تستعملونها

لمطابقتكم المحاسبية، أو لشاشة متابعة لدى التاجر، أو للتحقيق في عملية متنازَع عليها.

كيف تدمجونها

  1. 1اسردوا المعاملات على مدى فترة لمطابقتكم اليومية.
  2. 2استعملوا تصدير CSV بدل التصفّح متى تجاوز الحجم بضع مئات من الأسطر.
  3. 3افتحوا الخط الزمني لعملية لتفهموا ما جرى، خطوة بخطوة.
GET

الجدول الزمني للمعاملة

يُرجع الخط الزمني المُركَّب لدورة حياة معاملة (إنشاء، تفويض، اقتطاع، استرداد، ...).

الحقلالنوعالموضعمطلوبالوصف
operationIdinteger (int64)pathمطلوب
GET

استرجاع معاملة

تجلب معاملة واحدة بواسطة operationId الخاص بها.

الحقلالنوعالموضعمطلوبالوصف
operationIdinteger (int64)pathمطلوب
GET

تصدير المعاملات (CSV)

تبثّ المعاملات المصفّاة على شكل ملف CSV (حتى 10,000 صف). تتطلّب transaction:export.

الحقلالنوعالموضعمطلوبالوصف
statusenumqueryاختياريالقيم PENDINGPENDING_3DSSUCCESSFAILEDCANCELED
typeenumqueryاختياريالقيم PAYMENTREFUNDBILL_PAYMENTBANK_TRANSFER
methodstringqueryاختياري
fromstring (date-time)queryاختياري
tostring (date-time)queryاختياري
GET

عرض المعاملات

يسرد المعاملات الواردة والصادرة لبيئة المفتاح مع عوامل تصفية (الحالة، النوع، الوسيلة، القناة، النطاق الزمني، البحث). الترقيم بالإزاحة (offset) افتراضيًا؛ مرّروا limit (+cursor) للترقيم بالمؤشر (keyset) عند المسح العميق.

الحقلالنوعالموضعمطلوبالوصف
statusenumqueryاختياريالقيم PENDINGPENDING_3DSSUCCESSFAILEDCANCELED
typeenumqueryاختياريالقيم PAYMENTREFUNDBILL_PAYMENTBANK_TRANSFER
methodstringqueryاختياري
channelstringqueryاختياري
settlementIdstringqueryاختياري
searchstringqueryاختياري
fromstring (date-time)queryاختياري
tostring (date-time)queryاختياري
cursorstringqueryاختياري
limitinteger (int32)queryاختياري
pageablePageablequeryمطلوب

تحدّثوا إلى مختص دمج

سؤال حول الدمج؟

يجيب فريقنا التقني فرق الإدماج، من أول استدعاء في السندبوكس حتى الانتقال إلى الإنتاج.