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

YooKassa API SDK

Class: \YooKassa\Request\Refunds\CreateRefundRequest

Namespace: \YooKassa\Request\Refunds

---

Summary:

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

---

Examples

02-builder.php 148 35 Пример использования билдера

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
public	$amount		Сумма возврата
public	$amount		Сумма возврата
public	$deal		Информация о сделке
public	$description		Комментарий к операции возврата, основание для возврата средств покупателю.
public	$paymentId		Айди платежа для которого создаётся возврат
public	$paymentId		Идентификатор платежа для которого создаётся возврат
public	$receipt		Инстанс чека или null
public	$sources		Информация о распределении денег — сколько и в какой магазин нужно перевести

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства
public	__isset()		Проверяет наличие свойства
public	__set()		Устанавливает значение свойства
public	__unset()		Удаляет свойство
public	builder()		Возвращает билдер объектов текущего типа
public	clearValidationError()		Очищает статус валидации текущего запроса
public	fromArray()		Устанавливает значения свойств текущего объекта из массива
public	getAmount()		Возвращает сумму возврата
public	getDeal()		Возвращает данные о сделке, в составе которой проходит возврат
public	getDescription()		Возвращает комментарий к возврату или null, если комментарий не задан
public	getLastValidationError()		Возвращает последнюю ошибку валидации
public	getPaymentId()		Возвращает идентификатор платежа для которого создаётся возврат средств
public	getReceipt()		Возвращает чек, если он есть
public	getSources()		Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести
public	hasAmount()		Проверяет, была ли установлена сумма возврата
public	hasDeal()		Проверяет, были ли установлены данные о сделке
public	hasDescription()		Проверяет задан ли комментарий к создаваемому возврату
public	hasPaymentId()		Проверяет, был ли установлена идентификатор платежа
public	hasReceipt()		Проверяет наличие чека
public	hasSources()		Проверяет наличие информации о распределении денег
public	jsonSerialize()
public	offsetExists()
public	offsetGet()
public	offsetSet()
public	offsetUnset()
public	removeReceipt()		Удаляет чек из запроса
public	setAmount()		Устанавливает сумму
public	setDeal()		Устанавливает данные о сделке, в составе которой проходит возврат
public	setDescription()		Устанавливает комментарий к возврату
public	setPaymentId()		Устанавливает идентификатор платежа для которого создаётся возврат
public	setReceipt()		Устанавливает чек
public	setSources()		Устанавливает sources (массив распределения денег между магазинами)
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
public	validate()		Валидирует текущий запрос, проверяет все ли нужные свойства установлены
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта
protected	setValidationError()		Устанавливает ошибку валидации

---

Details

• File: lib/Request/Refunds/CreateRefundRequest.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Common\AbstractRequest
  • \YooKassa\Common\AbstractRefundRequest
  • \YooKassa\Request\Refunds\CreateRefundRequest
• Implements:
  • \YooKassa\Request\Refunds\CreateRefundRequestInterface

---

Properties

public $amount : \YooKassa\Model\AmountInterface

---

Description

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

Type: AmountInterface

Details:

public $amount : \YooKassa\Model\AmountInterface

---

Description

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

Type: AmountInterface

Details:

• Inherited From: \YooKassa\Common\AbstractRefundRequest

public $deal : \YooKassa\Model\Deal\RefundDealData|null

---

Description

Информация о сделке

Type: RefundDealData|null

Details:

public $description : string

---

Description

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

Type: string

Details:

public $paymentId : string

---

Description

Айди платежа для которого создаётся возврат

Type: string

Details:

public $paymentId : string

---

Description

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

Type: string

Details:

• Inherited From: \YooKassa\Common\AbstractRefundRequest

public $receipt : \YooKassa\Model\ReceiptInterface|null

---

Description

Инстанс чека или null

Type: ReceiptInterface|null

Details:

public $sources : \YooKassa\Model\SourceInterface[]|null

---

Description

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

Type: SourceInterface[]|null

Details:

---

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 builder() : \YooKassa\Request\Refunds\CreateRefundRequestBuilder

Static public builder() : \YooKassa\Request\Refunds\CreateRefundRequestBuilder

Summary

Возвращает билдер объектов текущего типа

Details:

• Inherited From: \YooKassa\Request\Refunds\CreateRefundRequest

Returns: \YooKassa\Request\Refunds\CreateRefundRequestBuilder - Инстанс билдера запросов

public clearValidationError() : mixed

public clearValidationError() : mixed

Summary

Очищает статус валидации текущего запроса

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

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\Common\AbstractRefundRequest

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

public getDeal() : \YooKassa\Model\Deal\RefundDealData

public getDeal() : \YooKassa\Model\Deal\RefundDealData

Summary

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

Details:

• Inherited From: \YooKassa\Request\Refunds\CreateRefundRequest

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

public getDescription() : string

public getDescription() : string

Summary

Возвращает комментарий к возврату или null, если комментарий не задан

Details:

• Inherited From: \YooKassa\Request\Refunds\CreateRefundRequest

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

public getLastValidationError() : string

public getLastValidationError() : string

Summary

Возвращает последнюю ошибку валидации

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Returns: string - Последняя произошедшая ошибка валидации

public getPaymentId() : string

public getPaymentId() : string

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRefundRequest

Returns: string - Идентификатор платежа для которого создаётся возврат

public getReceipt() : \YooKassa\Model\ReceiptInterface|null

public getReceipt() : \YooKassa\Model\ReceiptInterface|null

Summary

Возвращает чек, если он есть

Details:

• Inherited From: \YooKassa\Common\AbstractRefundRequest

Returns: \YooKassa\Model\ReceiptInterface|null - Данные фискального чека 54-ФЗ или null, если чека нет

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\Refunds\CreateRefundRequest

Returns: \YooKassa\Model\SourceInterface[] - Информация о распределении денег

public hasAmount() : bool

public hasAmount() : bool

Summary

Проверяет, была ли установлена сумма возврата

Details:

• Inherited From: \YooKassa\Common\AbstractRefundRequest

Returns: bool - True если сумма возврата была установлена, false если нет

public hasDeal() : bool

public hasDeal() : bool

Summary

Проверяет, были ли установлены данные о сделке

Details:

• Inherited From: \YooKassa\Request\Refunds\CreateRefundRequest

Returns: bool - True если данные о сделке были установлены, false если нет

public hasDescription() : bool

public hasDescription() : bool

Summary

Проверяет задан ли комментарий к создаваемому возврату

Details:

• Inherited From: \YooKassa\Request\Refunds\CreateRefundRequest

Returns: bool - True если комментарий установлен, false если нет

public hasPaymentId() : bool

public hasPaymentId() : bool

Summary

Проверяет, был ли установлена идентификатор платежа

Details:

• Inherited From: \YooKassa\Common\AbstractRefundRequest

Returns: bool - True если идентификатор платежа был установлен, false если нет

public hasReceipt() : bool

public hasReceipt() : bool

Summary

Проверяет наличие чека

Details:

• Inherited From: \YooKassa\Common\AbstractRefundRequest

Returns: bool - True если чек есть, false если нет

public hasSources() : bool

public hasSources() : bool

Summary

Проверяет наличие информации о распределении денег

Details:

• Inherited From: \YooKassa\Request\Refunds\CreateRefundRequest

Returns: bool -

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 removeReceipt() : mixed

public removeReceipt() : mixed

Summary

Удаляет чек из запроса

Details:

• Inherited From: \YooKassa\Request\Refunds\CreateRefundRequest

Returns: mixed -

public setAmount() : self

public setAmount(\YooKassa\Model\AmountInterface|array|string $value) : self

Summary

Устанавливает сумму

Details:

• Inherited From: \YooKassa\Common\AbstractRefundRequest

Parameters:

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

Returns: self - Инстанс билдера запросов

public setDeal() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\Refunds\CreateRefundRequest

Parameters:

Type	Name	Description
\YooKassa\Model\Deal\RefundDealData 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\Request\Refunds\CreateRefundRequest

Parameters:

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

Throws:

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

Returns: mixed -

public setPaymentId() : mixed

public setPaymentId(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRefundRequest

Parameters:

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

Throws:

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

Returns: mixed -

public setReceipt() : mixed

public setReceipt(\YooKassa\Model\ReceiptInterface|array|null $value) : mixed

Summary

Устанавливает чек

Details:

• Inherited From: \YooKassa\Common\AbstractRefundRequest

Parameters:

Type	Name	Description
\YooKassa\Model\ReceiptInterface OR array OR null	value	Инстанс чека или null для удаления информации о чеке

Throws:

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

Returns: mixed -

public setSources() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\Refunds\CreateRefundRequest

Parameters:

Type	Name	Description
\YooKassa\Model\SourceInterface[] OR array	value	Массив распределения денег между магазинами

Returns: mixed -

public toArray() : array

public toArray() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

public validate() : bool

Abstract public validate() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Returns: bool - True если запрос валиден, false если нет

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

protected setValidationError() : mixed

protected setValidationError(string $value) : mixed

Summary

Устанавливает ошибку валидации

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Parameters:

Type	Name	Description
string	value	Ошибка, произошедшая при валидации объекта

Returns: mixed -

---

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