Документация · v1

Creodock API

Все операции
GETИнтерфейс Creodock

Получить список: баланс аккаунта

Возвращает баланс аккаунта. Запрос предназначен для чтения и не изменяет данные.

OpenAPI: List immutable personal balance ledger entries

GEThttps://api.creodock.com/api/v1/me/balance/operations
Кто вызывает
Интерфейс Creodock
Операция выполняется от имени вошедшего пользователя через защищённую cookie-сессию.
Доступ
Определяется ролью и принадлежностью объекта
Отдельный scope не объявлен в OpenAPI. Сервер проверяет роль и рабочую область.

Что произойдёт

Поведение, которое важно учесть до отправки запроса.

  • Не изменяет данные и подходит для безопасного повторного чтения.
  • Повторный запрос возвращает актуальное состояние ресурса.

Параметры

Где передать значение, обязательно ли оно и откуда его получить.

ПолеГдеТипОписание
cursorНеобязательно
querystring
Непрозрачный курсор следующей страницы из предыдущего ответа.
limitНеобязательно
queryinteger
Максимальное количество элементов в ответе.Минимум: 1 · Максимум: 50Пример: 8
categoryНеобязательно
querystring
Параметр фильтрации или управления выдачей: category.Допустимо: top_up, referral, subscription, adjustmentПример: top_up
stateНеобязательно
querystring
Параметр фильтрации или управления выдачей: state.Допустимо: awaiting_transfer, confirming, posted, debited, expired, review, failedПример: awaiting_transfer
searchНеобязательно
querystring
Поисковая строка. Совпадения зависят от конкретного реестра.Максимальная длина: 120

Ответы

Все состояния ответа, объявленные этой операцией в OpenAPI.

200

Cursor page of ledger entries

application/json

Схема: AccountBalanceEntryPage

ПолеТипОписание
dataОбязательно
AccountBalanceEntry[]
Элементы текущей страницы результата.
nextCursorОбязательно
object
Непрозрачный курсор следующей страницы; отсутствует на последней странице.
{
  "data": [
    {
      "amount": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 1
      },
      "createdAt": "2026-09-05T12:00:00Z",
      "description": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "kind": "referral_pending",
      "sourceId": "string",
      "sourceType": "string",
      "state": "awaiting_transfer"
    }
  ]
}