انتقل إلى المحتوى

API

تمكنك نهايات ال API من التحكم بإدادة طلبات الدفع برمجياً ضمن تطبيقك أو موقعك. على سبيل المثال تستطيع عرض منتج للبيع وعندما يختاره العميل يقوم موقعك بتوليد رابط دفع بشكل ألي٬ وعند اتمام الدفع يقوم البنك الرقمي بإرسال تحديث لموقعك بحالة الطلب باستخدام ال Webhooks.

للبدء باستخدام النهايات عليك أولا إنشاء مفتاح وصول API-KEY من صفحة بوابة الدفع في التطبيق.

  • 1- انتقل لصفحة بوابة الدفع واضغط API

    زر API

  • 2- إضغط على زر إنشاء مفتاح جديد

    مفتاح جديد

  • 2- أختر الصلاحيات وعناوين ال IP المسموح لها استخدام المفتاح واضغط حفظ

    صلاحيات مفتاح الوصول

  • 3- انسخ المفتاح واستخدمه عند التواصل مع نهايات ال API

    نسخ مفتاح الوصول

نهايات API

يوفر البنك الرقمي العديد من نهايات ال API للتتحك بحسابك وتدير طلبات الدفع.

إدارة طلبات الدفع

تمكنك هذه النهايات من إنشاء وتحديث وحذف طلبات الدفع بأنواعها.

إقرأ المزيد

إدارة الحساب

تمكنك هذه النهايات من الوصول للأرصدة والأرشفة وإجراء عمليات السحب الخارجي وعمليات التحويل الداخلي. لاستخدام هذه النهايات تواصل معنا تفعيلها على حسابك.

إقرأ المزيد

التبديل بين العملات

تمكنك هذه النهايات من التبديل بين العملات المختلفة بناء على حاجتك. لاستخدام هذه النهايات تواصل معنا تفعيلها على حسابك.

إقرأ المزيد

إدارة الحسابات الفرعية

تمكنك من إنشاء حسابات فرعية للتجار والزبائن وإدارة النزاعات حول عمليات الدفع. لاستخدام هذه النهايات عليك تفعيل ميزة العلامة البيضاء

إقرأ المزيد

أداة الدفع

يمكنك استخدام أداة الدفع والاستجابة للتحديثات فيها من خلال فتحها ضمن iframe في موقعك أو تطبيقك عند معالجة الدفعة كما يلي

<iframe 
    src="https://digibankar.com/pay/in/9298" 
    id="iframe" 
    style="width:100vw;height:100vh">
</iframe>

الإنصات لأحداث الأداة ومعالجتها 

if (window.addEventListener) { 
    window.addEventListener("message", handleMessage); 
} else { 
    window.attachEvent("onmessage", handleMessage); 
}

function handleMessage(e) {
    if (e.data  &&  e.data.type == "payment-event"  &&  e.data.status == "SUCCESS") {
        // Update the UI
        console.log(e.data.requestId, e.data.orderId)
    }
}
أنواع الحالات التي تصدر من الأداة هي

  • SUCCESS للدلالة على نجاح عملية الدفع
  • ADDRESS_CREATED للدلالة على إنشاء عنوان دفع بنجاح
  • ADDRESS_CREATE_FAILED للدلالة على فشل إنشاء عنوان دفع
  • WAITING_FOR_PAYMENT للدلالة على انتظار الدفعة بعد إنشاء عنوان الدفع
  • VERIFICATION_CODE_SENT للدلالة على إرسال كود تأكيد للدفع من الرصيد
  • FAILED_TO_LOAD_REQUEST للدلالة على فشل جلب معلومات طلب الدفع

تخصيص أداة الدفع

يمكن تخصييص أداة الدفع من خلال تمرير بعض المتحولات ضمن رابط الدفع كالتالي

https://digibankar.com/pay/in/9298?lang=ar&darkMode=1&methods=1,5&currencies=USDT,USDC&networks=1,56,hideLangBtn=false&hideDarkModeBtn=false

المتحولات المتوفرة

  • lang اللغة
  • darkMode لاختيار الوضع الليلي
  • methods تحديد طرق الدفع الممكنة
  • currencies تحديد العملات المسموحة للدفع
  • networks تحديد شبكات البلوكتشين المسموحة للدفع
  • hideLangBtn إخفاء زر اللغة
  • hideDarkModeBtn إخفاء زر الوضع الليلي

Webhooks

يمكنك إضافة العديد من روابط ال Webhooks إلي حسابك للتلقى تحديثات عن العمليات التي تجري على حسابك

الاحداث المتوفرة التي سيتم إرسالها إلي الروابط

تغير حالة طلب الدفع

يتم إرسال هذه الحدث عندما يتم إنشاء طلب دفع جديد أو تغير حالته أو حذفه وهو يبدو كما يلي

{
    "EventType": "PaymentRequestStatusChanged",
    "Data": {
        "OldStatus": null,
        "NewStatus": "Created",
        "RequestId": 449,
        "OrderId": "d4oBHis5xUbPmP2HzYlk"
    }
}

تغير حالة الإيداع الرقمي

يتم إرسال هذه الحدث عندما يتم استقبال ايداع أو تغير حالته رقمي وهو يبدو كما يلي

{
    "EventType": "CryptoDepositStatusChanged",
    "Data": {
        "OldStatus": "Processing",
        "NewStatus": "Confirmed",
        "Id": "449",
        "ChainId": 137,
        "AssetSymbol":"USDT",
        "Amount": 18.2
    }
}

تغير حالة سحب رقمي

يتم إرسال هذه الحدث عندما يتم إنشاء طلب سحب رقمي أو تغير حالته رقمي وهو يبدو كما يلي

{
    "EventType": "CryptoWithdrawalStatusChanged",
    "Data": {
        "OldStatus": "Processing",
        "NewStatus": "Confirmed",
        "Id": "44934",
        "ChainId": 1,
        "AssetSymbol":"ETH",
        "Amount": 0.05
    }
}