التوثيق

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

البدء

كل نقاط النهاية تقع تحت عنوان URL أساسي واحد وتتبع نفس الاصطلاحات:

https://api.openbankinggateway.com
💡

كل صفحة تطبيق تتضمّن بيئة تجريب مباشرة — املأ المعاملات واضغط Send request، دون أي إعداد للعميل. المواصفة الكاملة القابلة للقراءة آليًا موجودة في OpenAPI / Swagger UI.

التكامل النموذجي يتم في ثلاث خطوات:

  1. سجّل الدخول — استدعِ نقاط تسجيل الدخول الخاصة بالتطبيق باستخدام بيانات الحساب / OTP.
  2. احفظ الرمز — تسجيل دخول ناجح يُعيد token من البوابة.
  3. استدعِ نقاط النهاية — مرّر token= في كل طلب يتطلب مصادقة.

المصادقة

يستخدم كل تطبيق تدفّق تسجيل دخول أصليًا للتطبيق المالي الأساسي (OTP عبر SMS، اسم مستخدم/كلمة مرور، PIN + OTP). عند النجاح تُصدر البوابة رمز جلسة خاصًا بها:

{ "code": 200, "data": { "status": "Login successful", "token": "<gateway session token>", ... } }

مرّر هذا الرمز كمعامل استعلام token= لكل نقطة نهاية لاحقة. تحلّه البوابة إلى جلسة المصدر على الخادم — فلن تتعامل مع بيانات اعتماد المصدر مرة أخرى.

🔑

الرموز مرتبطة بالحساب الذي سجّل الدخول. إذا انتهت جلسة المصدر، سجّل الدخول مجددًا للحصول على رمز جديد.

صيغة الاستجابة

كل استجابة — نجاح أو خطأ — تُغلَّف في نفس الغلاف:

{ "code": 200, // HTTP-style status of the gateway call "data": { ..., // normalized fields from the fintech app "upstream": { ... } // the raw, untouched upstream JSON } }

يحمل الحقل data.upstream دائمًا الاستجابة المالية الأصلية، فيمكنك الاعتماد على الحقول الموحّدة للراحة وأيضًا تدقيق أو تحليل الحمولة الخام عند حاجتك لتفاصيل خاصة بالتطبيق.

الأخطاء

الحالةالمعنى
400خطأ في التحقق — معامل مفقود أو غير صالح.
401بيانات اعتماد غير صالحة، رمز خاطئ/منتهٍ، أو لا توجد جلسة نشطة.
502تعذّر الوصول إلى التطبيق المالي المصدر أو حدث خطأ فيه.

أخطاء بيانات الاعتماد والمصدر لا تزال تتضمّن data.upstream عند توفّره، فلن يُخفى عنك محتوى خطأ المصدر أبدًا.

الواجهات المتاحة

كل تكامل يأتي بتوثيق كامل لنقاط النهاية وبيئة تجريب مباشرة:

🏦 DemoBank قالب → EasyPaisa (Phoenix) app icon EasyPaisa (Phoenix) باكستان → ACB ONE app icon ACB ONE فيتنام → slice Business app icon slice Business الهند → bKash Agent app icon bKash Agent بنغلاديش → Nagad Uddokta app icon Nagad Uddokta بنغلاديش →