Авторизация
x-hallify-widget-context: <HALLIFY_STOREFRONT_WIDGET_CONTEXT>Краткосрочный server-authenticated widget presentation proof. Связывает настроенный frame origin с точными проверенными parent binding и connection authority. Новый widget-спрос требует этот proof; существующие native capabilities сохраняют отдельные права и исходные сроки.
Параметры
publicHandleПуть · ОбязательноОпубликованный handle нативного канала бронирования.
stringПолное определение
{ "type": "string", "example": "example" }changeIdПуть · ОбязательноТочное изменение соглашения, связанное с проверкой контакта.
string · uuidПолное определение
{ "type": "string", "format": "uuid", "example": "9b6163a8-afea-4877-818b-8e2ae28a2845" }idempotency-keyЗаголовок · ОбязательноОбязательный ключ идемпотентности длиной до 128 символов.
stringПолное определение
{ "type": "string", "minLength": 1, "maxLength": 128, "example": "example" }originЗаголовок · НеобязательноФактический Origin браузерного запроса для проверки текущих прав представления. Обязателен для новых заявок и продолжения через Storefront. Канонические браузерные запросы Hallify используют Origin, настроенный в HALLIFY_PUBLIC_APP_URL. Заголовок передаёт контекст запроса, не авторизует вызывающего и не заменяет соответствующий гостевой ключ.
string · uriПолное определение
{ "type": "string", "format": "uri", "maxLength": 2048, "example": "https://example.test/resource" }x-hallify-connection-idЗаголовок · НеобязательноНеобязательный несекретный идентификатор соединения для начального разрешения публичного канала. Не предоставляет прав и не заменяет зафиксированные данные выданного доступа.
string · uuidПолное определение
{ "type": "string", "format": "uuid", "minLength": 36, "maxLength": 36, "example": "9b6163a8-afea-4877-818b-8e2ae28a2845" }
Тело запроса
Обязательно
Исходная краткосрочная challenge-capability контакта и настоящий доставленный гостю код проверки.
application/json
Полное определение
{
"$ref": "#/components/schemas/ReservationAgreementVerifyDto"
}Ответы
200Исходные проверенное предложение и acceptance-capability с фиксированным сроком.
Полное определение
{
"$ref": "#/components/schemas/ReservationAgreementVerifiedResultDto"
}{
"agreement": {
"id": "7333b91d-1456-424d-8cf4-d12591cce3e7",
"action": "CHANGE",
"state": "PENDING",
"revision": 1,
"planHash": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
"expiresAt": "2026-12-31T18:00:00.000Z",
"scheduledAt": "2026-01-15T12:00:00.000Z",
"endsAt": "2026-12-31T18:00:00.000Z",
"partySize": 1,
"servicePeriodId": "4846c409-f4df-40f6-81cc-1d7157a5c646",
"offer": {
"required": true,
"terms": null,
"termsHash": null
},
"activatedAgreementVersion": null,
"activatedReservationRevision": null
},
"capability": "example",
"expiresAt": "2026-12-31T18:00:00.000Z"
}402Для новых операций требуется покрытие подписки. Отказ также возможен, если у операции нет исходного подтверждения коммерческого допуска. Разрешённое чтение и финансовое восстановление остаются доступны.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 402,
"error": "errors:http.failure",
"code": "HTTP_402",
"message": "errors:http.failure",
"translationKey": "errors:http.failure"
}409Ключ идемпотентности уже обрабатывается или повторно использован с другим телом.
Полное определение
{
"$ref": "#/components/schemas/IdempotencyConflictError"
}{
"statusCode": 409,
"error": "errors:http.conflict",
"code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
"message": "errors:idempotency.inProgress",
"translationKey": "errors:idempotency.inProgress"
}503Не удалось получить достоверное состояние подписки в пределах установленных ограничений. Повторите исходную операцию после восстановления.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 503,
"error": "errors:http.serviceUnavailable",
"code": "HTTP_SERVICE_UNAVAILABLE",
"message": "errors:http.serviceUnavailable",
"translationKey": "errors:http.serviceUnavailable"
}Схемы
ReservationAgreementVerifyDto
Подтверждение кодом исходной проверки соглашения брони, связанной с предложением, Origin и fingerprint запроса.
capabilityОбязательноТочная краткосрочная challenge-capability, связанная с предложением, Origin и request fingerprint.
stringПолное определение
{ "type": "string", "maxLength": 4096, "description": "Точная краткосрочная challenge-capability, связанная с предложением, Origin и request fingerprint.", "example": "example" }codeОбязательноНастоящий код проверки, отправленный на контакт гостя.
stringПолное определение
{ "type": "string", "minLength": 4, "maxLength": 12, "description": "Настоящий код проверки, отправленный на контакт гостя.", "example": "EXAMPLE" }
Полное определение
{
"type": "object",
"properties": {
"capability": {
"type": "string",
"maxLength": 4096,
"description": "Точная краткосрочная challenge-capability, связанная с предложением, Origin и request fingerprint.",
"example": "example"
},
"code": {
"type": "string",
"minLength": 4,
"maxLength": 12,
"description": "Настоящий код проверки, отправленный на контакт гостя.",
"example": "EXAMPLE"
}
},
"required": [
"capability",
"code"
],
"description": "Подтверждение кодом исходной проверки соглашения брони, связанной с предложением, Origin и fingerprint запроса.",
"example": {
"capability": "example",
"code": "EXAMPLE"
}
}ReservationAgreementVerifiedResultDto
Исходное проверенное предложение и краткосрочная capability явного принятия его точного digest.
agreementОбязательноТекущее разрешённое изменение соглашения с точными предложенными слотом и гарантией.
objectПолное определение
{ "type": "object", "description": "Текущее разрешённое изменение соглашения с точными предложенными слотом и гарантией.", "additionalProperties": false, "required": [ "id", "action", "state", "revision", "planHash", "expiresAt", "scheduledAt", "endsAt", "partySize", "servicePeriodId", "offer", "activatedAgreementVersion", "activatedReservationRevision" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID нативного изменения соглашения.", "example": "7333b91d-1456-424d-8cf4-d12591cce3e7" }, "action": { "type": "string", "enum": [ "CHANGE", "RESTORE" ], "description": "Явное предложенное нативное действие.", "example": "CHANGE" }, "state": { "type": "string", "enum": [ "PENDING", "ACCEPTED", "ACTIVATED", "EXPIRED", "SUPERSEDED" ], "description": "Текущее нативное состояние продолжения.", "example": "PENDING" }, "revision": { "type": "integer", "minimum": 1, "description": "Текущая нативная ревизия предложения.", "example": 1 }, "planHash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Digest точных замороженных слота и условий.", "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef" }, "expiresAt": { "type": "string", "format": "date-time", "description": "Фиксированный срок активации.", "example": "2026-12-31T18:00:00.000Z" }, "scheduledAt": { "type": "string", "format": "date-time", "description": "Точный предложенный запланированный момент.", "example": "2026-01-15T12:00:00.000Z" }, "endsAt": { "type": "string", "format": "date-time", "description": "Точный предложенный момент окончания визита.", "example": "2026-12-31T18:00:00.000Z" }, "partySize": { "type": "integer", "minimum": 1, "maximum": 99, "description": "Точное предложенное число гостей.", "example": 1 }, "servicePeriodId": { "type": "string", "format": "uuid", "description": "Предложенный нативный период обслуживания.", "example": "4846c409-f4df-40f6-81cc-1d7157a5c646" }, "offer": { "type": "object", "description": "Предложение гарантии, рассчитанное сервером, с условиями и их дайджестом. При NONE или числе гостей ниже настроенного порога гарантия не требуется.", "additionalProperties": false, "required": [ "required", "terms", "termsHash" ], "properties": { "required": { "type": "boolean", "description": "Требуют ли точные слот и число гостей гарантию.", "example": true }, "terms": { "type": "object", "description": "Точные принятые условия либо null, если гарантия не применяется.", "additionalProperties": false, "required": [ "schema", "version", "venueId", "publicChannelId", "servicePeriodId", "servicePeriodRevision", "kind", "amountBasis", "unitAmount", "totalAmount", "currency", "currencyMinorUnit", "partySize", "scheduledAt", "dueAt", "freeCancellationAt", "noShowAfter", "forfeitOnLateCancellation", "forfeitOnNoShow", "termsVersion", "privacyVersion" ], "properties": { "schema": { "type": "string", "enum": [ "hallify.reservation-guarantee.terms" ], "description": "Каноническая схема нативных условий.", "example": "hallify.reservation-guarantee.terms" }, "version": { "type": "integer", "enum": [ 1 ], "description": "Каноническая версия нативных условий.", "example": 1 }, "venueId": { "type": "string", "format": "uuid", "description": "UUID нативного заведения.", "example": "0604de3a-da74-4ad5-89f6-2dfe000d5391" }, "publicChannelId": { "type": "string", "format": "uuid", "description": "UUID нативного канала бронирования.", "example": "9bee613d-3322-4a03-8b9f-8a6259984eee" }, "servicePeriodId": { "type": "string", "format": "uuid", "description": "UUID выбранного нативного периода обслуживания.", "example": "4846c409-f4df-40f6-81cc-1d7157a5c646" }, "servicePeriodRevision": { "type": "integer", "minimum": 1, "description": "Принятая нативная ревизия периода обслуживания.", "example": 1 }, "kind": { "type": "string", "enum": [ "DEPOSIT", "CARD_HOLD", "PREPAID" ], "description": "Исходный принятый вид гарантии.", "example": "DEPOSIT" }, "amountBasis": { "type": "string", "enum": [ "FIXED", "PER_GUEST" ], "description": "Исходный способ расчёта суммы.", "example": "FIXED" }, "unitAmount": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,9})\\.[0-9]{2}$", "description": "Точная сумма за бронь или гостя с двумя десятичными знаками.", "example": "1.00" }, "totalAmount": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,9})\\.[0-9]{2}$", "description": "Точный принятый общий principal с двумя десятичными знаками без чаевых.", "example": "1.00" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Исходная нативная валюта; конвертация не выполняется.", "example": "GEL" }, "currencyMinorUnit": { "type": "integer", "enum": [ 2 ], "description": "Нативная денежная точность.", "example": 2 }, "partySize": { "type": "integer", "minimum": 1, "maximum": 99, "description": "Точное принятое число гостей.", "example": 1 }, "scheduledAt": { "type": "string", "format": "date-time", "description": "Точный запланированный момент слота в UTC.", "example": "2026-01-15T12:00:00.000Z" }, "dueAt": { "type": "string", "format": "date-time", "description": "Точный срок оплаты до конвертации и сбора средств.", "example": "2026-12-31T18:00:00.000Z" }, "freeCancellationAt": { "type": "string", "format": "date-time", "description": "Точная граница бесплатной отмены.", "example": "2026-01-15T12:00:00.000Z" }, "noShowAfter": { "type": "string", "format": "date-time", "description": "Самый ранний момент удержания за неявку по принятому льготному периоду.", "example": "2026-01-15T12:00:00.000Z" }, "forfeitOnLateCancellation": { "type": "boolean", "description": "Принятое разрешение явного удержания сотрудником при поздней отмене.", "example": true }, "forfeitOnNoShow": { "type": "boolean", "description": "Принятое разрешение явного удержания сотрудником при неявке; автоматического списания с карты нет.", "example": true }, "termsVersion": { "type": "string", "description": "Принятая версия публичных условий.", "example": "example" }, "privacyVersion": { "type": "string", "description": "Принятая версия уведомления о конфиденциальности.", "example": "example" } }, "nullable": true, "example": { "schema": "hallify.reservation-guarantee.terms", "version": 1, "venueId": "0604de3a-da74-4ad5-89f6-2dfe000d5391", "publicChannelId": "9bee613d-3322-4a03-8b9f-8a6259984eee", "servicePeriodId": "4846c409-f4df-40f6-81cc-1d7157a5c646", "servicePeriodRevision": 1, "kind": "DEPOSIT", "amountBasis": "FIXED", "unitAmount": "1.00", "totalAmount": "1.00", "currency": "GEL", "currencyMinorUnit": 2, "partySize": 1, "scheduledAt": "2026-01-15T12:00:00.000Z", "dueAt": "2026-12-31T18:00:00.000Z", "freeCancellationAt": "2026-01-15T12:00:00.000Z", "noShowAfter": "2026-01-15T12:00:00.000Z", "forfeitOnLateCancellation": true, "forfeitOnNoShow": true, "termsVersion": "example", "privacyVersion": "example" } }, "termsHash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "nullable": true, "description": "Канонический digest принятых условий либо null, если гарантия не применяется.", "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef" } }, "example": { "required": true, "terms": null, "termsHash": null } }, "activatedAgreementVersion": { "type": "integer", "minimum": 1, "nullable": true, "description": "Фактически активированная версия соглашения либо null до активации.", "example": 1 }, "activatedReservationRevision": { "type": "integer", "minimum": 1, "nullable": true, "description": "Фактическая нативная ревизия, записанная активацией, либо null.", "example": 1 } }, "example": { "id": "7333b91d-1456-424d-8cf4-d12591cce3e7", "action": "CHANGE", "state": "PENDING", "revision": 1, "planHash": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef", "expiresAt": "2026-12-31T18:00:00.000Z", "scheduledAt": "2026-01-15T12:00:00.000Z", "endsAt": "2026-12-31T18:00:00.000Z", "partySize": 1, "servicePeriodId": "4846c409-f4df-40f6-81cc-1d7157a5c646", "offer": { "required": true, "terms": null, "termsHash": null }, "activatedAgreementVersion": null, "activatedReservationRevision": null } }capabilityОбязательноЧувствительная capability, связанная с фактически проверенным существующим гостем и точным замороженным предложением.
stringПолное определение
{ "type": "string", "maxLength": 4096, "description": "Чувствительная capability, связанная с фактически проверенным существующим гостем и точным замороженным предложением.", "example": "example" }expiresAtОбязательноИсходный срок явного принятия.
string · date-timeПолное определение
{ "type": "string", "format": "date-time", "description": "Исходный срок явного принятия.", "example": "2026-12-31T18:00:00.000Z" }
Полное определение
{
"type": "object",
"description": "Исходное проверенное предложение и краткосрочная capability явного принятия его точного digest.",
"additionalProperties": false,
"required": [
"agreement",
"capability",
"expiresAt"
],
"properties": {
"agreement": {
"type": "object",
"description": "Текущее разрешённое изменение соглашения с точными предложенными слотом и гарантией.",
"additionalProperties": false,
"required": [
"id",
"action",
"state",
"revision",
"planHash",
"expiresAt",
"scheduledAt",
"endsAt",
"partySize",
"servicePeriodId",
"offer",
"activatedAgreementVersion",
"activatedReservationRevision"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "UUID нативного изменения соглашения.",
"example": "7333b91d-1456-424d-8cf4-d12591cce3e7"
},
"action": {
"type": "string",
"enum": [
"CHANGE",
"RESTORE"
],
"description": "Явное предложенное нативное действие.",
"example": "CHANGE"
},
"state": {
"type": "string",
"enum": [
"PENDING",
"ACCEPTED",
"ACTIVATED",
"EXPIRED",
"SUPERSEDED"
],
"description": "Текущее нативное состояние продолжения.",
"example": "PENDING"
},
"revision": {
"type": "integer",
"minimum": 1,
"description": "Текущая нативная ревизия предложения.",
"example": 1
},
"planHash": {
"type": "string",
"pattern": "^[0-9a-f]{64}$",
"description": "Digest точных замороженных слота и условий.",
"example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Фиксированный срок активации.",
"example": "2026-12-31T18:00:00.000Z"
},
"scheduledAt": {
"type": "string",
"format": "date-time",
"description": "Точный предложенный запланированный момент.",
"example": "2026-01-15T12:00:00.000Z"
},
"endsAt": {
"type": "string",
"format": "date-time",
"description": "Точный предложенный момент окончания визита.",
"example": "2026-12-31T18:00:00.000Z"
},
"partySize": {
"type": "integer",
"minimum": 1,
"maximum": 99,
"description": "Точное предложенное число гостей.",
"example": 1
},
"servicePeriodId": {
"type": "string",
"format": "uuid",
"description": "Предложенный нативный период обслуживания.",
"example": "4846c409-f4df-40f6-81cc-1d7157a5c646"
},
"offer": {
"type": "object",
"description": "Предложение гарантии, рассчитанное сервером, с условиями и их дайджестом. При NONE или числе гостей ниже настроенного порога гарантия не требуется.",
"additionalProperties": false,
"required": [
"required",
"terms",
"termsHash"
],
"properties": {
"required": {
"type": "boolean",
"description": "Требуют ли точные слот и число гостей гарантию.",
"example": true
},
"terms": {
"type": "object",
"description": "Точные принятые условия либо null, если гарантия не применяется.",
"additionalProperties": false,
"required": [
"schema",
"version",
"venueId",
"publicChannelId",
"servicePeriodId",
"servicePeriodRevision",
"kind",
"amountBasis",
"unitAmount",
"totalAmount",
"currency",
"currencyMinorUnit",
"partySize",
"scheduledAt",
"dueAt",
"freeCancellationAt",
"noShowAfter",
"forfeitOnLateCancellation",
"forfeitOnNoShow",
"termsVersion",
"privacyVersion"
],
"properties": {
"schema": {
"type": "string",
"enum": [
"hallify.reservation-guarantee.terms"
],
"description": "Каноническая схема нативных условий.",
"example": "hallify.reservation-guarantee.terms"
},
"version": {
"type": "integer",
"enum": [
1
],
"description": "Каноническая версия нативных условий.",
"example": 1
},
"venueId": {
"type": "string",
"format": "uuid",
"description": "UUID нативного заведения.",
"example": "0604de3a-da74-4ad5-89f6-2dfe000d5391"
},
"publicChannelId": {
"type": "string",
"format": "uuid",
"description": "UUID нативного канала бронирования.",
"example": "9bee613d-3322-4a03-8b9f-8a6259984eee"
},
"servicePeriodId": {
"type": "string",
"format": "uuid",
"description": "UUID выбранного нативного периода обслуживания.",
"example": "4846c409-f4df-40f6-81cc-1d7157a5c646"
},
"servicePeriodRevision": {
"type": "integer",
"minimum": 1,
"description": "Принятая нативная ревизия периода обслуживания.",
"example": 1
},
"kind": {
"type": "string",
"enum": [
"DEPOSIT",
"CARD_HOLD",
"PREPAID"
],
"description": "Исходный принятый вид гарантии.",
"example": "DEPOSIT"
},
"amountBasis": {
"type": "string",
"enum": [
"FIXED",
"PER_GUEST"
],
"description": "Исходный способ расчёта суммы.",
"example": "FIXED"
},
"unitAmount": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,9})\\.[0-9]{2}$",
"description": "Точная сумма за бронь или гостя с двумя десятичными знаками.",
"example": "1.00"
},
"totalAmount": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,9})\\.[0-9]{2}$",
"description": "Точный принятый общий principal с двумя десятичными знаками без чаевых.",
"example": "1.00"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"description": "Исходная нативная валюта; конвертация не выполняется.",
"example": "GEL"
},
"currencyMinorUnit": {
"type": "integer",
"enum": [
2
],
"description": "Нативная денежная точность.",
"example": 2
},
"partySize": {
"type": "integer",
"minimum": 1,
"maximum": 99,
"description": "Точное принятое число гостей.",
"example": 1
},
"scheduledAt": {
"type": "string",
"format": "date-time",
"description": "Точный запланированный момент слота в UTC.",
"example": "2026-01-15T12:00:00.000Z"
},
"dueAt": {
"type": "string",
"format": "date-time",
"description": "Точный срок оплаты до конвертации и сбора средств.",
"example": "2026-12-31T18:00:00.000Z"
},
"freeCancellationAt": {
"type": "string",
"format": "date-time",
"description": "Точная граница бесплатной отмены.",
"example": "2026-01-15T12:00:00.000Z"
},
"noShowAfter": {
"type": "string",
"format": "date-time",
"description": "Самый ранний момент удержания за неявку по принятому льготному периоду.",
"example": "2026-01-15T12:00:00.000Z"
},
"forfeitOnLateCancellation": {
"type": "boolean",
"description": "Принятое разрешение явного удержания сотрудником при поздней отмене.",
"example": true
},
"forfeitOnNoShow": {
"type": "boolean",
"description": "Принятое разрешение явного удержания сотрудником при неявке; автоматического списания с карты нет.",
"example": true
},
"termsVersion": {
"type": "string",
"description": "Принятая версия публичных условий.",
"example": "example"
},
"privacyVersion": {
"type": "string",
"description": "Принятая версия уведомления о конфиденциальности.",
"example": "example"
}
},
"nullable": true,
"example": {
"schema": "hallify.reservation-guarantee.terms",
"version": 1,
"venueId": "0604de3a-da74-4ad5-89f6-2dfe000d5391",
"publicChannelId": "9bee613d-3322-4a03-8b9f-8a6259984eee",
"servicePeriodId": "4846c409-f4df-40f6-81cc-1d7157a5c646",
"servicePeriodRevision": 1,
"kind": "DEPOSIT",
"amountBasis": "FIXED",
"unitAmount": "1.00",
"totalAmount": "1.00",
"currency": "GEL",
"currencyMinorUnit": 2,
"partySize": 1,
"scheduledAt": "2026-01-15T12:00:00.000Z",
"dueAt": "2026-12-31T18:00:00.000Z",
"freeCancellationAt": "2026-01-15T12:00:00.000Z",
"noShowAfter": "2026-01-15T12:00:00.000Z",
"forfeitOnLateCancellation": true,
"forfeitOnNoShow": true,
"termsVersion": "example",
"privacyVersion": "example"
}
},
"termsHash": {
"type": "string",
"pattern": "^[0-9a-f]{64}$",
"nullable": true,
"description": "Канонический digest принятых условий либо null, если гарантия не применяется.",
"example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
}
},
"example": {
"required": true,
"terms": null,
"termsHash": null
}
},
"activatedAgreementVersion": {
"type": "integer",
"minimum": 1,
"nullable": true,
"description": "Фактически активированная версия соглашения либо null до активации.",
"example": 1
},
"activatedReservationRevision": {
"type": "integer",
"minimum": 1,
"nullable": true,
"description": "Фактическая нативная ревизия, записанная активацией, либо null.",
"example": 1
}
},
"example": {
"id": "7333b91d-1456-424d-8cf4-d12591cce3e7",
"action": "CHANGE",
"state": "PENDING",
"revision": 1,
"planHash": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
"expiresAt": "2026-12-31T18:00:00.000Z",
"scheduledAt": "2026-01-15T12:00:00.000Z",
"endsAt": "2026-12-31T18:00:00.000Z",
"partySize": 1,
"servicePeriodId": "4846c409-f4df-40f6-81cc-1d7157a5c646",
"offer": {
"required": true,
"terms": null,
"termsHash": null
},
"activatedAgreementVersion": null,
"activatedReservationRevision": null
}
},
"capability": {
"type": "string",
"maxLength": 4096,
"description": "Чувствительная capability, связанная с фактически проверенным существующим гостем и точным замороженным предложением.",
"example": "example"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Исходный срок явного принятия.",
"example": "2026-12-31T18:00:00.000Z"
}
},
"example": {
"agreement": {
"id": "7333b91d-1456-424d-8cf4-d12591cce3e7",
"action": "CHANGE",
"state": "PENDING",
"revision": 1,
"planHash": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
"expiresAt": "2026-12-31T18:00:00.000Z",
"scheduledAt": "2026-01-15T12:00:00.000Z",
"endsAt": "2026-12-31T18:00:00.000Z",
"partySize": 1,
"servicePeriodId": "4846c409-f4df-40f6-81cc-1d7157a5c646",
"offer": {
"required": true,
"terms": null,
"termsHash": null
},
"activatedAgreementVersion": null,
"activatedReservationRevision": null
},
"capability": "example",
"expiresAt": "2026-12-31T18:00:00.000Z"
}
}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"
}IdempotencyConflictError
Ключ идемпотентности уже обрабатывается или использован повторно с другим телом.
Полное определение
{
"example": {
"statusCode": 409,
"error": "errors:http.conflict",
"code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
"message": "errors:idempotency.inProgress",
"translationKey": "errors:idempotency.inProgress"
},
"allOf": [
{
"$ref": "#/components/schemas/TranslatedErrorDto"
},
{
"type": "object",
"required": [
"code"
],
"properties": {
"statusCode": {
"type": "integer",
"enum": [
409
],
"description": "Статус конфликта HTTP 409.",
"example": 409
},
"code": {
"type": "string",
"enum": [
"IDEMPOTENCY_REQUEST_NOT_READY",
"IDEMPOTENCY_KEY_PAYLOAD_MISMATCH",
"IDEMPOTENCY_REQUEST_IN_PROGRESS",
"IDEMPOTENCY_SCOPE_INCOMPLETE"
],
"description": "Допустимые значения `code`: IDEMPOTENCY_REQUEST_NOT_READY, IDEMPOTENCY_KEY_PAYLOAD_MISMATCH, IDEMPOTENCY_REQUEST_IN_PROGRESS, IDEMPOTENCY_SCOPE_INCOMPLETE.",
"example": "IDEMPOTENCY_REQUEST_NOT_READY"
}
},
"example": {
"code": "IDEMPOTENCY_REQUEST_NOT_READY"
}
}
],
"description": "Ключ идемпотентности уже обрабатывается или использован повторно с другим телом."
}