Files
yookassa-sdk-php/docs/classes/YooKassa-Model-Payment-Confirmation-ConfirmationEmbedded.md
Евгений Ю. Лозный 260d13f890 Добавлен прием платежей через Alfa Pay. Добавлен новый тип ошибки RuleViolationError
Добавлены нулевые привязки по СБП
Добавлена причина отмены возвратов `payment_expired`
2026-06-29 17:46:40 +03:00

19 KiB

YooKassa API SDK

Class: \YooKassa\Model\Payment\Confirmation\ConfirmationEmbedded

Namespace: \YooKassa\Model\Payment\Confirmation


Summary:

Класс, представляющий модель ConfirmationEmbedded.

Description:

Сценарий, при котором действия, необходимые для подтверждения платежа, будут зависеть от способа оплаты, который пользователь выберет в виджете ЮKassa. Подтверждение от пользователя получит ЮKassa — вам необходимо только встроить виджет к себе на страницу.


Constants

  • No constants found

Properties

Visibility Name Flag Summary
public $confirmation_token Токен для платежного виджета
public $confirmationToken Токен для платежного виджета
public $type Код сценария подтверждения
protected $_type Код сценария подтверждения.

Methods

Visibility Name Flag Summary
public __construct()
public __get() Возвращает значение свойства.
public __isset() Проверяет наличие свойства.
public __set() Устанавливает значение свойства.
public __unset() Удаляет свойство.
public fromArray() Устанавливает значения свойств текущего объекта из массива.
public getConfirmationData()
public getConfirmationToken() Возвращает токен для инициализации платежного виджета.
public getConfirmationToken()
public getConfirmationUrl()
public getType() Возвращает код сценария подтверждения.
public getValidator()
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public setConfirmationToken() Устанавливает токен для инициализации платежного виджета.
public setType() Устанавливает код сценария подтверждения
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected validatePropertyValue()

Details


Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Properties

public $confirmation_token : string


Description

Токен для платежного виджета

Type: string

Details:

public $confirmationToken : string


Description

Токен для платежного виджета

Type: string

Details:

public $type : string


Description

Код сценария подтверждения

Type: string

Details:

protected $_type : ?string


Summary

Код сценария подтверждения.

Type: ?string

Details:


Methods

public __construct() : mixed

public __construct(?array $data = []) : mixed

Details:

Parameters:
Type Name Description
?array data

Returns: mixed -

public __get() : mixed

public __get(string $propertyName) : mixed

Summary

Возвращает значение свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя свойства

Returns: mixed - Значение свойства

public __isset() : bool

public __isset(string $propertyName) : bool

Summary

Проверяет наличие свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public __set() : void

public __set(string $propertyName, mixed $value) : void

Summary

Устанавливает значение свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя свойства
mixed value Значение свойства

Returns: void -

public __unset() : void

public __unset(string $propertyName) : void

Summary

Удаляет свойство.

Details:

Parameters:
Type Name Description
string propertyName Имя удаляемого свойства

Returns: void -

public fromArray() : void

public fromArray(array|\Traversable $sourceArray) : void

Summary

Устанавливает значения свойств текущего объекта из массива.

Details:

Parameters:
Type Name Description
array OR \Traversable sourceArray Ассоциативный массив с настройками

Returns: void -

public getConfirmationData()

public getConfirmationData() 

Description

Для ConfirmationQr

Details:

Returns: -

public getConfirmationToken() : string|null

public getConfirmationToken() : string|null

Summary

Возвращает токен для инициализации платежного виджета.

Details:

Returns: string|null - Токен для инициализации платежного виджета

public getConfirmationToken()

public getConfirmationToken() 

Description

Для ConfirmationEmbedded

Details:

Returns: -

public getConfirmationUrl()

public getConfirmationUrl() 

Description

Для ConfirmationRedirect

Details:

Returns: -

public getType() : ?string

public getType() : ?string

Summary

Возвращает код сценария подтверждения.

Details:

Returns: ?string -

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

public jsonSerialize() : array

public jsonSerialize() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.

Details:

Returns: array - Ассоциативный массив со свойствами текущего объекта

public offsetExists() : bool

public offsetExists(string $offset) : bool

Summary

Проверяет наличие свойства.

Details:

Parameters:
Type Name Description
string offset Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public offsetGet() : mixed

public offsetGet(string $offset) : mixed

Summary

Возвращает значение свойства.

Details:

Parameters:
Type Name Description
string offset Имя свойства

Returns: mixed - Значение свойства

public offsetSet() : void

public offsetSet(string $offset, mixed $value) : void

Summary

Устанавливает значение свойства.

Details:

Parameters:
Type Name Description
string offset Имя свойства
mixed value Значение свойства

Returns: void -

public offsetUnset() : void

public offsetUnset(string $offset) : void

Summary

Удаляет свойство.

Details:

Parameters:
Type Name Description
string offset Имя удаляемого свойства

Returns: void -

public setConfirmationToken() : self

public setConfirmationToken(string|null $confirmation_token = null) : self

Summary

Устанавливает токен для инициализации платежного виджета.

Details:

Parameters:
Type Name Description
string OR null confirmation_token Токен для инициализации платежного виджета

Returns: self -

public setType() : self

public setType(string|null $type = null) : self

Summary

Устанавливает код сценария подтверждения

Details:

Parameters:
Type Name Description
string OR null type Код сценария подтверждения

Returns: self -

public toArray() : array

public toArray() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().

Details:

Returns: array - Ассоциативный массив со свойствами текущего объекта

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

Возвращает массив свойств которые не существуют, но были заданы у объекта.

Details:

Returns: array - Ассоциативный массив с не существующими у текущего объекта свойствами

protected validatePropertyValue() : mixed

protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed

Details:

Parameters:
Type Name Description
string propertyName
mixed propertyValue

Returns: mixed -


Top Namespaces


Reports


This document was automatically generated from source code comments on 2026-06-29 using phpDocumentor

© 2026 YooMoney