Перейти к содержимому

API Запроса Баланса

API запроса баланса используется для получения информации о текущем балансе аккаунта CheckNumber и доступной квоте обнаружения в реальном времени.

Конечная точка API

GET https://api.checknumber.ai/v1/balance

Метод запроса

Заголовки запроса

ПараметрОбязательныйОписание
X-API-KeyДаВаш ключ API (также принимается альтернативный заголовок X-Access-Key)

Примеры ответов

Успешный ответ

{
"balance": 9850.50
}

Описание полей

ПолеТипОписание
balancenumberТекущий баланс аккаунта (USD)

Неавторизованный ответ

{
"error": "unauthorized",
"message": "Требуется ключ доступа (X-API-Key или X-Access-Key)"
}

Коды статуса

КодОписание
200Запрос выполнен успешно
401Не авторизован: ключ API отсутствует или недействителен
502Не удалось запросить баланс: ошибка вышестоящего сервиса