Files
yookassa-sdk-php/docs/classes/YooKassa-Request-Payments-PaymentsRequest.md
2025-07-01 14:52:30 +03:00

51 KiB

YooKassa API SDK

Class: \YooKassa\Request\Payments\PaymentsRequest

Namespace: \YooKassa\Request\Payments


Summary:

Класс, представляющий модель PaymentsRequest.

Description:

Класс объекта запроса к 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 getValidator()
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() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
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() Устанавливает ошибку валидации.
protected validatePropertyValue()

Details


Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Constants

MAX_LIMIT_VALUE

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

MAX_LIMIT_VALUE = 100

Properties

public $capturedAtGt : null|\DateTime


Description

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

Type: DateTime

Details:

public $capturedAtGte : null|\DateTime


Description

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

Type: DateTime

Details:

public $capturedAtLt : null|\DateTime


Description

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

Type: DateTime

Details:

public $capturedAtLte : null|\DateTime


Description

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

Type: DateTime

Details:

public $createdAtGt : null|\DateTime


Description

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

Type: DateTime

Details:

public $createdAtGte : null|\DateTime


Description

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

Type: DateTime

Details:

public $createdAtLt : null|\DateTime


Description

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

Type: DateTime

Details:

public $createdAtLte : null|\DateTime


Description

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

Type: DateTime

Details:

public $cursor : null|string


Description

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

Type: null|string

Details:

public $limit : null|int


Description

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

Type: null|int

Details:

public $paymentMethod : null|string


Description

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

Type: null|string

Details:

public $status : null|string


Description

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

Type: null|string

Details:


Methods

public __construct() : mixed

public __construct(array|null $data = []) : mixed

Summary

AbstractObject constructor.

Details:

Parameters:
Type Name Description
array OR null 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() : void

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

Summary

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

Details:

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

Returns: void -

public __unset() : void

public __unset(string $propertyName) : void

Summary

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

Details:

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

Returns: void -

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

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

Summary

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

Details:

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

public clearValidationError() : void

public clearValidationError() : void

Summary

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

Details:

Returns: void -

public fromArray() : void

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

Summary

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

Details:

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

Returns: void -

public getCapturedAtGt() : null|\DateTime

public getCapturedAtGt() : null|\DateTime

Summary

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

Details:

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

public getCapturedAtGte() : null|\DateTime

public getCapturedAtGte() : null|\DateTime

Summary

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

Details:

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

public getCapturedAtLt() : null|\DateTime

public getCapturedAtLt() : null|\DateTime

Summary

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

Details:

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

public getCapturedAtLte() : null|\DateTime

public getCapturedAtLte() : null|\DateTime

Summary

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

Details:

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

public getCreatedAtGt() : null|\DateTime

public getCreatedAtGt() : null|\DateTime

Summary

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

Details:

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

public getCreatedAtGte() : null|\DateTime

public getCreatedAtGte() : null|\DateTime

Summary

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

Details:

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

public getCreatedAtLt() : null|\DateTime

public getCreatedAtLt() : null|\DateTime

Summary

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

Details:

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

public getCreatedAtLte() : null|\DateTime

public getCreatedAtLte() : null|\DateTime

Summary

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

Details:

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

public getCursor() : null|string

public getCursor() : null|string

Summary

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

Details:

Returns: null|string - Страница выдачи результатов

public getLastValidationError() : string|null

public getLastValidationError() : string|null

Summary

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

Details:

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

public getLimit() : null|int

public getLimit() : null|int

Summary

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

Details:

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

public getPaymentMethod() : null|string

public getPaymentMethod() : null|string

Summary

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

Details:

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

public getStatus() : null|string

public getStatus() : null|string

Summary

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

Details:

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

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

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() : array

public jsonSerialize() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.

Details:

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

public offsetExists() : bool

public offsetExists(string $offset) : bool

Summary

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

Details:

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

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

public offsetGet() : mixed

public offsetGet(string $offset) : mixed

Summary

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

Details:

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

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

public offsetSet() : void

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

Summary

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

Details:

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

Returns: void -

public offsetUnset() : void

public offsetUnset(string $offset) : void

Summary

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

Details:

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

Returns: void -

public setCapturedAtGt() : self

public setCapturedAtGt(null|\DateTime|int|string $captured_at_gt) : self

Summary

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

Details:

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

Returns: self -

public setCapturedAtGte() : self

public setCapturedAtGte(null|\DateTime|int|string $captured_at_gte) : self

Summary

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

Details:

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

Returns: self -

public setCapturedAtLt() : self

public setCapturedAtLt(null|\DateTime|int|string $captured_at_lt) : self

Summary

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

Details:

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

Returns: self -

public setCapturedAtLte() : self

public setCapturedAtLte(null|\DateTime|int|string $captured_at_lte) : self

Summary

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

Details:

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

Returns: self -

public setCreatedAtGt() : self

public setCreatedAtGt(null|\DateTime|int|string $created_at_gt) : self

Summary

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

Details:

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

Returns: self -

public setCreatedAtGte() : self

public setCreatedAtGte(\DateTime|string|null $_created_at_gte = null) : self

Summary

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

Details:

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

Returns: self -

public setCreatedAtLt() : self

public setCreatedAtLt(null|\DateTime|int|string $created_at_lt) : self

Summary

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

Details:

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

Returns: self -

public setCreatedAtLte() : self

public setCreatedAtLte(null|\DateTime|int|string $created_at_lte) : self

Summary

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

Details:

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

Returns: self -

public setCursor() : self

public setCursor(string|null $cursor) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null cursor Страница выдачи результатов или null, чтобы удалить значение

Returns: self -

public setLimit() : self

public setLimit(null|int|string $limit) : self

Summary

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

Details:

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

Returns: self -

public setPaymentMethod() : self

public setPaymentMethod(string|null $payment_method) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null payment_method Платежный метод выбираемых платежей или null, чтобы удалить значение

Returns: self -

public setStatus() : self

public setStatus(string|null $status) : self

Summary

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

Details:

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

Returns: self -

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

protected setValidationError(string $value) : void

Summary

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

Details:

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

Returns: void -

protected validatePropertyValue() : mixed

protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed

Details:

Parameters:
Type Name Description
string propertyName
mixed propertyValue

Returns: mixed -


Top Namespaces


Reports


This document was automatically generated from source code comments on 2025-07-01 using phpDocumentor

© 2025 YooMoney