Принять точное предложение и создать его исходный 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" }
idempotency-keyЗаголовок · Обязательно: Обязательный ключ идемпотентности длиной до 128 символов.
string
Полное определение
{ "type": "string", "minLength": 1, "maxLength": 128, "example": "example" }

Тело запроса

Обязательно

UUID и ревизия предложенного согласия, полный manifestHash, boolean accepted со значением true и точные предложенные версия, digest и язык terms.

application/json

GuestPaymentAcceptRequestDto

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

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

Ответы

200Неизменяемое первое PREPARED acknowledgement исходной принятой команды checkout, возвращаемое также при точном replay; текущее финансовое состояние доступно через progress checkout.

GuestPaymentCommandReceiptDto

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

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

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

{
  "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"
}

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"
}

Схемы

GuestPaymentAcceptRequestDto

Явное принятие одного сохранённого финансового предложения с предложенной ревизией, digest полного manifest и точной идентичностью terms.

consentIdОбязательно: UUID offer согласия, сохранённого для этого платёжного доступа и нативного actor.
string · uuid
Полное определение
{ "type": "string", "format": "uuid", "description": "UUID offer согласия, сохранённого для этого платёжного доступа и нативного actor.", "example": "a78d3537-1595-4dbd-8fad-560c53ecc15c" }
revisionОбязательно: Положительная ревизия согласия OFFERED из offer receipt. Потребление увеличивает сохранённую ревизию; точный replay команды сохраняет исходное acknowledgement.
integer
Полное определение
{ "type": "integer", "minimum": 1, "description": "Положительная ревизия согласия OFFERED из offer receipt. Потребление увеличивает сохранённую ревизию; точный replay команды сохраняет исходное acknowledgement.", "example": 1 }
manifestHashОбязательно: SHA-256 digest полного неизменяемого предложенного manifest в нижнем регистре, скопированный из consent receipt; связывает принимаемые зафиксированные полномочия, сбор средств и terms.
string
Полное определение
{ "type": "string", "pattern": "^[a-f0-9]{64}$", "description": "SHA-256 digest полного неизменяемого предложенного manifest в нижнем регистре, скопированный из consent receipt; связывает принимаемые зафиксированные полномочия, сбор средств и terms.", "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef" }
acceptedОбязательно: Явное утвердительное финансовое согласие. Runtime принимает только boolean true после проверки показанных offer и terms.
boolean
Полное определение
{ "type": "boolean", "enum": [ true ], "description": "Явное утвердительное финансовое согласие. Runtime принимает только boolean true после проверки показанных offer и terms.", "example": true }
termsОбязательно: Точные версия, digest и язык из предложенного consent receipt, определяющие текст, принимаемый с этим manifest.
allOf
Полное определение
{ "description": "Точные версия, digest и язык из предложенного consent receipt, определяющие текст, принимаемый с этим manifest.", "allOf": [ { "$ref": "#/components/schemas/GuestPaymentTermsDto" } ], "example": { "version": "example", "digest": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef", "locale": "en" } }

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

{
  "type": "object",
  "properties": {
    "consentId": {
      "type": "string",
      "format": "uuid",
      "description": "UUID offer согласия, сохранённого для этого платёжного доступа и нативного actor.",
      "example": "a78d3537-1595-4dbd-8fad-560c53ecc15c"
    },
    "revision": {
      "type": "integer",
      "minimum": 1,
      "description": "Положительная ревизия согласия OFFERED из offer receipt. Потребление увеличивает сохранённую ревизию; точный replay команды сохраняет исходное acknowledgement.",
      "example": 1
    },
    "manifestHash": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$",
      "description": "SHA-256 digest полного неизменяемого предложенного manifest в нижнем регистре, скопированный из consent receipt; связывает принимаемые зафиксированные полномочия, сбор средств и terms.",
      "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
    },
    "accepted": {
      "type": "boolean",
      "enum": [
        true
      ],
      "description": "Явное утвердительное финансовое согласие. Runtime принимает только boolean true после проверки показанных offer и terms.",
      "example": true
    },
    "terms": {
      "description": "Точные версия, digest и язык из предложенного consent receipt, определяющие текст, принимаемый с этим manifest.",
      "allOf": [
        {
          "$ref": "#/components/schemas/GuestPaymentTermsDto"
        }
      ],
      "example": {
        "version": "example",
        "digest": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
        "locale": "en"
      }
    }
  },
  "description": "Явное принятие одного сохранённого финансового предложения с предложенной ревизией, digest полного manifest и точной идентичностью terms.",
  "required": [
    "consentId",
    "revision",
    "manifestHash",
    "accepted",
    "terms"
  ],
  "example": {
    "consentId": "a78d3537-1595-4dbd-8fad-560c53ecc15c",
    "revision": 1,
    "manifestHash": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
    "accepted": true,
    "terms": {
      "version": "example",
      "digest": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
      "locale": "en"
    }
  }
}

GuestPaymentTermsDto

Версия, SHA-256 digest и язык, определяющие точный показанный текст платёжного согласия.

versionОбязательно: Непустая версия показанного текста согласия; при принятии должна точно совпадать с версией, сохранённой в offer.
string
Полное определение
{ "type": "string", "maxLength": 64, "description": "Непустая версия показанного текста согласия; при принятии должна точно совпадать с версией, сохранённой в offer.", "example": "example" }
digestОбязательно: SHA-256 digest в нижнем регистре, связывающий версию terms, язык и точный показанный текст; при принятии повторяется предложенный digest.
string
Полное определение
{ "type": "string", "pattern": "^[a-f0-9]{64}$", "description": "SHA-256 digest в нижнем регистре, связывающий версию terms, язык и точный показанный текст; при принятии повторяется предложенный digest.", "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef" }
localeОбязательно: Язык, охваченный показанным текстом согласия и digest; при принятии должен совпадать с языком, сохранённым в offer.
string
Полное определение
{ "type": "string", "enum": [ "en", "ru", "ka" ], "description": "Язык, охваченный показанным текстом согласия и digest; при принятии должен совпадать с языком, сохранённым в offer.", "example": "en" }

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

{
  "type": "object",
  "properties": {
    "version": {
      "type": "string",
      "maxLength": 64,
      "description": "Непустая версия показанного текста согласия; при принятии должна точно совпадать с версией, сохранённой в offer.",
      "example": "example"
    },
    "digest": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$",
      "description": "SHA-256 digest в нижнем регистре, связывающий версию terms, язык и точный показанный текст; при принятии повторяется предложенный digest.",
      "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
    },
    "locale": {
      "type": "string",
      "enum": [
        "en",
        "ru",
        "ka"
      ],
      "description": "Язык, охваченный показанным текстом согласия и digest; при принятии должен совпадать с языком, сохранённым в offer.",
      "example": "en"
    }
  },
  "description": "Версия, SHA-256 digest и язык, определяющие точный показанный текст платёжного согласия.",
  "required": [
    "version",
    "digest",
    "locale"
  ],
  "example": {
    "version": "example",
    "digest": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
    "locale": "en"
  }
}

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"
  }
}

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"
}