ڈیولپرز

GET/v3/getbalance

اکاؤنٹ کا بیلنس معلوم کریں

اپنے API اکاؤنٹ کا محفوظ شدہ بیلنس، کرنسی اور ادائیگی کی شرائط معلوم کریں۔

اس صفحے پر
  1. درخواست
  2. جواب
  3. خرابیاں اور استعمال

اپنی API اسناد سے متعلق اکاؤنٹ کا بیلنس، کرنسی اور ادائیگی کی شرائط کی قدر معلوم کریں۔ یہ صرف بیلنس معلوم کرنے کی کارروائی ہے؛ اس سے رقم شامل نہیں ہوتی اور نہ ہی کوئی آرڈر دیا جاتا ہے۔

درخواست

سرور کی جانب استعمال ہونے والی API اسناد HTTPS کے ذریعے استعمال کریں۔ مثالیں اسناد کو ماحولیاتی متغیرات سے پڑھتی ہیں؛ ان میں کوئی قابلِ استعمال اسناد شامل نہیں ہیں۔ JSON باڈی میں status.code کے ساتھ 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اکاؤنٹ کی ادائیگی کی شرائط کی محفوظ شدہ قدر۔ ہینڈلر اس کی ممکنہ قدروں کی فہرست نہیں دیتا اور نہ ہی اسے کسی معیاری صورت میں تبدیل کرتا ہے؛ یہ فرض نہ کریں کہ مثال میں تمام ممکنہ قدریں شامل ہیں۔

خرابیاں اور استعمال

تصدیقِ شناخت ناکام ہونے پر API کا مشترکہ تصدیقِ شناخت کا جواب استعمال ہوتا ہے۔ یہ ہینڈلر بیلنس موجود نہ ہونے کے لیے کوئی الگ خرابی یا صفحہ بندی متعین نہیں کرتا۔ جواب میں بیلنس ملنے سے رقم مختص نہیں ہوتی اور نہ ہی اس بات کی ضمانت ملتی ہے کہ بعد میں دیا جانے والا آرڈر کامیاب ہوگا۔