Разработчикам

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 ответ об ошибке аутентификации. Этот обработчик не предусматривает отдельной ошибки отсутствия баланса или постраничного вывода. Возвращённый баланс не означает резервирования средств и не гарантирует успешного выполнения последующего заказа.