meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Request-Payments-PaymentsRequest.md
keboss-m 5c21d25d45 Initial commit: Merakomis portal, Docker stack and user-reader API.
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-06-24 11:04:05 +03:00

55 KiB
Raw Blame History

YooKassa API SDK

Class: \YooKassa\Request\Payments\PaymentsRequest

Namespace: \YooKassa\Request\Payments


Summary:

Класс объекта запроса к API для получения списка платежей магазина


Constants

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

Properties

Visibility Name Flag Summary
public $capturedAtGt Время подтверждения, от (не включая)
public $capturedAtGte Время подтверждения, от (включительно)
public $capturedAtLt Время подтверждения, до (не включая)
public $capturedAtLte Время подтверждения, до (включительно)
public $createdAtGt Время создания, от (не включая)
public $createdAtGte Время создания, от (включительно)
public $createdAtLt Время создания, до (не включая)
public $createdAtLte Время создания, до (включительно)
public $cursor Страница выдачи результатов, которую необходимо отобразить
public $limit Ограничение количества объектов платежа, отображаемых на одной странице выдачи
public $paymentMethod Платежный метод
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 getCapturedAtGt() Возвращает дату подтверждения от которой будут возвращены платежи или null, если дата не была установлена
public getCapturedAtGte() Возвращает дату подтверждения от которой будут возвращены платежи или null, если дата не была установлена
public getCapturedAtLt() Возвращает дату подтверждения до которой будут возвращены платежи или null, если дата не была установлена
public getCapturedAtLte() Возвращает дату подтверждения до которой будут возвращены платежи или null, если дата не была установлена
public getCreatedAtGt() Возвращает дату создания от которой будут возвращены платежи или null, если дата не была установлена
public getCreatedAtGte() Возвращает дату создания от которой будут возвращены платежи или null, если дата не была установлена
public getCreatedAtLt() Возвращает дату создания до которой будут возвращены платежи или null, если дата не была установлена
public getCreatedAtLte() Возвращает дату создания до которой будут возвращены платежи или null, если дата не была установлена
public getCursor() Страница выдачи результатов, которую необходимо отобразить
public getLastValidationError() Возвращает последнюю ошибку валидации
public getLimit() Ограничение количества объектов платежа
public getPaymentMethod() Возвращает платежный метод выбираемых платежей или null, если он до этого не был установлен
public getStatus() Возвращает статус выбираемых платежей или null, если он до этого не был установлен
public hasCapturedAtGt() Проверяет, была ли установлена дата подтверждения от которой выбираются платежи
public hasCapturedAtGte() Проверяет, была ли установлена дата подтверждения от которой выбираются платежи
public hasCapturedAtLt() Проверяет, была ли установлена дата подтверждения до которой выбираются платежи
public hasCapturedAtLte() Проверяет, была ли установлена дата подтверждения до которой выбираются платежи
public hasCreatedAtGt() Проверяет, была ли установлена дата создания от которой выбираются платежи
public hasCreatedAtGte() Проверяет, была ли установлена дата создания от которой выбираются платежи
public hasCreatedAtLt() Проверяет, была ли установлена дата создания до которой выбираются платежи
public hasCreatedAtLte() Проверяет, была ли установлена дата создания до которой выбираются платежи
public hasCursor() Проверяет, была ли установлена страница выдачи результатов, которую необходимо отобразить
public hasLimit() Проверяет, было ли установлено ограничение количества объектов платежа
public hasPaymentMethod() Проверяет, был ли установлен платежный метод выбираемых платежей
public hasStatus() Проверяет, был ли установлен статус выбираемых платежей
public jsonSerialize()
public offsetExists()
public offsetGet()
public offsetSet()
public offsetUnset()
public setCapturedAtGt() Устанавливает дату подтверждения от которой выбираются платежи
public setCapturedAtGte() Устанавливает дату подтверждения от которой выбираются платежи
public setCapturedAtLt() Устанавливает дату подтверждения до которой выбираются платежи
public setCapturedAtLte() Устанавливает дату подтверждения до которой выбираются платежи
public setCreatedAtGt() Устанавливает дату создания от которой выбираются платежи
public setCreatedAtGte() Устанавливает дату создания от которой выбираются платежи
public setCreatedAtLt() Устанавливает дату создания до которой выбираются платежи
public setCreatedAtLte() Устанавливает дату создания до которой выбираются платежи
public setCursor() Устанавливает страницу выдачи результатов, которую необходимо отобразить
public setLimit() Устанавливает ограничение количества объектов платежа
public setPaymentMethod() Устанавливает платежный метод выбираемых платежей
public setStatus() Устанавливает статус выбираемых платежей
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
public validate() Проверяет валидность текущего объекта запроса
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта
protected setValidationError() Устанавливает ошибку валидации

Details


Constants

MAX_LIMIT_VALUE

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

MAX_LIMIT_VALUE = 100

Properties

public $capturedAtGt : \DateTime|null


Description

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

Type: DateTime|null

Details:

public $capturedAtGte : \DateTime|null


Description

Время подтверждения, от (включительно)

Type: DateTime|null

Details:

public $capturedAtLt : \DateTime|null


Description

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

Type: DateTime|null

Details:

public $capturedAtLte : \DateTime|null


Description

Время подтверждения, до (включительно)

Type: DateTime|null

Details:

public $createdAtGt : \DateTime|null


Description

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

Type: DateTime|null

Details:

public $createdAtGte : \DateTime|null


Description

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

Type: DateTime|null

Details:

public $createdAtLt : \DateTime|null


Description

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

Type: DateTime|null

Details:

public $createdAtLte : \DateTime|null


Description

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

Type: DateTime|null

Details:

public $cursor : string|null


Description

Страница выдачи результатов, которую необходимо отобразить

Type: string|null

Details:

public $limit : int|null


Description

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

Type: int|null

Details:

public $paymentMethod : string|null


Description

Платежный метод

Type: string|null

Details:

public $status : string|null


Description

Статус платежа

Type: string|null

Details:


Methods

public __construct() : mixed

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

Summary

AbstractObject constructor.

Details:

Parameters:
Type Name Description
array data

Returns: mixed -

public __get() : mixed

public __get(string $propertyName) : mixed

Summary

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

Details:

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

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

public __isset() : bool

public __isset(string $propertyName) : bool

Summary

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

Details:

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

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

public __set() : mixed

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

Summary

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

Details:

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

Returns: mixed -

public __unset() : mixed

public __unset(string $propertyName) : mixed

Summary

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

Details:

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

Returns: mixed -

public builder() : \YooKassa\Request\Payments\PaymentsRequestBuilder

Static public builder() : \YooKassa\Request\Payments\PaymentsRequestBuilder

Summary

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

Details:

Returns: \YooKassa\Request\Payments\PaymentsRequestBuilder - Билдер объектов запросов списка платежей

public clearValidationError() : mixed

public clearValidationError() : mixed

Summary

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

Details:

Returns: mixed -

public fromArray() : mixed

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

Summary

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

Details:

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

Returns: mixed -

public getCapturedAtGt() : \DateTime|null

public getCapturedAtGt() : \DateTime|null

Summary

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

Details:

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

public getCapturedAtGte() : \DateTime|null

public getCapturedAtGte() : \DateTime|null

Summary

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

Details:

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

public getCapturedAtLt() : \DateTime|null

public getCapturedAtLt() : \DateTime|null

Summary

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

Details:

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

public getCapturedAtLte() : \DateTime|null

public getCapturedAtLte() : \DateTime|null

Summary

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

Details:

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

public getCreatedAtGt() : \DateTime|null

public getCreatedAtGt() : \DateTime|null

Summary

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

Details:

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

public getCreatedAtGte() : \DateTime|null

public getCreatedAtGte() : \DateTime|null

Summary

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

Details:

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

public getCreatedAtLt() : \DateTime|null

public getCreatedAtLt() : \DateTime|null

Summary

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

Details:

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

public getCreatedAtLte() : \DateTime|null

public getCreatedAtLte() : \DateTime|null

Summary

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

Details:

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

public getCursor() : string|null

public getCursor() : string|null

Summary

Страница выдачи результатов, которую необходимо отобразить

Details:

Returns: string|null -

public getLastValidationError() : string

public getLastValidationError() : string

Summary

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

Details:

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

public getLimit() : int|null

public getLimit() : int|null

Summary

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

Details:

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

public getPaymentMethod() : string|null

public getPaymentMethod() : string|null

Summary

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

Details:

Returns: string|null - Платежный метод выбираемых платежей

public getStatus() : string|null

public getStatus() : string|null

Summary

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

Details:

Returns: string|null - Статус выбираемых платежей

public hasCapturedAtGt() : bool

public hasCapturedAtGt() : bool

Summary

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

Details:

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

public hasCapturedAtGte() : bool

public hasCapturedAtGte() : bool

Summary

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

Details:

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

public hasCapturedAtLt() : bool

public hasCapturedAtLt() : bool

Summary

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

Details:

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

public hasCapturedAtLte() : bool

public hasCapturedAtLte() : bool

Summary

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

Details:

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

public hasCreatedAtGt() : bool

public hasCreatedAtGt() : bool

Summary

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

Details:

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

public hasCreatedAtGte() : bool

public hasCreatedAtGte() : bool

Summary

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

Details:

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

public hasCreatedAtLt() : bool

public hasCreatedAtLt() : bool

Summary

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

Details:

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

public hasCreatedAtLte() : bool

public hasCreatedAtLte() : bool

Summary

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

Details:

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

public hasCursor() : bool

public hasCursor() : bool

Summary

Проверяет, была ли установлена страница выдачи результатов, которую необходимо отобразить

Details:

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

public hasLimit() : bool

public hasLimit() : bool

Summary

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

Details:

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

public hasPaymentMethod() : bool

public hasPaymentMethod() : bool

Summary

Проверяет, был ли установлен платежный метод выбираемых платежей

Details:

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

public hasStatus() : bool

public hasStatus() : bool

Summary

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

Details:

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

public jsonSerialize() : mixed

public jsonSerialize() : mixed

Details:

Returns: mixed -

public offsetExists() : mixed

public offsetExists(mixed $offset) : mixed

Details:

Parameters:
Type Name Description
mixed offset

Returns: mixed -

public offsetGet() : mixed

public offsetGet(mixed $offset) : mixed

Details:

Parameters:
Type Name Description
mixed offset

Returns: mixed -

public offsetSet() : mixed

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

Details:

Parameters:
Type Name Description
mixed offset
mixed value

Returns: mixed -

public offsetUnset() : mixed

public offsetUnset(mixed $offset) : mixed

Details:

Parameters:
Type Name Description
mixed offset

Returns: mixed -

public setCapturedAtGt() : void

public setCapturedAtGt(\DateTime|string|int|null $value) : void

Summary

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

Details:

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: void -

public setCapturedAtGte() : void

public setCapturedAtGte(\DateTime|string|int|null $value) : void

Summary

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

Details:

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: void -

public setCapturedAtLt() : void

public setCapturedAtLt(\DateTime|string|int|null $value) : void

Summary

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

Details:

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: void -

public setCapturedAtLte() : void

public setCapturedAtLte(\DateTime|string|int|null $value) : void

Summary

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

Details:

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: void -

public setCreatedAtGt() : void

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

Summary

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

Details:

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: void -

public setCreatedAtGte() : void

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

Summary

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

Details:

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: void -

public setCreatedAtLt() : void

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

Summary

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

Details:

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: void -

public setCreatedAtLte() : void

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

Summary

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

Details:

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: void -

public setCursor() : void

public setCursor(string $value) : void

Summary

Устанавливает страницу выдачи результатов, которую необходимо отобразить

Details:

Parameters:
Type Name Description
string value Страница выдачи результатов или null, чтобы удалить значение
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если в метод была передана не строка

Returns: void -

public setLimit() : void

public setLimit(int|null $value) : void

Summary

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

Details:

Parameters:
Type Name Description
int OR null value Ограничение количества объектов платежа или null, чтобы удалить значение
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается, если в метод было передано не целое число

Returns: void -

public setPaymentMethod() : void

public setPaymentMethod(string $value) : void

Summary

Устанавливает платежный метод выбираемых платежей

Details:

Parameters:
Type Name Description
string value Платежный метод выбираемых платежей или null, чтобы удалить значение
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException Выбрасывается если переданное значение не является валидным статусом
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если в метод была передана не строка

Returns: void -

public setStatus() : void

public setStatus(string $value) : void

Summary

Устанавливает статус выбираемых платежей

Details:

Parameters:
Type Name Description
string value Статус выбираемых платежей или null, чтобы удалить значение
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException Выбрасывается если переданное значение не является валидным статусом
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если в метод была передана не строка

Returns: void -

public toArray() : array

public toArray() : array

Summary

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

Details:

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

public validate() : bool

public validate() : bool

Summary

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

Details:

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

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

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

protected setValidationError() : mixed

protected setValidationError(string $value) : mixed

Summary

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

Details:

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

Returns: mixed -


Top Namespaces


Reports


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

© 2023 YooMoney