Skip to content
HallifyDevelopersSearch documentation
Open Hallify
Sections

Guest portal

Read own reservation history

GET/guest-portal/reservations/{reservationId}

Resolves the current guest capability and fresh contact assurance, then reads the exact native reservation and eligible original/current guarantee evidence. Normal management expiry does not rewrite history. This response issues no native management or payment capability.

Authentication

x-guest-portal-token: <HALLIFY_GUEST_PORTAL_TOKEN>

Guest-owned portal session token.

Connection guide

Parameters

reservationIdPath · Required

Native reservation UUID in the current guest and venue realm.

string · uuid
Full definition
{
  "format": "uuid",
  "type": "string",
  "example": "9b6163a8-afea-4877-818b-8e2ae28a2845"
}

Responses

200The native reservation history and eligible guarantee evidence.
GuestPortalReservationHistoryDetailsResultDto
Full definition
{
  "$ref": "#/components/schemas/GuestPortalReservationHistoryDetailsResultDto"
}
Example response · 200 · application/json
{
  "kind": "RESERVATION",
  "id": "f9aedafe-e38a-4ff3-8ecc-3a580303c4e3",
  "referenceCode": "EXAMPLE",
  "revision": 1,
  "status": "REQUESTED",
  "scheduledAt": "2026-01-15T12:00:00.000Z",
  "endsAt": "2026-12-31T18:00:00.000Z",
  "partySize": 1,
  "originalGuarantee": null,
  "currentGuarantee": null,
  "hasVerifiedSource": true
}
400The native resource UUID or retained proof is invalid.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 400 · application/json
{
  "statusCode": 400,
  "error": "errors:http.badRequest",
  "code": "HTTP_BAD_REQUEST",
  "message": "errors:http.badRequest",
  "translationKey": "errors:http.badRequest"
}
401The current Guest Portal session or subject is unavailable.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 401 · application/json
{
  "statusCode": 401,
  "error": "errors:http.unauthorized",
  "code": "HTTP_UNAUTHORIZED",
  "message": "errors:http.unauthorized",
  "translationKey": "errors:http.unauthorized"
}
403The current session requires fresh contact verification before reading private history.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 403 · application/json
{
  "statusCode": 403,
  "error": "errors:http.forbidden",
  "code": "HTTP_FORBIDDEN",
  "message": "errors:http.forbidden",
  "translationKey": "errors:http.forbidden"
}
404No readable resource exists in the exact guest and venue realm.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 404 · application/json
{
  "statusCode": 404,
  "error": "errors:http.notFound",
  "code": "HTTP_NOT_FOUND",
  "message": "errors:http.notFound",
  "translationKey": "errors:http.notFound"
}
503The required protected-data key policy is unavailable.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 503 · application/json
{
  "statusCode": 503,
  "error": "errors:http.serviceUnavailable",
  "code": "HTTP_SERVICE_UNAVAILABLE",
  "message": "errors:http.serviceUnavailable",
  "translationKey": "errors:http.serviceUnavailable"
}

Schemas

GuestPortalReservationHistoryDetailsResultDto

Assured guest-owned reservation and original/current guarantee history.

kindRequired

Native reservation resource kind.

string
Full definition
{
  "type": "string",
  "enum": [
    "RESERVATION"
  ],
  "description": "Native reservation resource kind.",
  "example": "RESERVATION"
}
idRequired

Canonical native resource UUID.

string · uuid
Full definition
{
  "type": "string",
  "format": "uuid",
  "description": "Canonical native resource UUID.",
  "example": "f9aedafe-e38a-4ff3-8ecc-3a580303c4e3"
}
referenceCodeRequired

Guest-facing native booking reference.

string
Full definition
{
  "type": "string",
  "description": "Guest-facing native booking reference.",
  "example": "EXAMPLE"
}
revisionRequired

Current revision owned by the native resource.

integer
Full definition
{
  "type": "integer",
  "minimum": 1,
  "description": "Current revision owned by the native resource.",
  "example": 1
}
statusRequired

Current native reservation lifecycle.

string
Full definition
{
  "type": "string",
  "enum": [
    "REQUESTED",
    "BOOKED",
    "CONFIRMED",
    "ARRIVED",
    "SEATED",
    "CANCELED",
    "NO_SHOW",
    "DECLINED",
    "EXPIRED"
  ],
  "description": "Current native reservation lifecycle.",
  "example": "REQUESTED"
}
scheduledAtRequired

Current scheduled native arrival instant.

string · date-time
Full definition
{
  "type": "string",
  "format": "date-time",
  "description": "Current scheduled native arrival instant.",
  "example": "2026-01-15T12:00:00.000Z"
}
endsAtRequired

Current scheduled native reservation end.

string · date-time
Full definition
{
  "type": "string",
  "format": "date-time",
  "description": "Current scheduled native reservation end.",
  "example": "2026-12-31T18:00:00.000Z"
}
partySizeRequired

Current native number of guests.

integer
Full definition
{
  "type": "integer",
  "minimum": 1,
  "description": "Current native number of guests.",
  "example": 1
}
originalGuaranteeRequired

Native financial guarantee with its original stored terms, or null without eligible retained provenance.

object · null
Full definition
{
  "type": "object",
  "nullable": true,
  "description": "Native financial guarantee with its original stored terms, or null without eligible retained provenance.",
  "required": [
    "id",
    "revision",
    "agreementVersion",
    "kind",
    "status",
    "amount",
    "currency",
    "dueAt",
    "termsHash",
    "terms",
    "termsAcceptedAt",
    "authorizationExpiresAt",
    "satisfiedAt",
    "waivedAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Canonical native resource UUID.",
      "example": "1bb9e8cf-3825-4eae-8744-ff9815674acf"
    },
    "revision": {
      "type": "integer",
      "minimum": 1,
      "description": "Current revision owned by the native resource.",
      "example": 1
    },
    "agreementVersion": {
      "type": "integer",
      "minimum": 0,
      "description": "Native accepted guarantee agreement version.",
      "example": 1
    },
    "kind": {
      "type": "string",
      "enum": [
        "DEPOSIT",
        "CARD_HOLD",
        "PREPAID"
      ],
      "description": "Original native guarantee kind.",
      "example": "DEPOSIT"
    },
    "status": {
      "type": "string",
      "enum": [
        "PENDING",
        "SATISFIED",
        "WAIVED",
        "EXPIRED",
        "REFUNDED",
        "FORFEITED"
      ],
      "description": "Current native financial guarantee lifecycle.",
      "example": "PENDING"
    },
    "amount": {
      "type": "string",
      "pattern": "^(0|[1-9][0-9]{0,9})\\.[0-9]{2}$",
      "description": "Stored guarantee principal as an exact two-decimal string.",
      "example": "1.00"
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Z]{3}$",
      "description": "Original native guarantee currency.",
      "example": "GEL"
    },
    "dueAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Stored native instant, or null when no such event occurred.",
      "example": "2026-12-31T18:00:00.000Z"
    },
    "termsHash": {
      "type": "string",
      "nullable": true,
      "pattern": "^[a-f0-9]{64}$",
      "description": "Original accepted terms digest, or null for legacy evidence.",
      "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
    },
    "terms": {
      "type": "object",
      "description": "Original accepted native guarantee terms, or 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": "Canonical native terms schema.",
          "example": "hallify.reservation-guarantee.terms"
        },
        "version": {
          "type": "integer",
          "enum": [
            1
          ],
          "description": "Canonical native terms version.",
          "example": 1
        },
        "venueId": {
          "type": "string",
          "format": "uuid",
          "description": "Native venue UUID.",
          "example": "0604de3a-da74-4ad5-89f6-2dfe000d5391"
        },
        "publicChannelId": {
          "type": "string",
          "format": "uuid",
          "description": "Native reservation channel UUID.",
          "example": "9bee613d-3322-4a03-8b9f-8a6259984eee"
        },
        "servicePeriodId": {
          "type": "string",
          "format": "uuid",
          "description": "Selected native service-period UUID.",
          "example": "4846c409-f4df-40f6-81cc-1d7157a5c646"
        },
        "servicePeriodRevision": {
          "type": "integer",
          "minimum": 1,
          "description": "Accepted native service-period revision.",
          "example": 1
        },
        "kind": {
          "type": "string",
          "enum": [
            "DEPOSIT",
            "CARD_HOLD",
            "PREPAID"
          ],
          "description": "Original accepted guarantee kind.",
          "example": "DEPOSIT"
        },
        "amountBasis": {
          "type": "string",
          "enum": [
            "FIXED",
            "PER_GUEST"
          ],
          "description": "Original amount calculation basis.",
          "example": "FIXED"
        },
        "unitAmount": {
          "type": "string",
          "pattern": "^(0|[1-9][0-9]{0,9})\\.[0-9]{2}$",
          "description": "Exact two-decimal amount per booking or guest.",
          "example": "1.00"
        },
        "totalAmount": {
          "type": "string",
          "pattern": "^(0|[1-9][0-9]{0,9})\\.[0-9]{2}$",
          "description": "Exact two-decimal accepted total principal, with no tip.",
          "example": "1.00"
        },
        "currency": {
          "type": "string",
          "pattern": "^[A-Z]{3}$",
          "description": "Original native currency; no conversion is performed.",
          "example": "GEL"
        },
        "currencyMinorUnit": {
          "type": "integer",
          "enum": [
            2
          ],
          "description": "Native monetary scale.",
          "example": 2
        },
        "partySize": {
          "type": "integer",
          "minimum": 1,
          "maximum": 99,
          "description": "Exact accepted party size.",
          "example": 1
        },
        "scheduledAt": {
          "type": "string",
          "format": "date-time",
          "description": "Exact scheduled UTC slot instant.",
          "example": "2026-01-15T12:00:00.000Z"
        },
        "dueAt": {
          "type": "string",
          "format": "date-time",
          "description": "Exact payment deadline before conversion and collection.",
          "example": "2026-12-31T18:00:00.000Z"
        },
        "freeCancellationAt": {
          "type": "string",
          "format": "date-time",
          "description": "Exact free-cancellation cutoff.",
          "example": "2026-01-15T12:00:00.000Z"
        },
        "noShowAfter": {
          "type": "string",
          "format": "date-time",
          "description": "Earliest no-show forfeiture instant under the accepted grace rule.",
          "example": "2026-01-15T12:00:00.000Z"
        },
        "forfeitOnLateCancellation": {
          "type": "boolean",
          "description": "Accepted permission for explicit staff late-cancellation forfeiture.",
          "example": true
        },
        "forfeitOnNoShow": {
          "type": "boolean",
          "description": "Accepted permission for explicit staff no-show forfeiture; no automatic card debit.",
          "example": true
        },
        "termsVersion": {
          "type": "string",
          "description": "Accepted public terms version.",
          "example": "example"
        },
        "privacyVersion": {
          "type": "string",
          "description": "Accepted privacy notice version.",
          "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"
      }
    },
    "termsAcceptedAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Stored native instant, or null when no such event occurred.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "authorizationExpiresAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Stored native instant, or null when no such event occurred.",
      "example": "2026-12-31T18:00:00.000Z"
    },
    "satisfiedAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Stored native instant, or null when no such event occurred.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "waivedAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Stored native instant, or null when no such event occurred.",
      "example": "2026-01-15T12:00:00.000Z"
    }
  },
  "example": {
    "id": "1bb9e8cf-3825-4eae-8744-ff9815674acf",
    "revision": 1,
    "agreementVersion": 1,
    "kind": "DEPOSIT",
    "status": "PENDING",
    "amount": "1.00",
    "currency": "GEL",
    "dueAt": null,
    "termsHash": null,
    "terms": null,
    "termsAcceptedAt": null,
    "authorizationExpiresAt": null,
    "satisfiedAt": null,
    "waivedAt": null
  }
}
currentGuaranteeRequired

Native financial guarantee with its original stored terms, or null without eligible retained provenance.

object · null
Full definition
{
  "type": "object",
  "nullable": true,
  "description": "Native financial guarantee with its original stored terms, or null without eligible retained provenance.",
  "required": [
    "id",
    "revision",
    "agreementVersion",
    "kind",
    "status",
    "amount",
    "currency",
    "dueAt",
    "termsHash",
    "terms",
    "termsAcceptedAt",
    "authorizationExpiresAt",
    "satisfiedAt",
    "waivedAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Canonical native resource UUID.",
      "example": "ee887199-b691-4101-8431-097b03b1a2e2"
    },
    "revision": {
      "type": "integer",
      "minimum": 1,
      "description": "Current revision owned by the native resource.",
      "example": 1
    },
    "agreementVersion": {
      "type": "integer",
      "minimum": 0,
      "description": "Native accepted guarantee agreement version.",
      "example": 1
    },
    "kind": {
      "type": "string",
      "enum": [
        "DEPOSIT",
        "CARD_HOLD",
        "PREPAID"
      ],
      "description": "Original native guarantee kind.",
      "example": "DEPOSIT"
    },
    "status": {
      "type": "string",
      "enum": [
        "PENDING",
        "SATISFIED",
        "WAIVED",
        "EXPIRED",
        "REFUNDED",
        "FORFEITED"
      ],
      "description": "Current native financial guarantee lifecycle.",
      "example": "PENDING"
    },
    "amount": {
      "type": "string",
      "pattern": "^(0|[1-9][0-9]{0,9})\\.[0-9]{2}$",
      "description": "Stored guarantee principal as an exact two-decimal string.",
      "example": "1.00"
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Z]{3}$",
      "description": "Original native guarantee currency.",
      "example": "GEL"
    },
    "dueAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Stored native instant, or null when no such event occurred.",
      "example": "2026-12-31T18:00:00.000Z"
    },
    "termsHash": {
      "type": "string",
      "nullable": true,
      "pattern": "^[a-f0-9]{64}$",
      "description": "Original accepted terms digest, or null for legacy evidence.",
      "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
    },
    "terms": {
      "type": "object",
      "description": "Original accepted native guarantee terms, or 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": "Canonical native terms schema.",
          "example": "hallify.reservation-guarantee.terms"
        },
        "version": {
          "type": "integer",
          "enum": [
            1
          ],
          "description": "Canonical native terms version.",
          "example": 1
        },
        "venueId": {
          "type": "string",
          "format": "uuid",
          "description": "Native venue UUID.",
          "example": "0604de3a-da74-4ad5-89f6-2dfe000d5391"
        },
        "publicChannelId": {
          "type": "string",
          "format": "uuid",
          "description": "Native reservation channel UUID.",
          "example": "9bee613d-3322-4a03-8b9f-8a6259984eee"
        },
        "servicePeriodId": {
          "type": "string",
          "format": "uuid",
          "description": "Selected native service-period UUID.",
          "example": "4846c409-f4df-40f6-81cc-1d7157a5c646"
        },
        "servicePeriodRevision": {
          "type": "integer",
          "minimum": 1,
          "description": "Accepted native service-period revision.",
          "example": 1
        },
        "kind": {
          "type": "string",
          "enum": [
            "DEPOSIT",
            "CARD_HOLD",
            "PREPAID"
          ],
          "description": "Original accepted guarantee kind.",
          "example": "DEPOSIT"
        },
        "amountBasis": {
          "type": "string",
          "enum": [
            "FIXED",
            "PER_GUEST"
          ],
          "description": "Original amount calculation basis.",
          "example": "FIXED"
        },
        "unitAmount": {
          "type": "string",
          "pattern": "^(0|[1-9][0-9]{0,9})\\.[0-9]{2}$",
          "description": "Exact two-decimal amount per booking or guest.",
          "example": "1.00"
        },
        "totalAmount": {
          "type": "string",
          "pattern": "^(0|[1-9][0-9]{0,9})\\.[0-9]{2}$",
          "description": "Exact two-decimal accepted total principal, with no tip.",
          "example": "1.00"
        },
        "currency": {
          "type": "string",
          "pattern": "^[A-Z]{3}$",
          "description": "Original native currency; no conversion is performed.",
          "example": "GEL"
        },
        "currencyMinorUnit": {
          "type": "integer",
          "enum": [
            2
          ],
          "description": "Native monetary scale.",
          "example": 2
        },
        "partySize": {
          "type": "integer",
          "minimum": 1,
          "maximum": 99,
          "description": "Exact accepted party size.",
          "example": 1
        },
        "scheduledAt": {
          "type": "string",
          "format": "date-time",
          "description": "Exact scheduled UTC slot instant.",
          "example": "2026-01-15T12:00:00.000Z"
        },
        "dueAt": {
          "type": "string",
          "format": "date-time",
          "description": "Exact payment deadline before conversion and collection.",
          "example": "2026-12-31T18:00:00.000Z"
        },
        "freeCancellationAt": {
          "type": "string",
          "format": "date-time",
          "description": "Exact free-cancellation cutoff.",
          "example": "2026-01-15T12:00:00.000Z"
        },
        "noShowAfter": {
          "type": "string",
          "format": "date-time",
          "description": "Earliest no-show forfeiture instant under the accepted grace rule.",
          "example": "2026-01-15T12:00:00.000Z"
        },
        "forfeitOnLateCancellation": {
          "type": "boolean",
          "description": "Accepted permission for explicit staff late-cancellation forfeiture.",
          "example": true
        },
        "forfeitOnNoShow": {
          "type": "boolean",
          "description": "Accepted permission for explicit staff no-show forfeiture; no automatic card debit.",
          "example": true
        },
        "termsVersion": {
          "type": "string",
          "description": "Accepted public terms version.",
          "example": "example"
        },
        "privacyVersion": {
          "type": "string",
          "description": "Accepted privacy notice version.",
          "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"
      }
    },
    "termsAcceptedAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Stored native instant, or null when no such event occurred.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "authorizationExpiresAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Stored native instant, or null when no such event occurred.",
      "example": "2026-12-31T18:00:00.000Z"
    },
    "satisfiedAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Stored native instant, or null when no such event occurred.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "waivedAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Stored native instant, or null when no such event occurred.",
      "example": "2026-01-15T12:00:00.000Z"
    }
  },
  "example": {
    "id": "ee887199-b691-4101-8431-097b03b1a2e2",
    "revision": 1,
    "agreementVersion": 1,
    "kind": "DEPOSIT",
    "status": "PENDING",
    "amount": "1.00",
    "currency": "GEL",
    "dueAt": null,
    "termsHash": null,
    "terms": null,
    "termsAcceptedAt": null,
    "authorizationExpiresAt": null,
    "satisfiedAt": null,
    "waivedAt": null
  }
}
hasVerifiedSourceRequired

A readable retained original-source proof exists. This flag issues no management, payment or bill authority; native entry still requires a new purpose-bound proof and current admission.

boolean
Full definition
{
  "type": "boolean",
  "description": "A readable retained original-source proof exists. This flag issues no management, payment or bill authority; native entry still requires a new purpose-bound proof and current admission.",
  "example": true
}
Full definition
{
  "type": "object",
  "description": "Assured guest-owned reservation and original/current guarantee history.",
  "required": [
    "kind",
    "id",
    "referenceCode",
    "revision",
    "status",
    "scheduledAt",
    "endsAt",
    "partySize",
    "originalGuarantee",
    "currentGuarantee",
    "hasVerifiedSource"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "RESERVATION"
      ],
      "description": "Native reservation resource kind.",
      "example": "RESERVATION"
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Canonical native resource UUID.",
      "example": "f9aedafe-e38a-4ff3-8ecc-3a580303c4e3"
    },
    "referenceCode": {
      "type": "string",
      "description": "Guest-facing native booking reference.",
      "example": "EXAMPLE"
    },
    "revision": {
      "type": "integer",
      "minimum": 1,
      "description": "Current revision owned by the native resource.",
      "example": 1
    },
    "status": {
      "type": "string",
      "enum": [
        "REQUESTED",
        "BOOKED",
        "CONFIRMED",
        "ARRIVED",
        "SEATED",
        "CANCELED",
        "NO_SHOW",
        "DECLINED",
        "EXPIRED"
      ],
      "description": "Current native reservation lifecycle.",
      "example": "REQUESTED"
    },
    "scheduledAt": {
      "type": "string",
      "format": "date-time",
      "description": "Current scheduled native arrival instant.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "endsAt": {
      "type": "string",
      "format": "date-time",
      "description": "Current scheduled native reservation end.",
      "example": "2026-12-31T18:00:00.000Z"
    },
    "partySize": {
      "type": "integer",
      "minimum": 1,
      "description": "Current native number of guests.",
      "example": 1
    },
    "originalGuarantee": {
      "type": "object",
      "nullable": true,
      "description": "Native financial guarantee with its original stored terms, or null without eligible retained provenance.",
      "required": [
        "id",
        "revision",
        "agreementVersion",
        "kind",
        "status",
        "amount",
        "currency",
        "dueAt",
        "termsHash",
        "terms",
        "termsAcceptedAt",
        "authorizationExpiresAt",
        "satisfiedAt",
        "waivedAt"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "Canonical native resource UUID.",
          "example": "1bb9e8cf-3825-4eae-8744-ff9815674acf"
        },
        "revision": {
          "type": "integer",
          "minimum": 1,
          "description": "Current revision owned by the native resource.",
          "example": 1
        },
        "agreementVersion": {
          "type": "integer",
          "minimum": 0,
          "description": "Native accepted guarantee agreement version.",
          "example": 1
        },
        "kind": {
          "type": "string",
          "enum": [
            "DEPOSIT",
            "CARD_HOLD",
            "PREPAID"
          ],
          "description": "Original native guarantee kind.",
          "example": "DEPOSIT"
        },
        "status": {
          "type": "string",
          "enum": [
            "PENDING",
            "SATISFIED",
            "WAIVED",
            "EXPIRED",
            "REFUNDED",
            "FORFEITED"
          ],
          "description": "Current native financial guarantee lifecycle.",
          "example": "PENDING"
        },
        "amount": {
          "type": "string",
          "pattern": "^(0|[1-9][0-9]{0,9})\\.[0-9]{2}$",
          "description": "Stored guarantee principal as an exact two-decimal string.",
          "example": "1.00"
        },
        "currency": {
          "type": "string",
          "pattern": "^[A-Z]{3}$",
          "description": "Original native guarantee currency.",
          "example": "GEL"
        },
        "dueAt": {
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "description": "Stored native instant, or null when no such event occurred.",
          "example": "2026-12-31T18:00:00.000Z"
        },
        "termsHash": {
          "type": "string",
          "nullable": true,
          "pattern": "^[a-f0-9]{64}$",
          "description": "Original accepted terms digest, or null for legacy evidence.",
          "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
        },
        "terms": {
          "type": "object",
          "description": "Original accepted native guarantee terms, or 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": "Canonical native terms schema.",
              "example": "hallify.reservation-guarantee.terms"
            },
            "version": {
              "type": "integer",
              "enum": [
                1
              ],
              "description": "Canonical native terms version.",
              "example": 1
            },
            "venueId": {
              "type": "string",
              "format": "uuid",
              "description": "Native venue UUID.",
              "example": "0604de3a-da74-4ad5-89f6-2dfe000d5391"
            },
            "publicChannelId": {
              "type": "string",
              "format": "uuid",
              "description": "Native reservation channel UUID.",
              "example": "9bee613d-3322-4a03-8b9f-8a6259984eee"
            },
            "servicePeriodId": {
              "type": "string",
              "format": "uuid",
              "description": "Selected native service-period UUID.",
              "example": "4846c409-f4df-40f6-81cc-1d7157a5c646"
            },
            "servicePeriodRevision": {
              "type": "integer",
              "minimum": 1,
              "description": "Accepted native service-period revision.",
              "example": 1
            },
            "kind": {
              "type": "string",
              "enum": [
                "DEPOSIT",
                "CARD_HOLD",
                "PREPAID"
              ],
              "description": "Original accepted guarantee kind.",
              "example": "DEPOSIT"
            },
            "amountBasis": {
              "type": "string",
              "enum": [
                "FIXED",
                "PER_GUEST"
              ],
              "description": "Original amount calculation basis.",
              "example": "FIXED"
            },
            "unitAmount": {
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,9})\\.[0-9]{2}$",
              "description": "Exact two-decimal amount per booking or guest.",
              "example": "1.00"
            },
            "totalAmount": {
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,9})\\.[0-9]{2}$",
              "description": "Exact two-decimal accepted total principal, with no tip.",
              "example": "1.00"
            },
            "currency": {
              "type": "string",
              "pattern": "^[A-Z]{3}$",
              "description": "Original native currency; no conversion is performed.",
              "example": "GEL"
            },
            "currencyMinorUnit": {
              "type": "integer",
              "enum": [
                2
              ],
              "description": "Native monetary scale.",
              "example": 2
            },
            "partySize": {
              "type": "integer",
              "minimum": 1,
              "maximum": 99,
              "description": "Exact accepted party size.",
              "example": 1
            },
            "scheduledAt": {
              "type": "string",
              "format": "date-time",
              "description": "Exact scheduled UTC slot instant.",
              "example": "2026-01-15T12:00:00.000Z"
            },
            "dueAt": {
              "type": "string",
              "format": "date-time",
              "description": "Exact payment deadline before conversion and collection.",
              "example": "2026-12-31T18:00:00.000Z"
            },
            "freeCancellationAt": {
              "type": "string",
              "format": "date-time",
              "description": "Exact free-cancellation cutoff.",
              "example": "2026-01-15T12:00:00.000Z"
            },
            "noShowAfter": {
              "type": "string",
              "format": "date-time",
              "description": "Earliest no-show forfeiture instant under the accepted grace rule.",
              "example": "2026-01-15T12:00:00.000Z"
            },
            "forfeitOnLateCancellation": {
              "type": "boolean",
              "description": "Accepted permission for explicit staff late-cancellation forfeiture.",
              "example": true
            },
            "forfeitOnNoShow": {
              "type": "boolean",
              "description": "Accepted permission for explicit staff no-show forfeiture; no automatic card debit.",
              "example": true
            },
            "termsVersion": {
              "type": "string",
              "description": "Accepted public terms version.",
              "example": "example"
            },
            "privacyVersion": {
              "type": "string",
              "description": "Accepted privacy notice version.",
              "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"
          }
        },
        "termsAcceptedAt": {
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "description": "Stored native instant, or null when no such event occurred.",
          "example": "2026-01-15T12:00:00.000Z"
        },
        "authorizationExpiresAt": {
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "description": "Stored native instant, or null when no such event occurred.",
          "example": "2026-12-31T18:00:00.000Z"
        },
        "satisfiedAt": {
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "description": "Stored native instant, or null when no such event occurred.",
          "example": "2026-01-15T12:00:00.000Z"
        },
        "waivedAt": {
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "description": "Stored native instant, or null when no such event occurred.",
          "example": "2026-01-15T12:00:00.000Z"
        }
      },
      "example": {
        "id": "1bb9e8cf-3825-4eae-8744-ff9815674acf",
        "revision": 1,
        "agreementVersion": 1,
        "kind": "DEPOSIT",
        "status": "PENDING",
        "amount": "1.00",
        "currency": "GEL",
        "dueAt": null,
        "termsHash": null,
        "terms": null,
        "termsAcceptedAt": null,
        "authorizationExpiresAt": null,
        "satisfiedAt": null,
        "waivedAt": null
      }
    },
    "currentGuarantee": {
      "type": "object",
      "nullable": true,
      "description": "Native financial guarantee with its original stored terms, or null without eligible retained provenance.",
      "required": [
        "id",
        "revision",
        "agreementVersion",
        "kind",
        "status",
        "amount",
        "currency",
        "dueAt",
        "termsHash",
        "terms",
        "termsAcceptedAt",
        "authorizationExpiresAt",
        "satisfiedAt",
        "waivedAt"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "Canonical native resource UUID.",
          "example": "ee887199-b691-4101-8431-097b03b1a2e2"
        },
        "revision": {
          "type": "integer",
          "minimum": 1,
          "description": "Current revision owned by the native resource.",
          "example": 1
        },
        "agreementVersion": {
          "type": "integer",
          "minimum": 0,
          "description": "Native accepted guarantee agreement version.",
          "example": 1
        },
        "kind": {
          "type": "string",
          "enum": [
            "DEPOSIT",
            "CARD_HOLD",
            "PREPAID"
          ],
          "description": "Original native guarantee kind.",
          "example": "DEPOSIT"
        },
        "status": {
          "type": "string",
          "enum": [
            "PENDING",
            "SATISFIED",
            "WAIVED",
            "EXPIRED",
            "REFUNDED",
            "FORFEITED"
          ],
          "description": "Current native financial guarantee lifecycle.",
          "example": "PENDING"
        },
        "amount": {
          "type": "string",
          "pattern": "^(0|[1-9][0-9]{0,9})\\.[0-9]{2}$",
          "description": "Stored guarantee principal as an exact two-decimal string.",
          "example": "1.00"
        },
        "currency": {
          "type": "string",
          "pattern": "^[A-Z]{3}$",
          "description": "Original native guarantee currency.",
          "example": "GEL"
        },
        "dueAt": {
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "description": "Stored native instant, or null when no such event occurred.",
          "example": "2026-12-31T18:00:00.000Z"
        },
        "termsHash": {
          "type": "string",
          "nullable": true,
          "pattern": "^[a-f0-9]{64}$",
          "description": "Original accepted terms digest, or null for legacy evidence.",
          "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
        },
        "terms": {
          "type": "object",
          "description": "Original accepted native guarantee terms, or 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": "Canonical native terms schema.",
              "example": "hallify.reservation-guarantee.terms"
            },
            "version": {
              "type": "integer",
              "enum": [
                1
              ],
              "description": "Canonical native terms version.",
              "example": 1
            },
            "venueId": {
              "type": "string",
              "format": "uuid",
              "description": "Native venue UUID.",
              "example": "0604de3a-da74-4ad5-89f6-2dfe000d5391"
            },
            "publicChannelId": {
              "type": "string",
              "format": "uuid",
              "description": "Native reservation channel UUID.",
              "example": "9bee613d-3322-4a03-8b9f-8a6259984eee"
            },
            "servicePeriodId": {
              "type": "string",
              "format": "uuid",
              "description": "Selected native service-period UUID.",
              "example": "4846c409-f4df-40f6-81cc-1d7157a5c646"
            },
            "servicePeriodRevision": {
              "type": "integer",
              "minimum": 1,
              "description": "Accepted native service-period revision.",
              "example": 1
            },
            "kind": {
              "type": "string",
              "enum": [
                "DEPOSIT",
                "CARD_HOLD",
                "PREPAID"
              ],
              "description": "Original accepted guarantee kind.",
              "example": "DEPOSIT"
            },
            "amountBasis": {
              "type": "string",
              "enum": [
                "FIXED",
                "PER_GUEST"
              ],
              "description": "Original amount calculation basis.",
              "example": "FIXED"
            },
            "unitAmount": {
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,9})\\.[0-9]{2}$",
              "description": "Exact two-decimal amount per booking or guest.",
              "example": "1.00"
            },
            "totalAmount": {
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,9})\\.[0-9]{2}$",
              "description": "Exact two-decimal accepted total principal, with no tip.",
              "example": "1.00"
            },
            "currency": {
              "type": "string",
              "pattern": "^[A-Z]{3}$",
              "description": "Original native currency; no conversion is performed.",
              "example": "GEL"
            },
            "currencyMinorUnit": {
              "type": "integer",
              "enum": [
                2
              ],
              "description": "Native monetary scale.",
              "example": 2
            },
            "partySize": {
              "type": "integer",
              "minimum": 1,
              "maximum": 99,
              "description": "Exact accepted party size.",
              "example": 1
            },
            "scheduledAt": {
              "type": "string",
              "format": "date-time",
              "description": "Exact scheduled UTC slot instant.",
              "example": "2026-01-15T12:00:00.000Z"
            },
            "dueAt": {
              "type": "string",
              "format": "date-time",
              "description": "Exact payment deadline before conversion and collection.",
              "example": "2026-12-31T18:00:00.000Z"
            },
            "freeCancellationAt": {
              "type": "string",
              "format": "date-time",
              "description": "Exact free-cancellation cutoff.",
              "example": "2026-01-15T12:00:00.000Z"
            },
            "noShowAfter": {
              "type": "string",
              "format": "date-time",
              "description": "Earliest no-show forfeiture instant under the accepted grace rule.",
              "example": "2026-01-15T12:00:00.000Z"
            },
            "forfeitOnLateCancellation": {
              "type": "boolean",
              "description": "Accepted permission for explicit staff late-cancellation forfeiture.",
              "example": true
            },
            "forfeitOnNoShow": {
              "type": "boolean",
              "description": "Accepted permission for explicit staff no-show forfeiture; no automatic card debit.",
              "example": true
            },
            "termsVersion": {
              "type": "string",
              "description": "Accepted public terms version.",
              "example": "example"
            },
            "privacyVersion": {
              "type": "string",
              "description": "Accepted privacy notice version.",
              "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"
          }
        },
        "termsAcceptedAt": {
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "description": "Stored native instant, or null when no such event occurred.",
          "example": "2026-01-15T12:00:00.000Z"
        },
        "authorizationExpiresAt": {
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "description": "Stored native instant, or null when no such event occurred.",
          "example": "2026-12-31T18:00:00.000Z"
        },
        "satisfiedAt": {
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "description": "Stored native instant, or null when no such event occurred.",
          "example": "2026-01-15T12:00:00.000Z"
        },
        "waivedAt": {
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "description": "Stored native instant, or null when no such event occurred.",
          "example": "2026-01-15T12:00:00.000Z"
        }
      },
      "example": {
        "id": "ee887199-b691-4101-8431-097b03b1a2e2",
        "revision": 1,
        "agreementVersion": 1,
        "kind": "DEPOSIT",
        "status": "PENDING",
        "amount": "1.00",
        "currency": "GEL",
        "dueAt": null,
        "termsHash": null,
        "terms": null,
        "termsAcceptedAt": null,
        "authorizationExpiresAt": null,
        "satisfiedAt": null,
        "waivedAt": null
      }
    },
    "hasVerifiedSource": {
      "type": "boolean",
      "description": "A readable retained original-source proof exists. This flag issues no management, payment or bill authority; native entry still requires a new purpose-bound proof and current admission.",
      "example": true
    }
  },
  "example": {
    "kind": "RESERVATION",
    "id": "f9aedafe-e38a-4ff3-8ecc-3a580303c4e3",
    "referenceCode": "EXAMPLE",
    "revision": 1,
    "status": "REQUESTED",
    "scheduledAt": "2026-01-15T12:00:00.000Z",
    "endsAt": "2026-12-31T18:00:00.000Z",
    "partySize": 1,
    "originalGuarantee": null,
    "currentGuarantee": null,
    "hasVerifiedSource": true
  }
}
TranslatedErrorDto

Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.

statusCodeRequired

HTTP status code repeated from the response.

integer
Full definition
{
  "type": "integer",
  "description": "HTTP status code repeated from the response.",
  "example": 400
}
errorRequired

Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.

string
Full definition
{
  "type": "string",
  "description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.",
  "example": "errors.request.invalid"
}
codeRequired

Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions.

string
Full definition
{
  "type": "string",
  "example": "HTTP_BAD_REQUEST",
  "description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions."
}
messageRequired

Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application.

string
Full definition
{
  "type": "string",
  "example": "errors:http.badRequest",
  "description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application."
}
translationKeyRequired

Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback.

string
Full definition
{
  "type": "string",
  "example": "errors:http.badRequest",
  "description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback."
}
translationValuesOptional

Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.

object
Full definition
{
  "type": "object",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string",
        "example": "example"
      },
      {
        "type": "number",
        "example": 0
      },
      {
        "type": "boolean",
        "example": true
      }
    ],
    "example": "example"
  },
  "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
  "example": {
    "exampleKey": "example"
  }
}
validationErrorsOptional

Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.

array
Full definition
{
  "description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.",
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ValidationErrorDto"
  },
  "example": [
    {
      "field": "email",
      "translationKey": "validation:isEmail",
      "code": "isEmail",
      "message": "validation:isEmail"
    }
  ]
}
detailsOptional

Optional domain-specific blocker or validation details

oneOf
Full definition
{
  "description": "Optional domain-specific blocker or validation details",
  "oneOf": [
    {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": [
        "example"
      ]
    },
    {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": {
        "exampleKey": "example"
      }
    }
  ],
  "example": [
    "example"
  ]
}
Full definition
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "description": "HTTP status code repeated from the response.",
      "example": 400
    },
    "error": {
      "type": "string",
      "description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.",
      "example": "errors.request.invalid"
    },
    "code": {
      "type": "string",
      "example": "HTTP_BAD_REQUEST",
      "description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions."
    },
    "message": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application."
    },
    "translationKey": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
      "example": {
        "exampleKey": "example"
      }
    },
    "validationErrors": {
      "description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorDto"
      },
      "example": [
        {
          "field": "email",
          "translationKey": "validation:isEmail",
          "code": "isEmail",
          "message": "validation:isEmail"
        }
      ]
    },
    "details": {
      "description": "Optional domain-specific blocker or validation details",
      "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": "Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.",
  "example": {
    "statusCode": 400,
    "error": "errors:http.badRequest",
    "code": "HTTP_BAD_REQUEST",
    "message": "errors:http.badRequest",
    "translationKey": "errors:http.badRequest"
  }
}
ValidationErrorDto

Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.

fieldRequired

Public field path. Nested properties and array indices are separated by dots.

string
Full definition
{
  "type": "string",
  "example": "email",
  "description": "Public field path. Nested properties and array indices are separated by dots."
}
translationKeyRequired

Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog.

string
Full definition
{
  "type": "string",
  "example": "validation:isEmail",
  "description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog."
}
codeRequired

Stable validator identifier for this field failure. Custom validators may define additional identifiers.

string
Full definition
{
  "type": "string",
  "example": "isEmail",
  "description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers."
}
messageRequired

Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included.

string
Full definition
{
  "type": "string",
  "example": "validation:isEmail",
  "description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included."
}
translationValuesOptional

Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.

object
Full definition
{
  "type": "object",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string",
        "example": "example"
      },
      {
        "type": "number",
        "example": 0
      },
      {
        "type": "boolean",
        "example": true
      }
    ],
    "example": "example"
  },
  "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
  "example": {
    "exampleKey": "example"
  }
}
Full definition
{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "example": "email",
      "description": "Public field path. Nested properties and array indices are separated by dots."
    },
    "translationKey": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog."
    },
    "code": {
      "type": "string",
      "example": "isEmail",
      "description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers."
    },
    "message": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
      "example": {
        "exampleKey": "example"
      }
    }
  },
  "required": [
    "field",
    "translationKey",
    "code",
    "message"
  ],
  "description": "Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.",
  "example": {
    "field": "email",
    "translationKey": "validation:isEmail",
    "code": "isEmail",
    "message": "validation:isEmail"
  }
}
JsonValue

Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.

Full definition
{
  "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": "Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.",
  "example": "example"
}

Hallify uses essential cookies and optional analytics.

Essential cookies keep sign-in, locale, and theme preferences working. Analytics is off until you choose to allow it.