yookassa-sdk-php/docs/classes/YooKassa-Model-Payment-CancellationDetails.md

YooKassa API SDK

Class: \YooKassa\Model\Payment\CancellationDetails

Namespace: \YooKassa\Model\Payment

---

Summary:

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

Description:

Комментарий к статусу ~canceled: кто отменил платеж и по какой причине. Подробнее про неуспешные платежи

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
public	$party		Инициатор отмены платежа
public	$reason		Причина отмены платежа

---

Methods

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

---

Details

• File: lib/Model/Payment/CancellationDetails.php

• Package: YooKassa\Model

• Class Hierarchy:

  • \YooKassa\Common\AbstractObject
  • \YooKassa\Model\Payment\CancellationDetails

• Implements:

  • \YooKassa\Model\CancellationDetailsInterface

• See Also:

---

Tags

Tag	Version	Description
category		Class
author		cms@yoomoney.ru

---

Properties

public $party : string

---

Description

Инициатор отмены платежа

Type: string

Details:

public $reason : string

---

Description

Причина отмены платежа

Type: string

Details:

---

Methods

public __construct() : mixed

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

Summary

AbstractObject constructor.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array OR null	data

Returns: mixed -

public __get() : mixed

public __get(string $propertyName) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public __isset() : bool

public __isset(string $propertyName) : bool

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public __set() : void

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public __unset() : void

public __unset(string $propertyName) : void

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public fromArray() : void

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public getParty() : string

public getParty() : string

Summary

Возвращает участника процесса платежа, который принял решение об отмене транзакции.

Details:

• Inherited From: \YooKassa\Model\Payment\CancellationDetails

Returns: string - Инициатор отмены платежа

public getReason() : string

public getReason() : string

Summary

Возвращает причину отмены платежа.

Details:

• Inherited From: \YooKassa\Model\Payment\CancellationDetails

Returns: string - Причина отмены платежа

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: \YooKassa\Validator\Validator -

public jsonSerialize() : array

public jsonSerialize() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

public offsetExists() : bool

public offsetExists(string $offset) : bool

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public offsetGet() : mixed

public offsetGet(string $offset) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public offsetSet() : void

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public offsetUnset() : void

public offsetUnset(string $offset) : void

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public setParty() : self

public setParty(string|null $party = null) : self

Summary

Устанавливает участника процесса платежа, который принял решение об отмене транзакции.

Details:

• Inherited From: \YooKassa\Model\Payment\CancellationDetails

Parameters:

Type	Name	Description
string OR null	party

Returns: self -

public setReason() : self

public setReason(string|null $reason = null) : self

Summary

Устанавливает причину отмены платежа.

Details:

• Inherited From: \YooKassa\Model\Payment\CancellationDetails

Parameters:

Type	Name	Description
string OR null	reason

Returns: self -

public toArray() : array

public toArray() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

protected validatePropertyValue() : mixed

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName
mixed	propertyValue

Returns: mixed -

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 0
• Deprecated - 34

---

This document was automatically generated from source code comments on 2025-07-31 using phpDocumentor

© 2025 YooMoney