Аккаунты

Получить операцию оплаты аккаунта

Просмотреть расчёты и результаты создания, удаления и возврата средств для аккаунтов этого пространства.

GEThttps://api.unifyport.ai/v1/account-operations/{operation_id}

Поддерживаемые каналы

all

Перед вызовом

Используйте X-Api-Key нужного рабочего пространства на сервере. Перед запуском замените все заполнители.

Используйте API Key нужного пространства. Аккаунты с оплатой из кошелька оплачиваются в USD на 30 дней. Баланс и пополнение доступны в Dashboard.

Параметры запроса

Заголовки

X-Api-Key

stringобязательно

API-ключ рабочей области. Рабочая область определяется по этому заголовку.

Параметры пути

operation_id

stringобязательно

Публичный ID из billing.operation_id или ответа удаления; используйте неизменным в исходном пространстве.

Тело запроса

Этот эндпоинт не требует JSON-тела запроса.

Как понять результат

Сохраните operation_id. PENDING/PROCESSING требуют ожидания, REVIEW — сверки. SUCCEEDED/FAILED относятся к операции, не авторизации или автоматическому возврату. Проверяйте записи кошелька.

Ответ 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "operation_id": "op_example",
    "kind": "DELETE",
    "state": "REVIEW",
    "account_id": "acc_example",
    "last_error_code": "cleanup_unconfirmed"
  }
}

Тело ответа

operation_id

string

Публичный ID из billing.operation_id или ответа удаления; используйте неизменным в исходном пространстве.

kind

string

Публичный тип: QUOTE / CREATE, DELETE или COMPENSATE.

enum: QUOTE, CREATE, DELETE, COMPENSATE

state

string

Состояние оплаты или операции не доказывает авторизацию, подключение или зачисление возврата.

enum: QUOTED, CONSUMED, EXPIRED, PENDING, PROCESSING, SUCCEEDED, FAILED, REVIEW

account_id

string

Публичный ID аккаунта сообщений этого пространства.

last_error_code

string

Безопасный публичный код результата; отсутствие не доказывает успех.

Ответы

200

200 OK

Запрос выполнен. См. пример тела ответа.

400

Bad Request

Тело запроса, путь или параметры некорректны.

401

Unauthorized

Заголовок X-Api-Key отсутствует или недействителен.

403

Forbidden

Запрос распознан, но операция запрещена.

404

Not Found

Запрошенный ресурс не найден. Сверьте error.code с текущей операцией.

409

Conflict

Запрошенная операция конфликтует с существующим аккаунтом провайдера или ресурсом.

503

Service Unavailable

Необходимая серверная служба временно недоступна.

При ошибке запроса

Проверьте HTTP и error.code/numeric_code, сохраните request_id. Исправьте параметры, завершите авторизацию или проверьте runtime. До повторной отправки или записи выясните результат предыдущей попытки. Справочник ошибок

Сопоставляйте HTTP-статус, error.code и error.numeric_code с текущей операцией. Числовой код — строка. Сохраняйте request_id для диагностики: это не ключ идемпотентности и не идентификатор задачи.

invalid_request · 10000 · 400

Проверьте JSON и обязательные поля.

Условие: Применяется, если тело запроса непустое, а Content-Type отличается от application/json.

Действия и повторы: Исправьте параметры с учётом операции и канала. Повтор неизменённого неверного запроса не устранит ошибку.

Пример JSON; message зависит от фактической причины · 400 · 10000

{
  "request_id": "req_example",
  "error": {
    "code": "invalid_request",
    "numeric_code": "10000",
    "message": "Content-Type must be application/json"
  }
}

invalid_target_workspace · 11003 · 400

Целевое рабочее пространство в заголовке переопределения пусто или задано неверно. Удалите этот заголовок и используйте API-ключ нужного пространства.

Условие: Применяется к запросам с заголовком переопределения рабочего пространства X-Workspace-Id.

Пример JSON; message зависит от фактической причины · 400 · 11003

{
  "request_id": "req_example",
  "error": {
    "code": "invalid_target_workspace",
    "numeric_code": "11003",
    "message": "Invalid target workspace"
  }
}

invalid_api_key · 11001 · 401

Проверьте правильность и активность ключа API.

Действия и повторы: Сохраните request_id и структурированные коды; выясните причину текущего сбоя перед следующим действием.

Пример JSON; message зависит от фактической причины · 401 · 11001

{
  "request_id": "req_example",
  "error": {
    "code": "invalid_api_key",
    "numeric_code": "11001",
    "message": "Invalid API key"
  }
}

missing_api_key · 11000 · 401

Добавьте заголовок X-Api-Key.

Пример · 401 · 11000

{
  "request_id": "req_xxx",
  "error": {
    "code": "missing_api_key",
    "numeric_code": "11000",
    "message": "Missing X-Api-Key header"
  }
}

workspace_override_forbidden · 11002 · 403

Запрос пытается переопределить рабочее пространство без необходимых прав. Удалите заголовок переопределения и используйте API-ключ нужного рабочего пространства.

Условие: Применяется к запросам с заголовком переопределения рабочего пространства X-Workspace-Id.

Пример JSON; message зависит от фактической причины · 403 · 11002

{
  "request_id": "req_example",
  "error": {
    "code": "workspace_override_forbidden",
    "numeric_code": "11002",
    "message": "Workspace override is not allowed"
  }
}

account_operation_not_found · 20029 · 404

Операция отсутствует или относится к другому пространству. Проверьте исходный operation_id и область API Key.

Действия и повторы: Проверьте идентификатор, принадлежность ресурса и текущее рабочее пространство. Не повторяйте запрос автоматически, считая подтверждённое отсутствие или недоступность временным сбоем сервиса.

Пример JSON; message зависит от фактической причины · 404 · 20029

{
  "request_id": "req_example",
  "error": {
    "code": "account_operation_not_found",
    "numeric_code": "20029",
    "message": "Account operation not found"
  }
}

target_workspace_not_found · 11004 · 404

Переопределённое рабочее пространство не найдено или недоступно. Проверьте его принадлежность, удалите заголовок переопределения и используйте нужный API-ключ; повторы не дадут доступ.

Условие: Применяется к запросам с заголовком переопределения рабочего пространства X-Workspace-Id.

Пример JSON; message зависит от фактической причины · 404 · 11004

{
  "request_id": "req_example",
  "error": {
    "code": "target_workspace_not_found",
    "numeric_code": "11004",
    "message": "Target workspace not found"
  }
}

wallet_workspace_disabled · 20022 · 409

Новые покупки с баланса отключены; существующие операции не считаются отменёнными.

Пример JSON; message зависит от фактической причины · 409 · 20022

{
  "request_id": "req_example",
  "error": {
    "code": "wallet_workspace_disabled",
    "numeric_code": "20022",
    "message": "New wallet purchases are disabled"
  }
}

wallet_unavailable · 20028 · 503

Данные или настройки кошелька недоступны. Результат записи может быть неизвестен; проверьте исходную операцию.

Действия и повторы: Сохраните request_id, проверьте идентификаторы и доступ аккаунта. Повторяйте чтение после проверки причины; неудачный запрос не доказывает отсутствие ресурса или пустой результат.

Пример JSON; message зависит от фактической причины · 503 · 20028

{
  "request_id": "req_example",
  "error": {
    "code": "wallet_unavailable",
    "numeric_code": "20028",
    "message": "Wallet service is unavailable"
  }
}