geckon01/yookassa-sdk-php
1
0
Fork 0
mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-09-13 11:26:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
yookassa-sdk-php/docs/classes/YooKassa-Request-Payouts-PayoutsRequest.md
T

43 KiB
Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Request\Payouts\PayoutsRequest

Namespace: \YooKassa\Request\Payouts

Summary:

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

Description:

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

Constants

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

Properties

Visibility Name Flag Summary
public $created_at_gt Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601. Пример: ~`created_at.gt=2018-07-18T10:51:18.139Z` (optional)
public $created_at_gte Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601. Пример: ~`created_at.gte=2018-07-18T10:51:18.139Z` (optional)
public $created_at_lte Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601. Пример: ~`created_at.lte=2018-07-18T10:51:18.139Z` (optional)
public $createdAtGt Время создания, от (не включая)
public $createdAtGte Время создания, от (включительно)
public $createdAtLt Время создания, до (не включая)
public $createdAtLte Время создания, до (включительно)
public $cursor Страница выдачи результатов, которую необходимо отобразить
public $limit Ограничение количества объектов выплаты, отображаемых на одной странице выдачи
public $payout_destination_type Фильтр по коду %способа получения выплаты. Пример: ~`payout_destination.type=bank_card` (optional)
public $payoutDestinationType Фильтр по коду %способа получения выплаты. Пример: ~`payout_destination.type=bank_card` (optional)
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 getPayoutDestinationType() Возвращает способ получения выбираемых выплат или null, если он до этого не был установлен.
public getStatus() Возвращает статус выбираемых выплат или null, если он до этого не был установлен.
public getValidator()
public hasCreatedAtGt() Проверяет, была ли установлена дата создания от которой выбираются выплаты.
public hasCreatedAtGte() Проверяет, была ли установлена дата создания от которой выбираются выплаты.
public hasCreatedAtLt() Проверяет, была ли установлена дата создания до которой выбираются выплаты.
public hasCreatedAtLte() Проверяет, была ли установлена дата создания до которой выбираются выплаты.
public hasCursor() Проверяет, была ли установлена страница выдачи результатов, которую необходимо отобразить.
public hasLimit() Проверяет, было ли установлено ограничение количества объектов выплаты.
public hasPayoutDestinationType() Проверяет, был ли установлен способ получения выбираемых выплат.
public hasStatus() Проверяет, был ли установлен статус выбираемых выплат.
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public setCreatedAtGt() Устанавливает дату создания от которой выбираются выплаты.
public setCreatedAtGte() Устанавливает дату создания от которой выбираются выплаты.
public setCreatedAtLt() Устанавливает дату создания до которой выбираются выплаты.
public setCreatedAtLte() Устанавливает дату создания до которой выбираются выплаты.
public setCursor() Устанавливает страницу выдачи результатов, которую необходимо отобразить
public setLimit() Устанавливает ограничение количества объектов выплаты.
public setPayoutDestinationType() Устанавливает способ получения выбираемых выплат.
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 $created_at_gt : null|\DateTime

Description

Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601. Пример: ~`created_at.gt=2018-07-18T10:51:18.139Z` (optional)

Type: DateTime

Details:

public $created_at_gte : null|\DateTime

Description

Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601. Пример: ~`created_at.gte=2018-07-18T10:51:18.139Z` (optional)

Type: DateTime

Details:

public $created_at_lte : null|\DateTime

Description

Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601. Пример: ~`created_at.lte=2018-07-18T10:51:18.139Z` (optional)

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 $payout_destination_type : null|string

Description

Фильтр по коду %способа получения выплаты. Пример: ~`payout_destination.type=bank_card` (optional)

Type: null|string

Details:

public $payoutDestinationType : null|string

Description

Фильтр по коду %способа получения выплаты. Пример: ~`payout_destination.type=bank_card` (optional)

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\Payouts\PayoutsRequestBuilder

Static public builder() : \YooKassa\Request\Payouts\PayoutsRequestBuilder

Summary

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

Details:

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

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 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 getPayoutDestinationType() : null|string

public getPayoutDestinationType() : 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 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 hasPayoutDestinationType() : bool

public hasPayoutDestinationType() : 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 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 setPayoutDestinationType() : self

public setPayoutDestinationType(string|null $payout_destination_type) : self

Summary

Устанавливает способ получения выбираемых выплат.

Details:

Parameters:
Type Name Description
string OR null payout_destination_type Способ получения выбираемых выплат или 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 2026-08-13 using phpDocumentor

© 2026 YooMoney

Reference in New Issue View Git Blame Copy Permalink