Александра Д. Спиридонова
18 KiB
YooKassa API SDK
Class: \YooKassa\Request\Refunds\RefundsRequestBuilder
Namespace: \YooKassa\Request\Refunds
Summary:
Класс, представляющий модель RefundsRequestBuilder.
Description:
Класс билдера объектов запросов к API списка возвратов.
Constants
- No constants found
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| protected | $currentObject | Инстанс собираемого запроса. |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать. | |
| public | build() | Собирает и возвращает объект запроса списка возвратов магазина. | |
| public | setCreatedAtGt() | Устанавливает дату создания от которой выбираются возвраты. | |
| public | setCreatedAtGte() | Устанавливает дату создания от которой выбираются возвраты. | |
| public | setCreatedAtLt() | Устанавливает дату создания до которой выбираются возвраты. | |
| public | setCreatedAtLte() | Устанавливает дату создания до которой выбираются возвраты. | |
| public | setCursor() | Устанавливает токен следующей страницы выборки. | |
| public | setLimit() | Устанавливает ограничение количества объектов возвратов. | |
| public | setOptions() | Устанавливает свойства запроса из массива. | |
| public | setPaymentId() | Устанавливает идентификатор платежа или null, если требуется его удалить. | |
| public | setStatus() | Устанавливает статус выбираемых возвратов. | |
| protected | initCurrentObject() | Инициализирует новый инстанс собираемого объекта. |
Details
-
Package: YooKassa\Request
-
Class Hierarchy:
- \YooKassa\Common\AbstractRequestBuilder
- \YooKassa\Request\Refunds\RefundsRequestBuilder
-
See Also:
Tags
| Tag | Version | Description |
|---|---|---|
| category | Class | |
| author | cms@yoomoney.ru |
Properties
protected $currentObject : ?\YooKassa\Common\AbstractRequestInterface
Summary
Инстанс собираемого запроса.
Type: AbstractRequestInterface Инстанс собираемого объекта запроса Details:
Methods
public __construct() : mixed
public __construct() : mixed
Summary
Конструктор, инициализирует пустой запрос, который в будущем начнём собирать.
Details:
- Inherited From: \YooKassa\Common\AbstractRequestBuilder
Returns: mixed -
public build() : \YooKassa\Request\Refunds\RefundsRequest
public build(null|array $options = null) : \YooKassa\Request\Refunds\RefundsRequest
Summary
Собирает и возвращает объект запроса списка возвратов магазина.
Details:
- Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
null OR array |
options | Массив с настройками запроса |
Returns: \YooKassa\Request\Refunds\RefundsRequest - Инстанс объекта запроса к API для получения списка возвратов магазина
public setCreatedAtGt() : \YooKassa\Request\Refunds\RefundsRequestBuilder
public setCreatedAtGt(null|\DateTime|int|string $value) : \YooKassa\Request\Refunds\RefundsRequestBuilder
Summary
Устанавливает дату создания от которой выбираются возвраты.
Details:
- Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
null OR \DateTime OR int OR string |
value | Время создания, от (не включая) или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) |
| \Exception | \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException |
Returns: \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера
public setCreatedAtGte() : \YooKassa\Request\Refunds\RefundsRequestBuilder
public setCreatedAtGte(null|\DateTime|int|string $value) : \YooKassa\Request\Refunds\RefundsRequestBuilder
Summary
Устанавливает дату создания от которой выбираются возвраты.
Details:
- Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
null OR \DateTime OR int OR string |
value | Время создания, от (включительно) или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) |
| \Exception | \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException |
Returns: \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера
public setCreatedAtLt() : \YooKassa\Request\Refunds\RefundsRequestBuilder
public setCreatedAtLt(null|\DateTime|int|string $value) : \YooKassa\Request\Refunds\RefundsRequestBuilder
Summary
Устанавливает дату создания до которой выбираются возвраты.
Details:
- Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
null OR \DateTime OR int OR string |
value | Время создания, до (не включая) или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) |
| \Exception | \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException |
Returns: \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера
public setCreatedAtLte() : \YooKassa\Request\Refunds\RefundsRequestBuilder
public setCreatedAtLte(null|\DateTime|int|string $value) : \YooKassa\Request\Refunds\RefundsRequestBuilder
Summary
Устанавливает дату создания до которой выбираются возвраты.
Details:
- Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
null OR \DateTime OR int OR string |
value | Время создания, до (включительно) или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) |
| \Exception | \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException |
Returns: \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера
public setCursor() : \YooKassa\Request\Refunds\RefundsRequestBuilder
public setCursor(string|null $value) : \YooKassa\Request\Refunds\RefundsRequestBuilder
Summary
Устанавливает токен следующей страницы выборки.
Details:
- Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
value | Токен следующей страницы выборки или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка |
Returns: \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера
public setLimit() : \YooKassa\Request\Refunds\RefundsRequestBuilder
public setLimit(null|int $value) : \YooKassa\Request\Refunds\RefundsRequestBuilder
Summary
Устанавливает ограничение количества объектов возвратов.
Details:
- Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
null OR int |
value | Ограничение количества объектов возвратов или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод было передана не целое число |
Returns: \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего билдера
public setOptions() : \YooKassa\Common\AbstractRequestBuilder
public setOptions(iterable|null $options) : \YooKassa\Common\AbstractRequestBuilder
Summary
Устанавливает свойства запроса из массива.
Details:
- Inherited From: \YooKassa\Common\AbstractRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
iterable OR null |
options | Массив свойств запроса |
Throws:
| Type | Description |
|---|---|
| \InvalidArgumentException | Выбрасывается если аргумент не массив и не итерируемый объект |
| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданных в массиве настроек |
Returns: \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов
public setPaymentId() : \YooKassa\Request\Refunds\RefundsRequestBuilder
public setPaymentId(null|string $value) : \YooKassa\Request\Refunds\RefundsRequestBuilder
Summary
Устанавливает идентификатор платежа или null, если требуется его удалить.
Details:
- Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
null OR string |
value | Идентификатор платежа |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если длина переданной строки не равна 36 символам |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка |
Returns: \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера
public setStatus() : \YooKassa\Request\Refunds\RefundsRequestBuilder
public setStatus(string $value) : \YooKassa\Request\Refunds\RefundsRequestBuilder
Summary
Устанавливает статус выбираемых возвратов.
Details:
- Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Статус выбираемых платежей или null, чтобы удалить значение |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не является валидным статусом |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка |
Returns: \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера
protected initCurrentObject() : \YooKassa\Request\Refunds\RefundsRequestInterface
protected initCurrentObject() : \YooKassa\Request\Refunds\RefundsRequestInterface
Summary
Инициализирует новый инстанс собираемого объекта.
Details:
- Inherited From: \YooKassa\Request\Refunds\RefundsRequestBuilder
Returns: \YooKassa\Request\Refunds\RefundsRequestInterface - Инстанс собираемого запроса
Top Namespaces
Reports
This document was automatically generated from source code comments on 2026-08-13 using phpDocumentor
© 2026 YooMoney