getBalance : получение баланса

Адрес метода

https://api.capmonster.cloud/getBalance

формат запроса: JSON POST

Для пользователей из России также доступен альтернативный адрес метода:

https://ru.api.capmonster.cloud/getBalance

Он предназначен для снижения риска сетевых ошибок и блокировки запросов. При его использовании изменяется только адрес метода; параметры запроса, формат JSON POST, логика работы API и структура ответа остаются без изменений.

Параметры запроса

`clientKey`

Type: String
Обязательный: Да
Уникальный ключ вашей учетной записи

Пример тела запроса

{
  "clientKey": "API_KEY"
}

Структура ответа

`errorId`

Type: Integer
Идентификатор ошибки.
0 - ошибок нет, свойство errorCode отсутствует
1 - ошибка, информация о ней находится в свойстве errorCode

`errorCode`

Type: String
Код ошибки. См. глоссарий ошибок.

`balance`

Type: Decimal
Количество доступных средств на счёте

Пример

{
 "errorId":0,
 "balance": 345.678
}

Параметры запроса​

clientKey​

Пример тела запроса​

Структура ответа​

errorId​

errorCode​

balance​

Пример​