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

Creodock API

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

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

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

OpenAPI: Read account-scoped Creodock credit totals

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

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

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

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

Ответы

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

200

Personal balance

application/json

Схема: PersonalBalance

ПолеТипОписание
availableОбязательно
MoneyUsd
Поле «available» в структуре запроса или ответа.
topUpОбязательно
object
Поле «topUp» в структуре запроса или ответа.
{
  "available": {
    "amountMinor": "string",
    "currency": "string",
    "scale": 1
  },
  "topUp": {
    "available": true,
    "networks": [
      {
        "confirmationsRequired": 1,
        "id": "string",
        "label": "string"
      }
    ]
  }
}