API запроса баланса используется для получения информации о текущем балансе аккаунта CheckNumber и доступной квоте обнаружения в реальном времени.
Конечная точка API
GET https://api.checknumber.ai/v1/balance
Метод запроса
Заголовки запроса
| Параметр | Обязательный | Описание |
|---|
X-API-Key | Да | Ваш ключ API (также принимается альтернативный заголовок X-Access-Key) |
Примеры ответов
Успешный ответ
Описание полей
| Поле | Тип | Описание |
|---|
balance | number | Текущий баланс аккаунта (USD) |
Неавторизованный ответ
"message": "Требуется ключ доступа (X-API-Key или X-Access-Key)"
Коды статуса
| Код | Описание |
|---|
200 | Запрос выполнен успешно |
401 | Не авторизован: ключ API отсутствует или недействителен |
502 | Не удалось запросить баланс: ошибка вышестоящего сервиса |