Розробникам

GET/v3/getbalance

Отримання балансу облікового запису

Отримайте збережений баланс, валюту й умови оплати для вашого облікового запису API.

На цій сторінці
  1. Запит
  2. Відповідь
  3. Помилки та використання

Отримайте баланс, валюту та значення умов оплати облікового запису, якому відповідають ваші облікові дані API. Це запит балансу; він не поповнює рахунок і не оформлює замовлення.

Запит

Використовуйте облікові дані API на стороні сервера, передаючи їх через 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Збережене значення умов оплати облікового запису. Обробник не перелічує можливі значення й не нормалізує це значення; не вважайте, що приклад охоплює всі можливі значення.

Помилки та використання

У разі невдалої автентифікації використовується спільна для API відповідь автентифікації. Цей обробник не визначає окремої помилки відсутності балансу чи розбиття на сторінки. Повернення балансу не означає резервування коштів і не гарантує успішного виконання подальшого замовлення.