Files
yookassa-sdk-php/docs/classes/YooKassa-Request-Payouts-PayoutsRequestInterface.md
Евгений Ю. Лозный 260d13f890 Добавлен прием платежей через Alfa Pay. Добавлен новый тип ошибки RuleViolationError
Добавлены нулевые привязки по СБП
Добавлена причина отмены возвратов `payment_expired`
2026-06-29 17:46:40 +03:00

23 KiB

YooKassa API SDK

Interface: PayoutsRequestInterface

Namespace: \YooKassa\Request\Payouts


Summary:

Interface PaymentsRequestInterface.


Constants

  • No constants found

Methods

Visibility Name Flag Summary
public getCreatedAtGt() Возвращает дату создания от которой будут возвращены выплаты или null, если дата не была установлена.
public getCreatedAtGte() Возвращает дату создания от которой будут возвращены выплаты или null, если дата не была установлена.
public getCreatedAtLt() Возвращает дату создания до которой будут возвращены выплаты или null, если дата не была установлена.
public getCreatedAtLte() Возвращает дату создания до которой будут возвращены выплаты или null, если дата не была установлена.
public getCursor() Возвращает страницу выдачи результатов или null, если она до этого не была установлена.
public getLimit() Возвращает ограничение количества объектов выплаты или null, если оно до этого не было установлено.
public getPayoutDestinationType() Возвращает код способа получения выбираемых выплат или null, если он до этого не был установлен.
public getStatus() Возвращает статус выбираемых выплат или null, если он до этого не был установлен.
public hasCreatedAtGt() Проверяет, была ли установлена дата создания от которой выбираются выплаты.
public hasCreatedAtGte() Проверяет, была ли установлена дата создания от которой выбираются выплаты.
public hasCreatedAtLt() Проверяет, была ли установлена дата создания до которой выбираются выплаты.
public hasCreatedAtLte() Проверяет, была ли установлена дата создания до которой выбираются выплаты.
public hasCursor() Проверяет, была ли установлена страница выдачи результатов.
public hasLimit() Проверяет, было ли установлено ограничение количества объектов выплаты.
public hasPayoutDestinationType() Проверяет, был ли установлен код способа получения выбираемых выплат.
public hasStatus() Проверяет, был ли установлен статус выбираемых выплат.
public setCreatedAtGt() Устанавливает дату создания от которой выбираются выплаты.
public setCreatedAtGte() Устанавливает дату создания от которой выбираются выплаты.
public setCreatedAtLt() Устанавливает дату создания до которой выбираются выплаты.
public setCreatedAtLte() Устанавливает дату создания до которой выбираются выплаты.
public setCursor() Устанавливает страницу выдачи результатов.
public setLimit() Устанавливает ограничение количества объектов выплаты.
public setPayoutDestinationType() Устанавливает код способа получения выбираемых выплат.
public setStatus() Устанавливает статус выбираемых выплат.

Details


Tags

Tag Version Description
category Class
author cms@yoomoney.ru
property Время создания, от (включительно)
property Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601. Пример: ~`created_at.gte=2018-07-18T10:51:18.139Z` (optional)
property Время создания, от (не включая)
property Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601. Пример: ~`created_at.gt=2018-07-18T10:51:18.139Z` (optional)
property Время создания, до (включительно)
property Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601. Пример: ~`created_at.lte=2018-07-18T10:51:18.139Z` (optional)
property Время создания, до (не включая)
property Фильтр по коду %способа получения выплаты. Пример: ~`payout_destination.type=bank_card` (optional)
property Фильтр по коду %способа получения выплаты. Пример: ~`payout_destination.type=bank_card` (optional)
property Статус выплаты
property Ограничение количества объектов выплаты, отображаемых на одной странице выдачи
property Страница выдачи результатов, которую необходимо отобразить

Methods

public getCursor() : null|string

public getCursor() : null|string

Summary

Возвращает страницу выдачи результатов или null, если она до этого не была установлена.

Details:

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

public hasCursor() : bool

public hasCursor() : bool

Summary

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

Details:

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

public setCursor() : self

public setCursor(string $cursor) : self

Summary

Устанавливает страницу выдачи результатов.

Details:

Parameters:
Type Name Description
string cursor Страница

Returns: self -

public getLimit() : null|int

public getLimit() : null|int

Summary

Возвращает ограничение количества объектов выплаты или null, если оно до этого не было установлено.

Details:

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

public hasLimit() : bool

public hasLimit() : bool

Summary

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

Details:

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

public setLimit() : self

public setLimit(int $limit) : self

Summary

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

Details:

Parameters:
Type Name Description
int limit Количества объектов выплаты на странице

Returns: self -

public getCreatedAtGte() : null|\DateTime

public getCreatedAtGte() : null|\DateTime

Summary

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

Details:

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

public hasCreatedAtGte() : bool

public hasCreatedAtGte() : bool

Summary

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

Details:

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

public setCreatedAtGte() : self

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

Summary

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

Details:

Parameters:
Type Name Description
\DateTime OR string OR null _created_at_gte Дата

Returns: self -

public getCreatedAtGt() : null|\DateTime

public getCreatedAtGt() : null|\DateTime

Summary

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

Details:

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

public hasCreatedAtGt() : bool

public hasCreatedAtGt() : bool

Summary

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

Details:

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

public setCreatedAtGt() : self

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

Summary

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

Details:

Parameters:
Type Name Description
\DateTime OR string OR null created_at_gt Дата создания

Returns: self -

public getCreatedAtLte() : null|\DateTime

public getCreatedAtLte() : null|\DateTime

Summary

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

Details:

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

public hasCreatedAtLte() : bool

public hasCreatedAtLte() : bool

Summary

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

Details:

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

public setCreatedAtLte() : self

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

Summary

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

Details:

Parameters:
Type Name Description
\DateTime OR string OR null created_at_lte Дата

Returns: self -

public getCreatedAtLt() : null|\DateTime

public getCreatedAtLt() : null|\DateTime

Summary

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

Details:

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

public hasCreatedAtLt() : bool

public hasCreatedAtLt() : bool

Summary

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

Details:

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

public setCreatedAtLt() : self

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

Summary

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

Details:

Parameters:
Type Name Description
\DateTime OR string OR null created_at_lt Дата

Returns: self -

public getStatus() : null|string

public getStatus() : null|string

Summary

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

Details:

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

public hasStatus() : bool

public hasStatus() : bool

Summary

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

Details:

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

public setStatus() : self

public setStatus(string $status) : self

Summary

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

Details:

Parameters:
Type Name Description
string status Статус выплат

Returns: self -

public getPayoutDestinationType() : null|string

public getPayoutDestinationType() : null|string

Summary

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

Details:

Returns: null|string - Код способа получения выбираемых выплат

public hasPayoutDestinationType() : bool

public hasPayoutDestinationType() : bool

Summary

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

Details:

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

public setPayoutDestinationType() : self

public setPayoutDestinationType(string $payout_destination_type) : self

Summary

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

Details:

Parameters:
Type Name Description
string payout_destination_type Код способа получения выплаты

Returns: self -


Top Namespaces


Reports


This document was automatically generated from source code comments on 2026-06-29 using phpDocumentor

© 2026 YooMoney