Перейти к содержимому
HallifyРазработчикамПоиск по документации
Открыть Hallify
Разделы

Гостевые платежи

Привязать handoff гостевого checkout

POST/public/guest-payment-handoffs

Привязывает один заранее сохранённый вызывающей стороной handoff к digest токена получателя и настроенному checkout origin на срок до шестидесяти секунд. Получатель сначала сохраняет свой новый токен; инициатор проверяет точные origin, окно и контекст получателя перед обменом только digest и этим handoff. После окончания финансового окна потреблённый checkout использует точные полномочия раскрытия собственного результата; handoff не продлевает финансовое окно. Сохраняются проверка происхождения нативного источника и текущего отзыва полномочий. Средства не создаются и не отправляются.

Авторизация

Персональный доступ передаётся в body: guest-payment-access.

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

Параметры

originЗаголовок · Обязательно

Фактический origin текущей транспортной аудитории платёжного доступа.

string
Полное определение
{
  "type": "string",
  "maxLength": 2048,
  "example": "example"
}

Тело запроса

Обязательно

Токен доступа, заранее сохранённый вызывающей стороной случайный handoff и digest уже сохранённого токена получателя.

application/json

IssueGuestPaymentHandoffDto
Полное определение
{
  "$ref": "#/components/schemas/IssueGuestPaymentHandoffDto"
}

Ответы

200Приватное no-store подтверждение точно привязанного handoff. Повтор не продлевает срок и не меняет получателя.
GuestPaymentHandoffReceiptDto
Полное определение
{
  "$ref": "#/components/schemas/GuestPaymentHandoffReceiptDto"
}
Пример ответа · 200 · application/json
{
  "accessId": "b93bc84d-84db-4161-840b-c3c7a7875b1d",
  "handoff": "gph1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  "expiresAt": "2026-12-31T18:00:00.000Z",
  "destinationOrigin": "https://example.test/resource"
}
400Неверное представление токена доступа или digest получателя.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 400 · application/json
{
  "statusCode": 400,
  "error": "errors:http.badRequest",
  "code": "HTTP_BAD_REQUEST",
  "message": "errors:http.badRequest",
  "translationKey": "errors:http.badRequest"
}
404Текущий приватный доступ, origin или нативная допустимость оплаты недоступны.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 404 · application/json
{
  "statusCode": 404,
  "error": "errors:http.notFound",
  "code": "HTTP_NOT_FOUND",
  "message": "errors:http.notFound",
  "translationKey": "errors:http.notFound"
}
409Нативный источник изменился при получении блокировок.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 409 · application/json
{
  "statusCode": 409,
  "error": "errors:http.conflict",
  "code": "HTTP_CONFLICT",
  "message": "errors:http.conflict",
  "translationKey": "errors:http.conflict"
}

Схемы

IssueGuestPaymentHandoffDto

Приватный токен доступа и предложение одноразового handoff с привязкой к получателю. Сохраните случайный handoff до отправки, чтобы при потере ответа повторить то же предложение.

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

Несекретный UUID платёжного доступа, выданного для нативного источника.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "Несекретный UUID платёжного доступа, выданного для нативного источника.",
  "example": "b93bc84d-84db-4161-840b-c3c7a7875b1d"
}
capabilityОбязательно

Текущий приватный платёжный токен, передаваемый только в этом теле.

string
Полное определение
{
  "type": "string",
  "minLength": 48,
  "maxLength": 48,
  "pattern": "^gpa1_[A-Za-z0-9_-]{43}$",
  "example": "gpa1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  "writeOnly": true,
  "description": "Текущий приватный платёжный токен, передаваемый только в этом теле."
}
handoffОбязательно

Канонический base64url handoff из 32 байт с префиксом gph1_, создаваемый клиентом. Используйте криптографическую случайность и сохраните приватно до этого вызова.

string
Полное определение
{
  "type": "string",
  "minLength": 48,
  "maxLength": 48,
  "pattern": "^gph1_[A-Za-z0-9_-]{43}$",
  "example": "gph1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  "writeOnly": true,
  "description": "Канонический base64url handoff из 32 байт с префиксом gph1_, создаваемый клиентом. Используйте криптографическую случайность и сохраните приватно до этого вызова."
}
recipientCapabilityHashОбязательно

Шестнадцатеричный SHA-256 digest полного нового gpa1_ токена, уже выбранного и приватно сохранённого принимающим checkout-контекстом. Исходный токен получателя не передаётся инициатору.

string
Полное определение
{
  "type": "string",
  "minLength": 64,
  "maxLength": 64,
  "pattern": "^[a-f0-9]{64}$",
  "writeOnly": true,
  "description": "Шестнадцатеричный SHA-256 digest полного нового gpa1_ токена, уже выбранного и приватно сохранённого принимающим checkout-контекстом. Исходный токен получателя не передаётся инициатору.",
  "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
}
Полное определение
{
  "type": "object",
  "properties": {
    "accessId": {
      "type": "string",
      "format": "uuid",
      "description": "Несекретный UUID платёжного доступа, выданного для нативного источника.",
      "example": "b93bc84d-84db-4161-840b-c3c7a7875b1d"
    },
    "capability": {
      "type": "string",
      "minLength": 48,
      "maxLength": 48,
      "pattern": "^gpa1_[A-Za-z0-9_-]{43}$",
      "example": "gpa1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "writeOnly": true,
      "description": "Текущий приватный платёжный токен, передаваемый только в этом теле."
    },
    "handoff": {
      "type": "string",
      "minLength": 48,
      "maxLength": 48,
      "pattern": "^gph1_[A-Za-z0-9_-]{43}$",
      "example": "gph1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "writeOnly": true,
      "description": "Канонический base64url handoff из 32 байт с префиксом gph1_, создаваемый клиентом. Используйте криптографическую случайность и сохраните приватно до этого вызова."
    },
    "recipientCapabilityHash": {
      "type": "string",
      "minLength": 64,
      "maxLength": 64,
      "pattern": "^[a-f0-9]{64}$",
      "writeOnly": true,
      "description": "Шестнадцатеричный SHA-256 digest полного нового gpa1_ токена, уже выбранного и приватно сохранённого принимающим checkout-контекстом. Исходный токен получателя не передаётся инициатору.",
      "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
    }
  },
  "description": "Приватный токен доступа и предложение одноразового handoff с привязкой к получателю. Сохраните случайный handoff до отправки, чтобы при потере ответа повторить то же предложение.",
  "required": [
    "accessId",
    "capability",
    "handoff",
    "recipientCapabilityHash"
  ],
  "example": {
    "accessId": "b93bc84d-84db-4161-840b-c3c7a7875b1d",
    "capability": "gpa1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    "handoff": "gph1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    "recipientCapabilityHash": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
  }
}
GuestPaymentHandoffReceiptDto

Приватное подтверждение одноразового handoff, связанного с одним digest токена получателя и настроенным origin checkout верхнего уровня.

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

Несекретный UUID контекста доступа для сопоставления получателя и handshake.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "Несекретный UUID контекста доступа для сопоставления получателя и handshake.",
  "example": "b93bc84d-84db-4161-840b-c3c7a7875b1d"
}
handoffОбязательно

Точный приватный handoff, заранее сохранённый вызывающей стороной. Передавайте только проверенному checkout-получателю или приватному bridge с POST-телом.

string
Полное определение
{
  "type": "string",
  "minLength": 48,
  "maxLength": 48,
  "pattern": "^gph1_[A-Za-z0-9_-]{43}$",
  "example": "gph1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  "description": "Точный приватный handoff, заранее сохранённый вызывающей стороной. Передавайте только проверенному checkout-получателю или приватному bridge с POST-телом."
}
expiresAtОбязательно

Первоначальный срок погашения: до шестидесяти секунд в пределах сроков доступа и нативных полномочий. Успешные повторы восстанавливают ту же погашенную аудиторию без продления доступа.

string · date-time
Полное определение
{
  "type": "string",
  "format": "date-time",
  "description": "Первоначальный срок погашения: до шестидесяти секунд в пределах сроков доступа и нативных полномочий. Успешные повторы восстанавливают ту же погашенную аудиторию без продления доступа.",
  "example": "2026-12-31T18:00:00.000Z"
}
destinationOriginОбязательно

Настроенный доверенный checkout origin. postMessage должен использовать этот точный targetOrigin с ожидаемыми окном и контекстом доступа; нельзя использовать wildcard или передавать в родительский frame.

string · uri
Полное определение
{
  "type": "string",
  "format": "uri",
  "description": "Настроенный доверенный checkout origin. postMessage должен использовать этот точный targetOrigin с ожидаемыми окном и контекстом доступа; нельзя использовать wildcard или передавать в родительский frame.",
  "example": "https://example.test/resource"
}
Полное определение
{
  "type": "object",
  "properties": {
    "accessId": {
      "type": "string",
      "format": "uuid",
      "description": "Несекретный UUID контекста доступа для сопоставления получателя и handshake.",
      "example": "b93bc84d-84db-4161-840b-c3c7a7875b1d"
    },
    "handoff": {
      "type": "string",
      "minLength": 48,
      "maxLength": 48,
      "pattern": "^gph1_[A-Za-z0-9_-]{43}$",
      "example": "gph1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "description": "Точный приватный handoff, заранее сохранённый вызывающей стороной. Передавайте только проверенному checkout-получателю или приватному bridge с POST-телом."
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "description": "Первоначальный срок погашения: до шестидесяти секунд в пределах сроков доступа и нативных полномочий. Успешные повторы восстанавливают ту же погашенную аудиторию без продления доступа.",
      "example": "2026-12-31T18:00:00.000Z"
    },
    "destinationOrigin": {
      "type": "string",
      "format": "uri",
      "description": "Настроенный доверенный checkout origin. postMessage должен использовать этот точный targetOrigin с ожидаемыми окном и контекстом доступа; нельзя использовать wildcard или передавать в родительский frame.",
      "example": "https://example.test/resource"
    }
  },
  "description": "Приватное подтверждение одноразового handoff, связанного с одним digest токена получателя и настроенным origin checkout верхнего уровня.",
  "required": [
    "accessId",
    "handoff",
    "expiresAt",
    "destinationOrigin"
  ],
  "example": {
    "accessId": "b93bc84d-84db-4161-840b-c3c7a7875b1d",
    "handoff": "gph1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    "expiresAt": "2026-12-31T18:00:00.000Z",
    "destinationOrigin": "https://example.test/resource"
  }
}
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"
}

Hallify использует обязательные cookies и опциональную аналитику.

Обязательные cookies поддерживают вход, язык и тему. Аналитика выключена, пока вы явно ее не разрешите.