अपने API क्रेडेंशियल से संबद्ध खाते की शेष राशि, मुद्रा और भुगतान की शर्तों का मान देखें। यह शेष राशि जानने के लिए है; इससे न तो खाते में धन जुड़ता है और न ही कोई ऑर्डर दिया जाता है।
अनुरोध
HTTPS पर सर्वर-साइड API क्रेडेंशियल का उपयोग करें। उदाहरण एनवायरनमेंट वेरिएबल से क्रेडेंशियल पढ़ते हैं; उनमें कोई उपयोग योग्य क्रेडेंशियल नहीं हैं। 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 प्रमाणीकरण प्रतिक्रिया का उपयोग किया जाता है। यह हैंडलर शेष राशि न मिलने के लिए कोई अलग त्रुटि या पृष्ठांकन परिभाषित नहीं करता है। प्रतिक्रिया में मिली शेष राशि का अर्थ धन आरक्षित होना नहीं है और इससे यह गारंटी नहीं मिलती कि बाद में दिया गया ऑर्डर सफल होगा।