Прочитать исходное acknowledgement и текущее состояние checkout

Авторизация

Authorization: Bearer <HALLIFY_GUEST_PAYMENT_ACCESS_TOKEN>

Приватный гостевой платёжный токен, связанный с нативным actor, tenant, источником, transport origin и текущими полномочиями. Для списания требуется явное согласие; точное раскрытие исходного результата не разрешает новую денежную команду и не предоставляет сессию аккаунта Hallify.

Руководство по подключению

Параметры

originЗаголовок · Обязательно: Фактический HTTP Origin вызывающей стороны; должен точно совпадать с текущей транспортной аудиторией платёжного доступа.
string
Полное определение
{ "type": "string", "maxLength": 2048, "example": "example" }
accessIdПуть · Обязательно: Несекретный UUID, выданный при открытии или передаче нативного платёжного доступа. Используйте с Bearer-токеном этого доступа; сам UUID полномочий не даёт.
string · uuid
Полное определение
{ "format": "uuid", "type": "string", "example": "9b6163a8-afea-4877-818b-8e2ae28a2845" }
checkoutIdПуть · Обязательно: UUID исходного checkout из сохранённого acknowledgement; раскрывается только через проверенную нативную связь текущей вызывающей стороны с этим точным ресурсом.
string · uuid
Полное определение
{ "format": "uuid", "type": "string", "example": "9b6163a8-afea-4877-818b-8e2ae28a2845" }

Ответы

200Исходное acknowledgement вместе с текущими состояниями операции, средств, нативного применения, завершённости, расписания и разрешённой навигации провайдера.

GuestPaymentProgressDto

Полное определение

{
  "$ref": "#/components/schemas/GuestPaymentProgressDto"
}

Пример ответа · 200 · application/json

{
  "receipt": {
    "schema": "hallify.restaurant-payment.command-result",
    "version": 1,
    "checkoutId": "f5ef2bdc-76ae-45b6-851a-399882860529",
    "operationId": "44352441-86e0-4a70-8642-d5863bea459a",
    "action": "CREATE_CHECKOUT",
    "state": "PREPARED",
    "currency": "USD",
    "principalAmount": "12.50",
    "tipAmount": "0.00",
    "totalAmount": "12.50"
  },
  "checkoutId": "f5ef2bdc-76ae-45b6-851a-399882860529",
  "operationId": "44352441-86e0-4a70-8642-d5863bea459a",
  "state": "PREPARED",
  "fundsState": "1.000",
  "applicationState": "example",
  "terminal": true,
  "retryAt": null,
  "provider": {
    "redirectUrl": null,
    "expiresAt": null
  }
}

400Неверное представление ограниченного запроса или ключа команды.

TranslatedErrorDto

Полное определение

{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}

Пример ответа · 400 · application/json

{
  "statusCode": 400,
  "error": "errors:http.badRequest",
  "code": "HTTP_BAD_REQUEST",
  "message": "errors:http.badRequest",
  "translationKey": "errors:http.badRequest"
}

401Отклоняет отсутствующий, неверно представленный, истёкший, отозванный или недействительный guestPaymentAccessToken на границе соответствующего домена.

TranslatedErrorDto

Полное определение

{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}

Пример ответа · 401 · application/json

{
  "statusCode": 401,
  "error": "errors:http.unauthorized",
  "code": "HTTP_UNAUTHORIZED",
  "message": "errors:http.unauthorized",
  "translationKey": "errors:http.unauthorized"
}

404Текущие нативные полномочия, приватный платёжный токен или точный исходный checkout недоступны.

TranslatedErrorDto

Полное определение

{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}

Пример ответа · 404 · application/json

{
  "statusCode": 404,
  "error": "errors:http.notFound",
  "code": "HTTP_NOT_FOUND",
  "message": "errors:http.notFound",
  "translationKey": "errors:http.notFound"
}

409Изменились нативный источник, проверенный счёт, ревизия согласия или состояние параллельной команды.

TranslatedErrorDto

Полное определение

{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}

Пример ответа · 409 · application/json

{
  "statusCode": 409,
  "error": "errors:http.conflict",
  "code": "HTTP_CONFLICT",
  "message": "errors:http.conflict",
  "translationKey": "errors:http.conflict"
}

Схемы

GuestPaymentProgressDto

Текущие состояния исходных операции checkout, средств, нативного применения и навигации вместе с первым неизменяемым acknowledgement, раскрываемые с текущими точными нативными полномочиями на ресурс.

receiptОбязательно: Неизменяемое первое PREPARED acknowledgement этого checkout с исходными командой, операцией и принятыми денежными суммами.
allOf
Полное определение
{ "description": "Неизменяемое первое PREPARED acknowledgement этого checkout с исходными командой, операцией и принятыми денежными суммами.", "allOf": [ { "$ref": "#/components/schemas/GuestPaymentCommandReceiptDto" } ], "example": { "schema": "hallify.restaurant-payment.command-result", "version": 1, "checkoutId": "f5ef2bdc-76ae-45b6-851a-399882860529", "operationId": "44352441-86e0-4a70-8642-d5863bea459a", "action": "CREATE_CHECKOUT", "state": "PREPARED", "currency": "USD", "principalAmount": "12.50", "tipAmount": "0.00", "totalAmount": "12.50" } }
checkoutIdОбязательно: UUID точного исходного checkout, разрешённого для этого раскрытия.
string · uuid
Полное определение
{ "type": "string", "format": "uuid", "description": "UUID точного исходного checkout, разрешённого для этого раскрытия.", "example": "f5ef2bdc-76ae-45b6-851a-399882860529" }
operationIdОбязательно: UUID исходной provider operation CREATE_CHECKOUT, текущее состояние которой возвращается.
string · uuid
Полное определение
{ "type": "string", "format": "uuid", "description": "UUID исходной provider operation CREATE_CHECKOUT, текущее состояние которой возвращается.", "example": "44352441-86e0-4a70-8642-d5863bea459a" }
stateОбязательно: Текущее состояние исходной provider operation. Состояние средств и нативного финансового применения возвращается в отдельных полях.
string
Полное определение
{ "type": "string", "enum": [ "PREPARED", "DISPATCHING", "PENDING", "UNKNOWN", "SUCCEEDED", "REJECTED", "RECONCILIATION_REQUIRED" ], "description": "Текущее состояние исходной provider operation. Состояние средств и нативного финансового применения возвращается в отдельных полях.", "example": "PREPARED" }
fundsStateОбязательно: Текущая сохранённая проекция средств checkout, включая неразрешённые или неизвестные сведения провайдера и разрешённые последующие финансовые операции.
string
Полное определение
{ "type": "string", "description": "Текущая сохранённая проекция средств checkout, включая неразрешённые или неизвестные сведения провайдера и разрешённые последующие финансовые операции.", "example": "1.000" }
applicationStateОбязательно: Текущее состояние нативного финансового применения checkout, включая pending, applied, blocked и reconciliation-required эффекты владельцев.
string
Полное определение
{ "type": "string", "description": "Текущее состояние нативного финансового применения checkout, включая pending, applied, blocked и reconciliation-required эффекты владельцев.", "example": "example" }
terminalОбязательно: True после сохранённого завершения без средств либо после нативных эффектов APPLIED со средствами captured, partially refunded, refunded, canceled или expired. UNKNOWN и повторяемый decline сами по себе остаются нетерминальными.
boolean
Полное определение
{ "type": "boolean", "description": "True после сохранённого завершения без средств либо после нативных эффектов APPLIED со средствами captured, partially refunded, refunded, canceled или expired. UNKNOWN и повторяемый decline сами по себе остаются нетерминальными.", "example": true }
retryAtОбязательно: Сохранённое время следующей попытки исходной операции в UTC ISO-8601, пока состояние нетерминально и не отмечено RECONCILIATION_REQUIRED; null для завершённого состояния или ручной сверки. Подсказка расписания не даёт полномочий отправки.
string · date-time · null
Полное определение
{ "type": "string", "format": "date-time", "nullable": true, "description": "Сохранённое время следующей попытки исходной операции в UTC ISO-8601, пока состояние нетерминально и не отмечено RECONCILIATION_REQUIRED; null для завершённого состояния или ручной сверки. Подсказка расписания не даёт полномочий отправки.", "example": "2026-01-15T12:00:00.000Z" }
providerОбязательно: Исходная навигация к размещённому checkout и её срок; доступность redirect определяется текущим состоянием checkout.
allOf
Полное определение
{ "description": "Исходная навигация к размещённому checkout и её срок; доступность redirect определяется текущим состоянием checkout.", "allOf": [ { "$ref": "#/components/schemas/GuestPaymentProviderNavigationDto" } ], "example": { "redirectUrl": null, "expiresAt": null } }

Полное определение

{
  "type": "object",
  "properties": {
    "receipt": {
      "description": "Неизменяемое первое PREPARED acknowledgement этого checkout с исходными командой, операцией и принятыми денежными суммами.",
      "allOf": [
        {
          "$ref": "#/components/schemas/GuestPaymentCommandReceiptDto"
        }
      ],
      "example": {
        "schema": "hallify.restaurant-payment.command-result",
        "version": 1,
        "checkoutId": "f5ef2bdc-76ae-45b6-851a-399882860529",
        "operationId": "44352441-86e0-4a70-8642-d5863bea459a",
        "action": "CREATE_CHECKOUT",
        "state": "PREPARED",
        "currency": "USD",
        "principalAmount": "12.50",
        "tipAmount": "0.00",
        "totalAmount": "12.50"
      }
    },
    "checkoutId": {
      "type": "string",
      "format": "uuid",
      "description": "UUID точного исходного checkout, разрешённого для этого раскрытия.",
      "example": "f5ef2bdc-76ae-45b6-851a-399882860529"
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "description": "UUID исходной provider operation CREATE_CHECKOUT, текущее состояние которой возвращается.",
      "example": "44352441-86e0-4a70-8642-d5863bea459a"
    },
    "state": {
      "type": "string",
      "enum": [
        "PREPARED",
        "DISPATCHING",
        "PENDING",
        "UNKNOWN",
        "SUCCEEDED",
        "REJECTED",
        "RECONCILIATION_REQUIRED"
      ],
      "description": "Текущее состояние исходной provider operation. Состояние средств и нативного финансового применения возвращается в отдельных полях.",
      "example": "PREPARED"
    },
    "fundsState": {
      "type": "string",
      "description": "Текущая сохранённая проекция средств checkout, включая неразрешённые или неизвестные сведения провайдера и разрешённые последующие финансовые операции.",
      "example": "1.000"
    },
    "applicationState": {
      "type": "string",
      "description": "Текущее состояние нативного финансового применения checkout, включая pending, applied, blocked и reconciliation-required эффекты владельцев.",
      "example": "example"
    },
    "terminal": {
      "type": "boolean",
      "description": "True после сохранённого завершения без средств либо после нативных эффектов APPLIED со средствами captured, partially refunded, refunded, canceled или expired. UNKNOWN и повторяемый decline сами по себе остаются нетерминальными.",
      "example": true
    },
    "retryAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Сохранённое время следующей попытки исходной операции в UTC ISO-8601, пока состояние нетерминально и не отмечено RECONCILIATION_REQUIRED; null для завершённого состояния или ручной сверки. Подсказка расписания не даёт полномочий отправки.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "provider": {
      "description": "Исходная навигация к размещённому checkout и её срок; доступность redirect определяется текущим состоянием checkout.",
      "allOf": [
        {
          "$ref": "#/components/schemas/GuestPaymentProviderNavigationDto"
        }
      ],
      "example": {
        "redirectUrl": null,
        "expiresAt": null
      }
    }
  },
  "description": "Текущие состояния исходных операции checkout, средств, нативного применения и навигации вместе с первым неизменяемым acknowledgement, раскрываемые с текущими точными нативными полномочиями на ресурс.",
  "required": [
    "receipt",
    "checkoutId",
    "operationId",
    "state",
    "fundsState",
    "applicationState",
    "terminal",
    "retryAt",
    "provider"
  ],
  "example": {
    "receipt": {
      "schema": "hallify.restaurant-payment.command-result",
      "version": 1,
      "checkoutId": "f5ef2bdc-76ae-45b6-851a-399882860529",
      "operationId": "44352441-86e0-4a70-8642-d5863bea459a",
      "action": "CREATE_CHECKOUT",
      "state": "PREPARED",
      "currency": "USD",
      "principalAmount": "12.50",
      "tipAmount": "0.00",
      "totalAmount": "12.50"
    },
    "checkoutId": "f5ef2bdc-76ae-45b6-851a-399882860529",
    "operationId": "44352441-86e0-4a70-8642-d5863bea459a",
    "state": "PREPARED",
    "fundsState": "1.000",
    "applicationState": "example",
    "terminal": true,
    "retryAt": null,
    "provider": {
      "redirectUrl": null,
      "expiresAt": null
    }
  }
}

GuestPaymentCommandReceiptDto

Неизменяемое первое PREPARED acknowledgement постоянной гостевой команды CREATE_CHECKOUT, сохраняемое при точном replay и восстановлении исходной команды.

schemaОбязательно: Дискриминатор версионированного документа исходного результата платёжной команды.
string
Полное определение
{ "type": "string", "enum": [ "hallify.restaurant-payment.command-result" ], "description": "Дискриминатор версионированного документа исходного результата платёжной команды.", "example": "hallify.restaurant-payment.command-result" }
versionОбязательно: Версия схемы результата команды, сохранённая этим acknowledgement.
integer
Полное определение
{ "type": "integer", "enum": [ 1 ], "description": "Версия схемы результата команды, сохранённая этим acknowledgement.", "example": 1 }
checkoutIdОбязательно: UUID исходного checkout, выделенного один раз для этой постоянной команды.
string · uuid
Полное определение
{ "type": "string", "format": "uuid", "description": "UUID исходного checkout, выделенного один раз для этой постоянной команды.", "example": "f5ef2bdc-76ae-45b6-851a-399882860529" }
operationIdОбязательно: UUID исходной provider operation CREATE_CHECKOUT; replay и восстановление сохраняют идентичность этой операции.
string · uuid
Полное определение
{ "type": "string", "format": "uuid", "description": "UUID исходной provider operation CREATE_CHECKOUT; replay и восстановление сохраняют идентичность этой операции.", "example": "44352441-86e0-4a70-8642-d5863bea459a" }
actionОбязательно: Действие исходной принятой команды; эта гостевая граница подтверждает CREATE_CHECKOUT.
string
Полное определение
{ "type": "string", "enum": [ "CREATE_CHECKOUT" ], "description": "Действие исходной принятой команды; эта гостевая граница подтверждает CREATE_CHECKOUT.", "example": "CREATE_CHECKOUT" }
stateОбязательно: Состояние первого сохранённого acknowledgement, всегда PREPARED. Текущие состояния операции, средств и нативного применения возвращаются методом progress checkout.
string
Полное определение
{ "type": "string", "enum": [ "PREPARED" ], "description": "Состояние первого сохранённого acknowledgement, всегда PREPARED. Текущие состояния операции, средств и нативного применения возвращаются методом progress checkout.", "example": "PREPARED" }
currencyОбязательно: Валюта исходных зафиксированных основной суммы, чаевых и итога.
string
Полное определение
{ "type": "string", "enum": [ "USD", "GEL" ], "description": "Валюта исходных зафиксированных основной суммы, чаевых и итога.", "example": "USD" }
principalAmountОбязательно: Исходная зафиксированная основная сумма до отдельно принятых чаевых строкой с двумя дробными знаками в валюте результата.
string
Полное определение
{ "type": "string", "example": "12.50", "description": "Исходная зафиксированная основная сумма до отдельно принятых чаевых строкой с двумя дробными знаками в валюте результата." }
tipAmountОбязательно: Исходные зафиксированные чаевые, принятые с командой, неотрицательной строкой с двумя дробными знаками в валюте результата.
string
Полное определение
{ "type": "string", "example": "0.00", "description": "Исходные зафиксированные чаевые, принятые с командой, неотрицательной строкой с двумя дробными знаками в валюте результата." }
totalAmountОбязательно: Исходная сумма зафиксированных основной суммы и принятых чаевых строкой с двумя дробными знаками в валюте результата.
string
Полное определение
{ "type": "string", "example": "12.50", "description": "Исходная сумма зафиксированных основной суммы и принятых чаевых строкой с двумя дробными знаками в валюте результата." }

Полное определение

{
  "type": "object",
  "properties": {
    "schema": {
      "type": "string",
      "enum": [
        "hallify.restaurant-payment.command-result"
      ],
      "description": "Дискриминатор версионированного документа исходного результата платёжной команды.",
      "example": "hallify.restaurant-payment.command-result"
    },
    "version": {
      "type": "integer",
      "enum": [
        1
      ],
      "description": "Версия схемы результата команды, сохранённая этим acknowledgement.",
      "example": 1
    },
    "checkoutId": {
      "type": "string",
      "format": "uuid",
      "description": "UUID исходного checkout, выделенного один раз для этой постоянной команды.",
      "example": "f5ef2bdc-76ae-45b6-851a-399882860529"
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "description": "UUID исходной provider operation CREATE_CHECKOUT; replay и восстановление сохраняют идентичность этой операции.",
      "example": "44352441-86e0-4a70-8642-d5863bea459a"
    },
    "action": {
      "type": "string",
      "enum": [
        "CREATE_CHECKOUT"
      ],
      "description": "Действие исходной принятой команды; эта гостевая граница подтверждает CREATE_CHECKOUT.",
      "example": "CREATE_CHECKOUT"
    },
    "state": {
      "type": "string",
      "enum": [
        "PREPARED"
      ],
      "description": "Состояние первого сохранённого acknowledgement, всегда PREPARED. Текущие состояния операции, средств и нативного применения возвращаются методом progress checkout.",
      "example": "PREPARED"
    },
    "currency": {
      "type": "string",
      "enum": [
        "USD",
        "GEL"
      ],
      "description": "Валюта исходных зафиксированных основной суммы, чаевых и итога.",
      "example": "USD"
    },
    "principalAmount": {
      "type": "string",
      "example": "12.50",
      "description": "Исходная зафиксированная основная сумма до отдельно принятых чаевых строкой с двумя дробными знаками в валюте результата."
    },
    "tipAmount": {
      "type": "string",
      "example": "0.00",
      "description": "Исходные зафиксированные чаевые, принятые с командой, неотрицательной строкой с двумя дробными знаками в валюте результата."
    },
    "totalAmount": {
      "type": "string",
      "example": "12.50",
      "description": "Исходная сумма зафиксированных основной суммы и принятых чаевых строкой с двумя дробными знаками в валюте результата."
    }
  },
  "description": "Неизменяемое первое PREPARED acknowledgement постоянной гостевой команды CREATE_CHECKOUT, сохраняемое при точном replay и восстановлении исходной команды.",
  "required": [
    "schema",
    "version",
    "checkoutId",
    "operationId",
    "action",
    "state",
    "currency",
    "principalAmount",
    "tipAmount",
    "totalAmount"
  ],
  "example": {
    "schema": "hallify.restaurant-payment.command-result",
    "version": 1,
    "checkoutId": "f5ef2bdc-76ae-45b6-851a-399882860529",
    "operationId": "44352441-86e0-4a70-8642-d5863bea459a",
    "action": "CREATE_CHECKOUT",
    "state": "PREPARED",
    "currency": "USD",
    "principalAmount": "12.50",
    "tipAmount": "0.00",
    "totalAmount": "12.50"
  }
}

GuestPaymentProviderNavigationDto

Навигация к исходному размещённому checkout провайдера, когда она разрешена сейчас, с сохранённым сроком провайдера или checkout; сама навигация не подтверждает финансовый результат.

redirectUrlОбязательно: Исходный URL перенаправления провайдера, когда отправка существует, состояние checkout допускает навигацию и срок не прошёл; иначе null. Возврат с этого URL не подтверждает оплату.
string · null
Полное определение
{ "type": "string", "nullable": true, "description": "Исходный URL перенаправления провайдера, когда отправка существует, состояние checkout допускает навигацию и срок не прошёл; иначе null. Возврат с этого URL не подтверждает оплату.", "example": "https://example.test/resource" }
expiresAtОбязательно: Срок навигации в UTC ISO-8601: сохранённый срок провайдера либо исходный срок checkout как запасное значение.
string · date-time · null
Полное определение
{ "type": "string", "format": "date-time", "nullable": true, "description": "Срок навигации в UTC ISO-8601: сохранённый срок провайдера либо исходный срок checkout как запасное значение.", "example": "2026-12-31T18:00:00.000Z" }

Полное определение

{
  "type": "object",
  "properties": {
    "redirectUrl": {
      "type": "string",
      "nullable": true,
      "description": "Исходный URL перенаправления провайдера, когда отправка существует, состояние checkout допускает навигацию и срок не прошёл; иначе null. Возврат с этого URL не подтверждает оплату.",
      "example": "https://example.test/resource"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Срок навигации в UTC ISO-8601: сохранённый срок провайдера либо исходный срок checkout как запасное значение.",
      "example": "2026-12-31T18:00:00.000Z"
    }
  },
  "description": "Навигация к исходному размещённому checkout провайдера, когда она разрешена сейчас, с сохранённым сроком провайдера или checkout; сама навигация не подтверждает финансовый результат.",
  "required": [
    "redirectUrl",
    "expiresAt"
  ],
  "example": {
    "redirectUrl": null,
    "expiresAt": null
  }
}

TranslatedErrorDto

Стабильная оболочка ошибки общего обработчика HTTP-исключений. Дополнительные машинные данные домена вложены в details.

statusCodeОбязательно: HTTP-статус, повторённый из ответа.
integer
Полное определение
{ "type": "integer", "description": "HTTP-статус, повторённый из ответа.", "example": 400 }
errorОбязательно: Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.
string
Полное определение
{ "type": "string", "description": "Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.", "example": "errors.request.invalid" }
codeОбязательно: Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями.
string
Полное определение
{ "type": "string", "example": "HTTP_BAD_REQUEST", "description": "Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями." }
messageОбязательно: Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе.
string
Полное определение
{ "type": "string", "example": "errors:http.badRequest", "description": "Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе." }
translationKeyОбязательно: Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте.
string
Полное определение
{ "type": "string", "example": "errors:http.badRequest", "description": "Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте." }
translationValuesНеобязательно: Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.
object
Полное определение
{ "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "example": "example" }, { "type": "number", "example": 0 }, { "type": "boolean", "example": true } ], "example": "example" }, "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.", "example": { "exampleKey": "example" } }
validationErrorsНеобязательно: Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.
array
Полное определение
{ "description": "Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.", "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorDto" }, "example": [ { "field": "email", "translationKey": "validation:isEmail", "code": "isEmail", "message": "validation:isEmail" } ] }
detailsНеобязательно: Необязательные сведения о доменных препятствиях или ошибках валидации.
oneOf
Полное определение
{ "description": "Необязательные сведения о доменных препятствиях или ошибках валидации.", "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JsonValue" }, "example": [ "example" ] }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "example": { "exampleKey": "example" } } ], "example": [ "example" ] }

Полное определение

{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "description": "HTTP-статус, повторённый из ответа.",
      "example": 400
    },
    "error": {
      "type": "string",
      "description": "Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.",
      "example": "errors.request.invalid"
    },
    "code": {
      "type": "string",
      "example": "HTTP_BAD_REQUEST",
      "description": "Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями."
    },
    "message": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе."
    },
    "translationKey": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
      "example": {
        "exampleKey": "example"
      }
    },
    "validationErrors": {
      "description": "Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorDto"
      },
      "example": [
        {
          "field": "email",
          "translationKey": "validation:isEmail",
          "code": "isEmail",
          "message": "validation:isEmail"
        }
      ]
    },
    "details": {
      "description": "Необязательные сведения о доменных препятствиях или ошибках валидации.",
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/JsonValue"
          },
          "example": [
            "example"
          ]
        },
        {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/components/schemas/JsonValue"
          },
          "example": {
            "exampleKey": "example"
          }
        }
      ],
      "example": [
        "example"
      ]
    }
  },
  "required": [
    "statusCode",
    "error",
    "code",
    "message",
    "translationKey"
  ],
  "description": "Стабильная оболочка ошибки общего обработчика HTTP-исключений. Дополнительные машинные данные домена вложены в details.",
  "example": {
    "statusCode": 400,
    "error": "errors:http.badRequest",
    "code": "HTTP_BAD_REQUEST",
    "message": "errors:http.badRequest",
    "translationKey": "errors:http.badRequest"
  }
}

ValidationErrorDto

Ошибка проверки поля с путём поля, стабильным кодом валидатора и ключом перевода. Человекочитаемый текст принадлежит приложению-потребителю.

fieldОбязательно: Публичный путь поля. Вложенные свойства и индексы массива разделены точками.
string
Полное определение
{ "type": "string", "example": "email", "description": "Публичный путь поля. Вложенные свойства и индексы массива разделены точками." }
translationKeyОбязательно: Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers.
string
Полное определение
{ "type": "string", "example": "validation:isEmail", "description": "Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers." }
codeОбязательно: Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы.
string
Полное определение
{ "type": "string", "example": "isEmail", "description": "Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы." }
messageОбязательно: Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются.
string
Полное определение
{ "type": "string", "example": "validation:isEmail", "description": "Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются." }
translationValuesНеобязательно: Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.
object
Полное определение
{ "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "example": "example" }, { "type": "number", "example": 0 }, { "type": "boolean", "example": true } ], "example": "example" }, "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.", "example": { "exampleKey": "example" } }

Полное определение

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "example": "email",
      "description": "Публичный путь поля. Вложенные свойства и индексы массива разделены точками."
    },
    "translationKey": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers."
    },
    "code": {
      "type": "string",
      "example": "isEmail",
      "description": "Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы."
    },
    "message": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
      "example": {
        "exampleKey": "example"
      }
    }
  },
  "required": [
    "field",
    "translationKey",
    "code",
    "message"
  ],
  "description": "Ошибка проверки поля с путём поля, стабильным кодом валидатора и ключом перевода. Человекочитаемый текст принадлежит приложению-потребителю.",
  "example": {
    "field": "email",
    "translationKey": "validation:isEmail",
    "code": "isEmail",
    "message": "validation:isEmail"
  }
}

JsonValue

Рекурсивно допустимое JSON-значение. Используется только там, где контракт явно разрешает произвольные структурированные данные.

Полное определение

{
  "oneOf": [
    {
      "type": "string",
      "nullable": true,
      "example": "example"
    },
    {
      "type": "number",
      "example": 0
    },
    {
      "type": "boolean",
      "example": true
    },
    {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": [
        "example"
      ]
    },
    {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": {
        "exampleKey": "example"
      }
    }
  ],
  "description": "Рекурсивно допустимое JSON-значение. Используется только там, где контракт явно разрешает произвольные структурированные данные.",
  "example": "example"
}