meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Request-Refunds-RefundResponse.md

YooKassa API SDK

Class: \YooKassa\Request\Refunds\RefundResponse

Namespace: \YooKassa\Request\Refunds

---

Summary:

Класс объекта ответа от API при запросе одного конкретного возврата

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
public	$amount		Сумма возврата
public	$created_at		Время создания возврата
public	$createdAt		Время создания возврата
public	$deal		Данные о сделке, в составе которой проходит возврат
public	$description		Комментарий, основание для возврата средств покупателю
public	$id		Идентификатор возврата платежа
public	$payment_id		Идентификатор платежа
public	$paymentId		Идентификатор платежа
public	$receipt_registration		Статус регистрации чека
public	$receiptRegistration		Статус регистрации чека
public	$status		Статус возврата

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства
public	__isset()		Проверяет наличие свойства
public	__set()		Устанавливает значение свойства
public	__unset()		Удаляет свойство
public	fromArray()		Устанавливает значения свойств текущего объекта из массива
public	getAmount()		Возвращает сумму возврата
public	getCreatedAt()		Возвращает дату создания возврата
public	getDeal()		Возвращает данные о сделке, в составе которой проходит возврат
public	getDescription()		Возвращает комментарий к возврату
public	getId()		Возвращает идентификатор возврата платежа
public	getPaymentId()		Возвращает идентификатор платежа
public	getReceiptRegistration()		Возвращает статус регистрации чека
public	getRequestor()	deprecated
public	getSources()		Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести
public	getStatus()		Возвращает статус текущего возврата
public	jsonSerialize()
public	offsetExists()
public	offsetGet()
public	offsetSet()
public	offsetUnset()
public	setAmount()		Устанавливает сумму возврата
public	setCreatedAt()		Устанавливает вермя создания возврата
public	setDeal()		Устанавливает данные о сделке, в составе которой проходит возврат.
public	setDescription()		Устанавливает комментарий к возврату
public	setId()		Устанавливает идентификатор возврата
public	setPaymentId()		Устанавливает идентификатор платежа
public	setReceiptRegistration()		Устанавливает статус регистрации чека
public	setRequestor()	deprecated
public	setSources()		Устанавливает sources (массив распределения денег между магазинами)
public	setStatus()		Усианавливает стутус возврата платежа
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта

---

Details

• File: lib/Request/Refunds/RefundResponse.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Model\Refund
  • \YooKassa\Request\Refunds\AbstractRefundResponse
  • \YooKassa\Request\Refunds\RefundResponse

---

Properties

public $amount : \YooKassa\Model\AmountInterface

---

Description

Сумма возврата

Type: AmountInterface

Details:

• Inherited From: \YooKassa\Model\Refund

public $created_at : \DateTime

---

Description

Время создания возврата

Type: \DateTime

Details:

• Inherited From: \YooKassa\Model\Refund

public $createdAt : \DateTime

---

Description

Время создания возврата

Type: \DateTime

Details:

• Inherited From: \YooKassa\Model\Refund

public $deal : \YooKassa\Model\Deal\RefundDealInfo

---

Description

Данные о сделке, в составе которой проходит возврат

Type: RefundDealInfo

Details:

• Inherited From: \YooKassa\Model\Refund

public $description : string

---

Description

Комментарий, основание для возврата средств покупателю

Type: string

Details:

• Inherited From: \YooKassa\Model\Refund

public $id : string

---

Description

Идентификатор возврата платежа

Type: string

Details:

• Inherited From: \YooKassa\Model\Refund

public $payment_id : string

---

Description

Идентификатор платежа

Type: string

Details:

• Inherited From: \YooKassa\Model\Refund

public $paymentId : string

---

Description

Идентификатор платежа

Type: string

Details:

• Inherited From: \YooKassa\Model\Refund

public $receipt_registration : string

---

Description

Статус регистрации чека

Type: string

Details:

• Inherited From: \YooKassa\Model\Refund

public $receiptRegistration : string

---

Description

Статус регистрации чека

Type: string

Details:

• Inherited From: \YooKassa\Model\Refund

public $status : string

---

Description

Статус возврата

Type: string

Details:

• Inherited From: \YooKassa\Model\Refund

---

Methods

public __construct() : mixed

public __construct(array $data = array()) : mixed

Summary

AbstractObject constructor.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array	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() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public __unset() : mixed

public __unset(string $propertyName) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public fromArray() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public getAmount() : \YooKassa\Model\AmountInterface

public getAmount() : \YooKassa\Model\AmountInterface

Summary

Возвращает сумму возврата

Details:

• Inherited From: \YooKassa\Model\Refund

Returns: \YooKassa\Model\AmountInterface - Сумма возврата

public getCreatedAt() : \DateTime

public getCreatedAt() : \DateTime

Summary

Возвращает дату создания возврата

Details:

• Inherited From: \YooKassa\Model\Refund

Returns: \DateTime - Время создания возврата

public getDeal() : \YooKassa\Model\Deal\RefundDealInfo|null

public getDeal() : \YooKassa\Model\Deal\RefundDealInfo|null

Summary

Возвращает данные о сделке, в составе которой проходит возврат

Details:

• Inherited From: \YooKassa\Model\Refund

Returns: \YooKassa\Model\Deal\RefundDealInfo|null - Данные о сделке, в составе которой проходит возврат

public getDescription() : string

public getDescription() : string

Summary

Возвращает комментарий к возврату

Details:

• Inherited From: \YooKassa\Model\Refund

Returns: string - Комментарий, основание для возврата средств покупателю

public getId() : string

public getId() : string

Summary

Возвращает идентификатор возврата платежа

Details:

• Inherited From: \YooKassa\Model\Refund

Returns: string - Идентификатор возврата

public getPaymentId() : string

public getPaymentId() : string

Summary

Возвращает идентификатор платежа

Details:

• Inherited From: \YooKassa\Model\Refund

Returns: string - Идентификатор платежа

public getReceiptRegistration() : string

public getReceiptRegistration() : string

Summary

Возвращает статус регистрации чека

Details:

• Inherited From: \YooKassa\Model\Refund

Returns: string - Статус регистрации чека

(deprecated) - public getRequestor() : mixed

public getRequestor() : mixed

Deprecated DeprecatedНе используется. Будет удален в следующих версиях Details:

• Inherited From: \YooKassa\Model\Refund

Returns: mixed -

public getSources() : \YooKassa\Model\SourceInterface[]

public getSources() : \YooKassa\Model\SourceInterface[]

Summary

Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести

Details:

• Inherited From: \YooKassa\Model\Refund

Returns: \YooKassa\Model\SourceInterface[] -

Tags

Tag	Version	Description
inheritdoc

public getStatus() : string

public getStatus() : string

Summary

Возвращает статус текущего возврата

Details:

• Inherited From: \YooKassa\Model\Refund

Returns: string - Статус возврата

public jsonSerialize() : mixed

public jsonSerialize() : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: mixed -

public offsetExists() : mixed

public offsetExists(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetGet() : mixed

public offsetGet(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetSet() : mixed

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset
mixed	value

Returns: mixed -

public offsetUnset() : mixed

public offsetUnset(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public setAmount() : mixed

public setAmount(\YooKassa\Model\AmountInterface $value) : mixed

Summary

Устанавливает сумму возврата

Details:

• Inherited From: \YooKassa\Model\Refund

Parameters:

Type	Name	Description
\YooKassa\Model\AmountInterface	value	Сумма возврата

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если переданная сумма меньше или равна нулю

Returns: mixed -

public setCreatedAt() : mixed

public setCreatedAt(\DateTime $value) : mixed

Summary

Устанавливает вермя создания возврата

Details:

• Inherited From: \YooKassa\Model\Refund

Parameters:

Type	Name	Description
\DateTime	value	Время создания возврата

Throws:

Type	Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException	Выбрасывается если быо передано пустое значение
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если переданную строку или число не удалось интерпретировать как дату и время
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	\Exception

Returns: mixed -

public setDeal() : mixed

public setDeal(\YooKassa\Model\Deal\RefundDealInfo|array|null $value) : mixed

Summary

Устанавливает данные о сделке, в составе которой проходит возврат.

Details:

• Inherited From: \YooKassa\Model\Refund

Parameters:

Type	Name	Description
\YooKassa\Model\Deal\RefundDealInfo OR array OR null	value	Данные о сделке, в составе которой проходит возврат

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданные данные не удалось интерпретировать как данные сделки

Returns: mixed -

public setDescription() : mixed

public setDescription(string $value) : mixed

Summary

Устанавливает комментарий к возврату

Details:

• Inherited From: \YooKassa\Model\Refund

Parameters:

Type	Name	Description
string	value	Комментарий, основание для возврата средств покупателю

Throws:

Type	Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException	Выбрасывается если был передан пустой аргумент
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если аргумент не является строкой

Returns: mixed -

public setId() : mixed

public setId(string $value) : mixed

Summary

Устанавливает идентификатор возврата

Details:

• Inherited From: \YooKassa\Model\Refund

Parameters:

Type	Name	Description
string	value	Идентификатор возврата

Throws:

Type	Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException	Выбрасывается если был передан пустой аргумент
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если було передано невалидное значение
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если аргумент не является строкой

Returns: mixed -

public setPaymentId() : mixed

public setPaymentId(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Refund

Parameters:

Type	Name	Description
string	value	Идентификатор платежа

Throws:

Type	Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException	Выбрасывается если был передан пустой аргумент
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если було передано невалидное значение
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если аргумент не является строкой

Returns: mixed -

public setReceiptRegistration() : mixed

public setReceiptRegistration(string $value) : mixed

Summary

Устанавливает статус регистрации чека

Details:

• Inherited From: \YooKassa\Model\Refund

Parameters:

Type	Name	Description
string	value	Статус регистрации чека

Throws:

Type	Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException	Выбрасывается если был передан пустой аргумент
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если було передано невалидное значение
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если аргумент не является строкой

Returns: mixed -

(deprecated) - public setRequestor() : mixed

public setRequestor(mixed $value) : mixed

Deprecated DeprecatedНе используется. Будет удален в следующих версиях Details:

• Inherited From: \YooKassa\Model\Refund

Parameters:

Type	Name	Description
mixed	value

Returns: mixed -

public setSources() : mixed

public setSources(\YooKassa\Model\SourceInterface[]|array $value) : mixed

Summary

Устанавливает sources (массив распределения денег между магазинами)

Details:

• Inherited From: \YooKassa\Model\Refund

Parameters:

Type	Name	Description
\YooKassa\Model\SourceInterface[] OR array	value

Returns: mixed -

public setStatus() : mixed

public setStatus(string $value) : mixed

Summary

Усианавливает стутус возврата платежа

Details:

• Inherited From: \YooKassa\Model\Refund

Parameters:

Type	Name	Description
string	value	Статус возврата платежа

Throws:

Type	Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException	Выбрасывается если был передан пустой аргумент
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если було передано невалидное значение
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если аргумент не является строкой

Returns: mixed -

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 - Ассоциативный массив с не существующими у текущего объекта свойствами

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 1
• Deprecated - 25

---

This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor

© 2023 YooMoney