Files
yookassa-sdk-php/docs/classes/YooKassa-Model-Payment-Confirmation-ConfirmationRedirect.md

26 KiB

YooKassa API SDK

Class: \YooKassa\Model\Payment\Confirmation\ConfirmationRedirect

Namespace: \YooKassa\Model\Payment\Confirmation


Summary:

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

Description:

Сценарий, при котором необходимо отправить плательщика на веб-страницу ЮKassa или партнера для подтверждения платежа.


Constants

  • No constants found

Properties

Visibility Name Flag Summary
public $confirmation_url URL на который необходимо перенаправить плательщика для подтверждения оплаты
public $confirmationUrl URL на который необходимо перенаправить плательщика для подтверждения оплаты
public $enforce Требование принудительного подтверждения платежа покупателем, требование 3-D Secure для оплаты банковскими картами. По умолчанию определяется политикой платежной системы
public $return_url URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера
public $returnUrl URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера
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 getConfirmationUrl()
public getConfirmationUrl() Возвращает URL на который необходимо перенаправить плательщика для подтверждения оплаты
public getEnforce() Возвращает флаг принудительного подтверждения платежа покупателем
public getReturnUrl() Возвращает URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера
public getType() Возвращает код сценария подтверждения.
public getValidator()
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public setConfirmationUrl() Устанавливает URL на который необходимо перенаправить плательщика для подтверждения оплаты
public setEnforce() Устанавливает флаг принудительного подтверждения платежа покупателем
public setReturnUrl() Устанавливает URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера
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_url : string


Description

URL на который необходимо перенаправить плательщика для подтверждения оплаты

Type: string

Details:

public $confirmationUrl : string


Description

URL на который необходимо перенаправить плательщика для подтверждения оплаты

Type: string

Details:

public $enforce : bool


Description

Требование принудительного подтверждения платежа покупателем, требование 3-D Secure для оплаты банковскими картами. По умолчанию определяется политикой платежной системы

Type: bool

Details:

public $return_url : string


Description

URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера

Type: string

Details:

public $returnUrl : string


Description

URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера

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()

public getConfirmationToken() 

Description

Для ConfirmationEmbedded

Details:

Returns: -

public getConfirmationUrl()

public getConfirmationUrl() 

Description

Для ConfirmationRedirect

Details:

Returns: -

public getConfirmationUrl() : string|null

public getConfirmationUrl() : string|null

Summary

Возвращает URL на который необходимо перенаправить плательщика для подтверждения оплаты

Details:

Returns: string|null - URL на который необходимо перенаправить плательщика для подтверждения оплаты

public getEnforce() : bool

public getEnforce() : bool

Summary

Возвращает флаг принудительного подтверждения платежа покупателем

Details:

Returns: bool - Требование принудительного подтверждения платежа покупателем, требование 3-D Secure для оплаты банковскими картами. По умолчанию определяется политикой платежной системы.

public getReturnUrl() : string|null

public getReturnUrl() : string|null

Summary

Возвращает URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера

Details:

Returns: string|null - URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера

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 setConfirmationUrl() : self

public setConfirmationUrl(string|null $confirmation_url = null) : self

Summary

Устанавливает URL на который необходимо перенаправить плательщика для подтверждения оплаты

Details:

Parameters:
Type Name Description
string OR null confirmation_url URL на который необходимо перенаправить плательщика для подтверждения оплаты

Returns: self -

public setEnforce() : self

public setEnforce(bool $enforce) : self

Summary

Устанавливает флаг принудительного подтверждения платежа покупателем

Details:

Parameters:
Type Name Description
bool enforce Требование принудительного подтверждения платежа покупателем, требование 3-D Secure для оплаты банковскими картами. По умолчанию определяется политикой платежной системы.

Returns: self -

public setReturnUrl() : self

public setReturnUrl(string|null $return_url = null) : self

Summary

Устанавливает URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера

Details:

Parameters:
Type Name Description
string OR null return_url URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера

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-08-13 using phpDocumentor

© 2026 YooMoney