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

YooKassa API SDK

Class: \YooKassa\Request\Refunds\RefundsRequest

Namespace: \YooKassa\Request\Refunds

---

Summary:

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

---

Constants

Visibility	Name	Flag	Summary
public	MAX_LIMIT_VALUE		Максимальное количество объектов возвратов в выборке

---

Properties

Visibility	Name	Flag	Summary
public	$createdAtGt		Время создания, от (не включая)
public	$createdAtGte		Время создания, от (включительно)
public	$createdAtLt		Время создания, до (не включая)
public	$createdAtLte		Время создания, до (включительно)
public	$cursor		Токен для получения следующей страницы выборки
public	$limit		Ограничение количества объектов возврата, отображаемых на одной странице выдачи
public	$paymentId		Идентификатор платежа
public	$status		Статус возврата

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства
public	__isset()		Проверяет наличие свойства
public	__set()		Устанавливает значение свойства
public	__unset()		Удаляет свойство
public	builder()		Возвращает инстанс билдера объектов запросов списка возвратов магазина
public	clearValidationError()		Очищает статус валидации текущего запроса
public	fromArray()		Устанавливает значения свойств текущего объекта из массива
public	getCreatedAtGt()		Возвращает дату создания от которой будут возвращены возвраты или null, если дата не была установлена
public	getCreatedAtGte()		Возвращает дату создания от которой будут возвращены возвраты или null, если дата не была установлена
public	getCreatedAtLt()		Возвращает дату создания до которой будут возвращены возвраты или null, если дата не была установлена
public	getCreatedAtLte()		Возвращает дату создания до которой будут возвращены возвраты или null, если дата не была установлена
public	getCursor()		Возвращает токен для получения следующей страницы выборки
public	getLastValidationError()		Возвращает последнюю ошибку валидации
public	getLimit()		Ограничение количества объектов платежа
public	getPaymentId()		Возвращает идентификатор платежа если он задан или null
public	getStatus()		Возвращает статус выбираемых возвратов или null, если он до этого не был установлен
public	hasCreatedAtGt()		Проверяет, была ли установлена дата создания от которой выбираются возвраты
public	hasCreatedAtGte()		Проверяет, была ли установлена дата создания от которой выбираются возвраты
public	hasCreatedAtLt()		Проверяет, была ли установлена дата создания до которой выбираются возвраты
public	hasCreatedAtLte()		Проверяет, была ли установлена дата создания до которой выбираются возвраты
public	hasCursor()		Проверяет, был ли установлен токен следующей страницы
public	hasLimit()		Проверяет, было ли установлено ограничение количества объектов платежа
public	hasPaymentId()		Проверяет, был ли задан идентификатор платежа
public	hasStatus()		Проверяет, был ли установлен статус выбираемых возвратов
public	jsonSerialize()
public	offsetExists()
public	offsetGet()
public	offsetSet()
public	offsetUnset()
public	setCreatedAtGt()		Устанавливает дату создания от которой выбираются возвраты
public	setCreatedAtGte()		Устанавливает дату создания от которой выбираются возвраты
public	setCreatedAtLt()		Устанавливает дату создания до которой выбираются возвраты
public	setCreatedAtLte()		Устанавливает дату создания до которой выбираются возвраты
public	setCursor()		Устанавливает токен следующей страницы выборки
public	setLimit()		Устанавливает ограничение количества объектов платежа
public	setPaymentId()		Устанавливает идентификатор платежа или null, если требуется его удалить
public	setStatus()		Устанавливает статус выбираемых возвратов
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
public	validate()		Проверяет валидность текущего объекта запроса
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта
protected	setValidationError()		Устанавливает ошибку валидации

---

Details

• File: lib/Request/Refunds/RefundsRequest.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Common\AbstractRequest
  • \YooKassa\Request\Refunds\RefundsRequest
• Implements:
  • \YooKassa\Request\Refunds\RefundsRequestInterface

---

Constants

MAX_LIMIT_VALUE

Максимальное количество объектов возвратов в выборке

MAX_LIMIT_VALUE = 100

---

Properties

public $createdAtGt : \DateTime

---

Description

Время создания, от (не включая)

Type: \DateTime

Details:

public $createdAtGte : \DateTime

---

Description

Время создания, от (включительно)

Type: \DateTime

Details:

public $createdAtLt : \DateTime

---

Description

Время создания, до (не включая)

Type: \DateTime

Details:

public $createdAtLte : \DateTime

---

Description

Время создания, до (включительно)

Type: \DateTime

Details:

public $cursor : string

---

Description

Токен для получения следующей страницы выборки

Type: string

Details:

public $limit : int|null

---

Description

Ограничение количества объектов возврата, отображаемых на одной странице выдачи

Type: int|null

Details:

public $paymentId : string

---

Description

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

Type: string

Details:

public $status : string

---

Description

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

Type: string

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\RefundsRequestBuilder

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

Summary

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

Details:

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

Returns: \YooKassa\Request\Refunds\RefundsRequestBuilder - Билдер объектов запросов списка возвратов

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 getCreatedAtGt() : \DateTime|null

public getCreatedAtGt() : \DateTime|null

Summary

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

Details:

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

Returns: \DateTime|null - Время создания, от (не включая)

public getCreatedAtGte() : \DateTime|null

public getCreatedAtGte() : \DateTime|null

Summary

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

Details:

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

Returns: \DateTime|null - Время создания, от (включительно)

public getCreatedAtLt() : \DateTime|null

public getCreatedAtLt() : \DateTime|null

Summary

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

Details:

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

Returns: \DateTime|null - Время создания, до (не включая)

public getCreatedAtLte() : \DateTime|null

public getCreatedAtLte() : \DateTime|null

Summary

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

Details:

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

Returns: \DateTime|null - Время создания, до (включительно)

public getCursor() : string|null

public getCursor() : string|null

Summary

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

Details:

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

Returns: string|null - Токен для получения следующей страницы выборки

public getLastValidationError() : string

public getLastValidationError() : string

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

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

public getLimit() : int|null

public getLimit() : int|null

Summary

Ограничение количества объектов платежа

Details:

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

Returns: int|null - Ограничение количества объектов платежа

public getPaymentId() : string|null

public getPaymentId() : string|null

Summary

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

Details:

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

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

public getStatus() : string|null

public getStatus() : string|null

Summary

Возвращает статус выбираемых возвратов или null, если он до этого не был установлен

Details:

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

Returns: string|null - Статус выбираемых возвратов

public hasCreatedAtGt() : bool

public hasCreatedAtGt() : bool

Summary

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

Details:

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

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

public hasCreatedAtGte() : bool

public hasCreatedAtGte() : bool

Summary

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

Details:

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

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

public hasCreatedAtLt() : bool

public hasCreatedAtLt() : bool

Summary

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

Details:

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

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

public hasCreatedAtLte() : bool

public hasCreatedAtLte() : bool

Summary

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

Details:

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

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

public hasCursor() : bool

public hasCursor() : bool

Summary

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

Details:

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

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

public hasLimit() : bool

public hasLimit() : bool

Summary

Проверяет, было ли установлено ограничение количества объектов платежа

Details:

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

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

public hasPaymentId() : bool

public hasPaymentId() : bool

Summary

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

Details:

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

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

public hasStatus() : bool

public hasStatus() : bool

Summary

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

Details:

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

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

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

public setCreatedAtGt(\DateTime|string|int|null $value) : mixed

Summary

Устанавливает дату создания от которой выбираются возвраты

Details:

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

Parameters:

Type	Name	Description
\DateTime OR string OR int OR null	value	Время создания, от (не включая) или null, чтобы удалить значение

Throws:

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

Returns: mixed -

public setCreatedAtGte() : mixed

public setCreatedAtGte(\DateTime|string|int|null $value) : mixed

Summary

Устанавливает дату создания от которой выбираются возвраты

Details:

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

Parameters:

Type	Name	Description
\DateTime OR string OR int OR null	value	Время создания, от (включительно) или null, чтобы удалить значение

Throws:

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

Returns: mixed -

public setCreatedAtLt() : mixed

public setCreatedAtLt(\DateTime|string|int|null $value) : mixed

Summary

Устанавливает дату создания до которой выбираются возвраты

Details:

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

Parameters:

Type	Name	Description
\DateTime OR string OR int OR null	value	Время создания, до (не включая) или null, чтобы удалить значение

Throws:

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

Returns: mixed -

public setCreatedAtLte() : mixed

public setCreatedAtLte(\DateTime|string|int|null $value) : mixed

Summary

Устанавливает дату создания до которой выбираются возвраты

Details:

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

Parameters:

Type	Name	Description
\DateTime OR string OR int OR null	value	Время создания, до (включительно) или null, чтобы удалить значение

Throws:

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

Returns: mixed -

public setCursor() : mixed

public setCursor(string $value) : mixed

Summary

Устанавливает токен следующей страницы выборки

Details:

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

Parameters:

Type	Name	Description
string	value	Токен следующей страницы выборки или null, чтобы удалить значение

Throws:

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

Returns: mixed -

public setLimit() : mixed

public setLimit(int|null $value) : mixed

Summary

Устанавливает ограничение количества объектов платежа

Details:

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

Parameters:

Type	Name	Description
int OR null	value	Ограничение количества объектов платежа или null, чтобы удалить значение

Throws:

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

Returns: mixed -

public setPaymentId() : mixed

public setPaymentId(string|null $value) : mixed

Summary

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

Details:

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

Parameters:

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

Throws:

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

Returns: mixed -

public setStatus() : mixed

public setStatus(string $value) : mixed

Summary

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

Details:

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

Parameters:

Type	Name	Description
string	value	Статус выбираемых платежей или null, чтобы удалить значение

Throws:

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

public validate() : bool

public validate() : bool

Summary

Проверяет валидность текущего объекта запроса

Details:

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

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