المطوّرون

GET/v3/getbalance

قراءة رصيد الحساب

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

في هذه الصفحة
  1. الطلب
  2. الاستجابة
  3. الأخطاء والاستخدام

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

الطلب

استخدم بيانات اعتماد واجهة برمجة التطبيقات من جهة الخادم عبر HTTPS. تقرأ الأمثلة بيانات الاعتماد من متغيرات البيئة؛ ولا تحتوي على أي بيانات اعتماد صالحة للاستخدام. افحص status.code في جسم JSON، وكذلك حالة HTTP. لا تضبط هذه المعالجات القديمة حالة خطأ HTTP بصورة متسقة عند حدوث خطأ في التطبيق.

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/getbalance"

لا يلزم تقديم أي معاملات في المسار أو الاستعلام أو جسم الطلب.

الاستجابة

هذا مثال توضيحي لبنية الاستجابة، وليس بيانات حساب أو عرض أسعار حاليًا.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "balance": "125.50",
    "currency": "USD",
    "terms": "prepaid"
  }
}
حقول استجابة الرصيد
الحقلالمعنى
balanceرصيد الحساب المخزّن. حافظ على الدقة العشرية عند معالجة القيم النقدية.
currencyقيمة العملة المخزنة لهذا الحساب.
termsقيمة شروط الدفع المخزنة للحساب. لا يسرد المعالج قيمها الممكنة ولا يوحّد صيغتها؛ فلا تفترض أن المثال يشمل جميع القيم الممكنة.

الأخطاء والاستخدام

عند فشل المصادقة، تُستخدم استجابة المصادقة المشتركة لواجهة برمجة التطبيقات. لا يعرّف هذا المعالج خطأً منفصلًا لغياب الرصيد ولا آلية لتقسيم النتائج إلى صفحات. الرصيد المُعاد لا يحجز أموالًا ولا يضمن نجاح طلب لاحق.