Восстановить acknowledgement после потери ответа create

Исходный клиентский ключ команды для восстановления первого acknowledgement checkout с текущими точными нативными полномочиями на ресурс.

commandKeyОбязательно

Исходный ключ идемпотентности, созданный клиентом для оформления платежа: после удаления пробелов по краям он должен быть непустым и содержать не более 128 символов. Передаваемое значение для восстановления может содержать пробелы по краям в пределах указанного ограничения. Поиск связывает ключ с неизменным участником исходной операции и возвращает только первоначальное подтверждение после проверки текущего права на его раскрытие.

string

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

{
  "type": "string",
  "minLength": 1,
  "maxLength": 255,
  "description": "Исходный ключ идемпотентности, созданный клиентом для оформления платежа: после удаления пробелов по краям он должен быть непустым и содержать не более 128 символов. Передаваемое значение для восстановления может содержать пробелы по краям в пределах указанного ограничения. Поиск связывает ключ с неизменным участником исходной операции и возвращает только первоначальное подтверждение после проверки текущего права на его раскрытие.",
  "example": "synthetic-example-credential"
}

{
  "type": "object",
  "properties": {
    "commandKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Исходный ключ идемпотентности, созданный клиентом для оформления платежа: после удаления пробелов по краям он должен быть непустым и содержать не более 128 символов. Передаваемое значение для восстановления может содержать пробелы по краям в пределах указанного ограничения. Поиск связывает ключ с неизменным участником исходной операции и возвращает только первоначальное подтверждение после проверки текущего права на его раскрытие.",
      "example": "synthetic-example-credential"
    }
  },
  "description": "Исходный клиентский ключ команды для восстановления первого acknowledgement checkout с текущими точными нативными полномочиями на ресурс.",
  "required": [
    "commandKey"
  ],
  "example": {
    "commandKey": "synthetic-example-credential"
  }
}

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

schemaОбязательно

Дискриминатор версионированного документа исходного результата платёжной команды.

string

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

{
  "type": "string",
  "enum": [
    "hallify.restaurant-payment.command-result"
  ],
  "description": "Дискриминатор версионированного документа исходного результата платёжной команды.",
  "example": "hallify.restaurant-payment.command-result"
}

versionОбязательно

Версия схемы результата команды, сохранённая этим acknowledgement.

integer

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

{
  "type": "integer",
  "enum": [
    1
  ],
  "description": "Версия схемы результата команды, сохранённая этим acknowledgement.",
  "example": 1
}

checkoutIdОбязательно

UUID исходного checkout, выделенного один раз для этой постоянной команды.

string · uuid

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

{
  "type": "string",
  "format": "uuid",
  "description": "UUID исходного checkout, выделенного один раз для этой постоянной команды.",
  "example": "f5ef2bdc-76ae-45b6-851a-399882860529"
}

operationIdОбязательно

UUID исходной provider operation CREATE_CHECKOUT; replay и восстановление сохраняют идентичность этой операции.

string · uuid

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

{
  "type": "string",
  "format": "uuid",
  "description": "UUID исходной provider operation CREATE_CHECKOUT; replay и восстановление сохраняют идентичность этой операции.",
  "example": "44352441-86e0-4a70-8642-d5863bea459a"
}

actionОбязательно

Действие исходной принятой команды; эта гостевая граница подтверждает CREATE_CHECKOUT.

string

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

{
  "type": "string",
  "enum": [
    "CREATE_CHECKOUT"
  ],
  "description": "Действие исходной принятой команды; эта гостевая граница подтверждает CREATE_CHECKOUT.",
  "example": "CREATE_CHECKOUT"
}

stateОбязательно

Состояние первого сохранённого acknowledgement, всегда PREPARED. Текущие состояния операции, средств и нативного применения возвращаются методом progress checkout.

string

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

{
  "type": "string",
  "enum": [
    "PREPARED"
  ],
  "description": "Состояние первого сохранённого acknowledgement, всегда PREPARED. Текущие состояния операции, средств и нативного применения возвращаются методом progress checkout.",
  "example": "PREPARED"
}

currencyОбязательно

Валюта исходных зафиксированных основной суммы, чаевых и итога.

string

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

{
  "type": "string",
  "enum": [
    "USD",
    "GEL"
  ],
  "description": "Валюта исходных зафиксированных основной суммы, чаевых и итога.",
  "example": "USD"
}

principalAmountОбязательно

Исходная зафиксированная основная сумма до отдельно принятых чаевых строкой с двумя дробными знаками в валюте результата.

string

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

{
  "type": "string",
  "example": "12.50",
  "description": "Исходная зафиксированная основная сумма до отдельно принятых чаевых строкой с двумя дробными знаками в валюте результата."
}

tipAmountОбязательно

Исходные зафиксированные чаевые, принятые с командой, неотрицательной строкой с двумя дробными знаками в валюте результата.

string

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

{
  "type": "string",
  "example": "0.00",
  "description": "Исходные зафиксированные чаевые, принятые с командой, неотрицательной строкой с двумя дробными знаками в валюте результата."
}

totalAmountОбязательно

Исходная сумма зафиксированных основной суммы и принятых чаевых строкой с двумя дробными знаками в валюте результата.

string

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

{
  "type": "string",
  "example": "12.50",
  "description": "Исходная сумма зафиксированных основной суммы и принятых чаевых строкой с двумя дробными знаками в валюте результата."
}

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

Стабильная оболочка ошибки общего обработчика 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"
  }
}

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

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

Рекурсивно допустимое 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"
}