GET /api/v1/balance и GET /api/v1/tariffs

Баланс и тарифы

Методы дают программную сверку баланса, валюты, активного пакета и тарифных цен. Их используют перед запуском проверок и в финансовом интерфейсе партнёра.

Открыть в Swagger API в базе знаний

Кратко для ИИ

Когда использовать

Показать доступный баланс, предупредить о 402 заранее и синхронизировать цены с кабинетом RealIQ.

Карта методов

Связанные методы

Эта страница описывает группу связанных методов. Для точной схемы параметров используйте Swagger, для продуктовой логики — блоки ниже.

GET/api/v1/balance

Текущий баланс, валюта, тариф и активный пакет.

GET/api/v1/tariffs

Таблица цен по проверкам, документам, оценке и мониторингу.

GET/api/v1/account

Информация об аккаунте, режиме ключа и правах доступа.

Сценарий

Как проходит сценарий

Шаг 1

Проверка аккаунта

GET /account помогает понять режим и права доступа ключа.

Шаг 2

Показ цен

GET /tariffs синхронизирует цены с кабинетом RealIQ.

Шаг 3

Проверка баланса

GET /balance перед запуском снижает риск 402 insufficient_funds.

Обязательные поля

Поле	Обяз.	Описание
X-API-KEY	Да	Ключ агентства.
type	Нет	Для tariffs можно читать цены по типам проверок и мониторинга.

Пример curl

curl https://api.realiq.ru/api/v1/balance \
  -H "X-API-KEY: riq_live_xxx"

JSON-запрос

Пример JSON-запроса

Для GET-методов показано JSON-представление URL, query-параметров и заголовков. Для загрузки файла показана структура form-data.

{
  "method": "GET",
  "endpoint": "/api/v1/balance",
  "headers": {
    "X-API-KEY": "riq_live_xxx"
  }
}

JSON-ответ

Пример успешного JSON-ответа

Пример отражает структуру реального ответа API. Значения ID, SHA и ссылок сокращены или заменены демонстрационными.

{
  "balance": 12410,
  "currency": "RUB",
  "tier_name": "Старт",
  "active_package": {
    "id": 15,
    "name": "Старт",
    "started_at": "2026-06-20T10:00:00Z",
    "expires_at": null,
    "remaining_amount": 12410
  },
  "request_id": "req_1780000000_abcd"
}

Полный JSON-ответ

Полный пример ответа

Развёрнутый пример показывает, какие блоки обычно получает интегратор. Значения ID, SHA, ссылок и персональных данных демонстрационные.

{
  "balance": 12410,
  "currency": "RUB",
  "tier_name": "Старт",
  "active_package": {
    "id": 15,
    "name": "Старт",
    "started_at": "2026-06-20T10:00:00Z",
    "expires_at": null,
    "remaining_amount": 12410
  },
  "request_id": "req_1780000000_abcd"
}

Поля ответа

Как читать поля ответа

Поле	Что означает
balance	Доступный баланс агентства.
tier_name	Тариф, по которому считаются цены.
active_package	Активный пакет или null.
GET /tariffs	Для таблицы цен используйте отдельный метод тарифов.

Ошибки

Типовые ошибки метода

HTTP 401unauthorized

Неверный API-ключ.

Что делать: Проверьте X-API-KEY.

{
  "error_code": "unauthorized",
  "message": "Неверный API-ключ.",
  "request_id": "req_1780000000_abcd"
}

HTTP 403scope_denied

У ключа нет scope balance.

Что делать: Выдайте ключу нужный scope в кабинете.

{
  "error_code": "scope_denied",
  "message": "У ключа нет scope balance.",
  "request_id": "req_1780000000_abcd"
}

Ответ processing

{
  "balance": 12410,
  "currency": "RUB",
  "tier_name": "Старт",
  "active_package": {
    "name": "Старт",
    "remaining_amount": 12410
  },
  "request_id": "req_..."
}

Ответ report_ready

{
  "checks": { "seller": 390, "object": 290, "full": 650 },
  "monitoring": { "seller": 234, "object": 174, "full": 390 }
}

Пример ошибки

{
  "error_code": "scope_denied",
  "message": "API-ключ не разрешает метод balance.",
  "request_id": "req_..."
}

Что списывается с баланса

Методы не списывают баланс.

Какие поля доказательного блока вернутся

Доказательный блок не создаётся: это служебные финансовые методы.
ApiCallLog фиксирует request_id.