keboss/meraproject
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
main
meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequest.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

51 KiB
Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Request\Payouts\CreatePayoutRequest

Namespace: \YooKassa\Request\Payouts

Summary:

Класс объекта запроса к API на проведение новой выплаты

Constants

  • No constants found

Properties

Visibility Name Flag Summary
public $amount Сумма создаваемой выплаты
public $deal Сделка, в рамках которой нужно провести выплату. Необходимо передавать, если вы проводите Безопасную сделку
public $description Описание транзакции (не более 128 символов). Например: «Выплата по договору N»
public $metadata Метаданные привязанные к выплате
public $payment_method_id Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты
public $paymentMethodId Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты
public $payout_destination_data Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token.
public $payout_token Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data
public $payoutDestinationData Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token.
public $payoutToken Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data
public $personal_data Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с проверкой получателя (только для выплат через СБП).
public $personalData Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с проверкой получателя (только для выплат через СБП).
public $receipt_data Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату самозанятому. Только для обычных выплат.
public $receiptData Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату самозанятому. Только для обычных выплат.
public $self_employed Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату самозанятому. Только для обычных выплат.
public $selfEmployed Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату самозанятому. Только для обычных выплат.

Methods

Visibility Name Flag Summary
public __construct() AbstractObject constructor.
public __get() Возвращает значение свойства
public __isset() Проверяет наличие свойства
public __set() Устанавливает значение свойства
public __unset() Удаляет свойство
public builder() Возвращает билдер объектов запросов создания выплаты
public clearValidationError() Очищает статус валидации текущего запроса
public fromArray() Устанавливает значения свойств текущего объекта из массива
public getAmount() Возвращает сумму выплаты
public getDeal() Возвращает сделку, в рамках которой нужно провести выплату
public getDescription() Возвращает описание транзакции
public getLastValidationError() Возвращает последнюю ошибку валидации
public getMetadata() Возвращает данные оплаты установленные мерчантом
public getPaymentMethodId() Возвращает идентификатор сохраненного способа оплаты.
public getPayoutDestinationData() Возвращает данные для создания метода оплаты
public getPayoutToken() Возвращает токенизированные данные для выплаты
public getPersonalData() Возвращает персональные данные получателя выплаты.
public getReceiptData() Возвращает данные для формирования чека в сервисе Мой налог.
public getSelfEmployed() Возвращает данные самозанятого, который получит выплату.
public hasAmount() Проверяет, была ли установлена сумма выплаты
public hasDeal() Проверяет наличие сделки в создаваемой выплате
public hasDescription() Проверяет наличие описания транзакции в создаваемом платеже
public hasMetadata() Проверяет, были ли установлены метаданные выплаты
public hasPaymentMethodId() Проверяет наличие идентификатора сохраненного способа оплаты
public hasPayoutDestinationData() Проверяет установлен ли объект с методом оплаты
public hasPayoutToken() Проверяет наличие токенизированных данных для выплаты
public hasPersonalData() Проверяет наличие персональных данных в создаваемой выплате
public hasReceiptData() Проверяет наличие данных для формирования чека в сервисе Мой налог.
public hasSelfEmployed() Проверяет наличие данных самозанятого в создаваемой выплате
public jsonSerialize()
public offsetExists()
public offsetGet()
public offsetSet()
public offsetUnset()
public setAmount() Устанавливает сумму выплаты
public setDeal() Устанавливает сделку, в рамках которой нужно провести выплату
public setDescription() Устанавливает описание транзакции
public setMetadata() Устанавливает метаданные, привязанные к выплате
public setPaymentMethodId() Устанавливает идентификатор сохраненного способа оплаты.
public setPayoutDestinationData() Устанавливает объект с информацией для создания метода оплаты
public setPayoutToken() Устанавливает токенизированные данные для выплаты
public setPersonalData() Устанавливает персональные данные получателя выплаты.
public setReceiptData() Устанавливает данные для формирования чека в сервисе Мой налог.
public setSelfEmployed() Устанавливает данные самозанятого, который получит выплату.
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
public validate() Проверяет на валидность текущий объект
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта
protected setValidationError() Устанавливает ошибку валидации

Details

Tags

Tag Version Description
todo: @example 02-builder.php 11 78 Пример использования билдера

Properties

public $amount : \YooKassa\Model\AmountInterface

Description

Сумма создаваемой выплаты

Type: AmountInterface

Details:

public $deal : \YooKassa\Model\Deal\PayoutDealInfo

Description

Сделка, в рамках которой нужно провести выплату. Необходимо передавать, если вы проводите Безопасную сделку

Type: PayoutDealInfo

Details:

public $description : string

Description

Описание транзакции (не более 128 символов). Например: «Выплата по договору N»

Type: string

Details:

public $metadata : \YooKassa\Model\Metadata

Description

Метаданные привязанные к выплате

Type: Metadata

Details:

public $payment_method_id : string

Description

Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты

Type: string

Details:

public $paymentMethodId : string

Description

Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты

Type: string

Details:

public $payout_destination_data : \YooKassa\Model\Payout\AbstractPayoutDestination

Description

Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token.

Type: AbstractPayoutDestination

Details:

public $payout_token : string

Description

Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data

Type: string

Details:

public $payoutDestinationData : \YooKassa\Model\Payout\AbstractPayoutDestination

Description

Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token.

Type: AbstractPayoutDestination

Details:

public $payoutToken : string

Description

Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data

Type: string

Details:

public $personal_data : \YooKassa\Request\Payouts\PayoutPersonalData

Description

Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с проверкой получателя (только для выплат через СБП).

Type: PayoutPersonalData

Details:

public $personalData : \YooKassa\Request\Payouts\PayoutPersonalData

Description

Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с проверкой получателя (только для выплат через СБП).

Type: PayoutPersonalData

Details:

public $receipt_data : \YooKassa\Request\Payouts\IncomeReceiptData

Description

Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату самозанятому. Только для обычных выплат.

Type: IncomeReceiptData

Details:

public $receiptData : \YooKassa\Request\Payouts\IncomeReceiptData

Description

Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату самозанятому. Только для обычных выплат.

Type: IncomeReceiptData

Details:

public $self_employed : \YooKassa\Request\Payouts\PayoutSelfEmployedInfo

Description

Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату самозанятому. Только для обычных выплат.

Type: PayoutSelfEmployedInfo

Details:

public $selfEmployed : \YooKassa\Request\Payouts\PayoutSelfEmployedInfo

Description

Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату самозанятому. Только для обычных выплат.

Type: PayoutSelfEmployedInfo

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

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

Summary

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

Details:

Returns: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder - Инстанс билдера объектов запросов

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 getAmount() : \YooKassa\Model\AmountInterface

public getAmount() : \YooKassa\Model\AmountInterface

Summary

Возвращает сумму выплаты

Details:

Returns: \YooKassa\Model\AmountInterface - Сумма выплаты

public getDeal() : \YooKassa\Model\Deal\PayoutDealInfo

public getDeal() : \YooKassa\Model\Deal\PayoutDealInfo

Summary

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

Details:

Returns: \YooKassa\Model\Deal\PayoutDealInfo - Сделка, в рамках которой нужно провести выплату

public getDescription() : string

public getDescription() : string

Summary

Возвращает описание транзакции

Details:

Returns: string -

public getLastValidationError() : string

public getLastValidationError() : string

Summary

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

Details:

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

public getMetadata() : \YooKassa\Model\Metadata

public getMetadata() : \YooKassa\Model\Metadata

Summary

Возвращает данные оплаты установленные мерчантом

Details:

Returns: \YooKassa\Model\Metadata - Метаданные, привязанные к выплате

public getPaymentMethodId() : string|null

public getPaymentMethodId() : string|null

Summary

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

Details:

Returns: string|null - Идентификатор сохраненного способа оплаты

public getPayoutDestinationData() : \YooKassa\Model\Payout\AbstractPayoutDestination

public getPayoutDestinationData() : \YooKassa\Model\Payout\AbstractPayoutDestination

Summary

Возвращает данные для создания метода оплаты

Details:

Returns: \YooKassa\Model\Payout\AbstractPayoutDestination - Данные используемые для создания метода оплаты

public getPayoutToken() : string

public getPayoutToken() : string

Summary

Возвращает токенизированные данные для выплаты

Details:

Returns: string - Токенизированные данные для выплаты

public getPersonalData() : \YooKassa\Request\Payouts\PayoutPersonalData[]|null

public getPersonalData() : \YooKassa\Request\Payouts\PayoutPersonalData[]|null

Summary

Возвращает персональные данные получателя выплаты.

Details:

Returns: \YooKassa\Request\Payouts\PayoutPersonalData[]|null - Персональные данные получателя выплаты

public getReceiptData() : \YooKassa\Request\Payouts\IncomeReceiptData|null

public getReceiptData() : \YooKassa\Request\Payouts\IncomeReceiptData|null

Summary

Возвращает данные для формирования чека в сервисе Мой налог.

Details:

Returns: \YooKassa\Request\Payouts\IncomeReceiptData|null - Данные для формирования чека в сервисе Мой налог

public getSelfEmployed() : \YooKassa\Request\Payouts\PayoutSelfEmployedInfo|null

public getSelfEmployed() : \YooKassa\Request\Payouts\PayoutSelfEmployedInfo|null

Summary

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

Details:

Returns: \YooKassa\Request\Payouts\PayoutSelfEmployedInfo|null - Данные самозанятого, который получит выплату

public hasAmount() : bool

public hasAmount() : bool

Summary

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

Details:

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

public hasDeal() : bool

public hasDeal() : bool

Summary

Проверяет наличие сделки в создаваемой выплате

Details:

Returns: bool - True если сделка есть, false если нет

public hasDescription() : bool

public hasDescription() : bool

Summary

Проверяет наличие описания транзакции в создаваемом платеже

Details:

Returns: bool - True если описание транзакции есть, false если нет

public hasMetadata() : bool

public hasMetadata() : bool

Summary

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

Details:

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

public hasPaymentMethodId() : bool

public hasPaymentMethodId() : bool

Summary

Проверяет наличие идентификатора сохраненного способа оплаты

Details:

Returns: bool - True если идентификатора установлен, false если нет

public hasPayoutDestinationData() : bool

public hasPayoutDestinationData() : bool

Summary

Проверяет установлен ли объект с методом оплаты

Details:

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

public hasPayoutToken() : bool

public hasPayoutToken() : bool

Summary

Проверяет наличие токенизированных данных для выплаты

Details:

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

public hasPersonalData() : bool

public hasPersonalData() : bool

Summary

Проверяет наличие персональных данных в создаваемой выплате

Details:

Returns: bool - True если персональные данные есть, false если нет

public hasReceiptData() : bool

public hasReceiptData() : bool

Summary

Проверяет наличие данных для формирования чека в сервисе Мой налог.

Details:

Returns: bool - True если данные для формирования чека есть, false если нет

public hasSelfEmployed() : bool

public hasSelfEmployed() : 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 setAmount() : mixed

public setAmount(\YooKassa\Model\AmountInterface|array|string|numeric-string|int|float|null $value) : mixed

Summary

Устанавливает сумму выплаты

Details:

Parameters:
Type Name Description
\YooKassa\Model\AmountInterface OR array OR string OR numeric-string OR int OR float OR null value Сумма выплаты
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если был передан объект невалидного типа

Returns: mixed -

public setDeal() : mixed

public setDeal(\YooKassa\Model\Deal\PayoutDealInfo|array $value) : mixed

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\Deal\PayoutDealInfo OR array value Сделка, в рамках которой нужно провести выплату

Returns: mixed -

public setDescription() : mixed

public setDescription(string $value) : mixed

Summary

Устанавливает описание транзакции

Details:

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

Returns: mixed -

public setMetadata() : mixed

public setMetadata(\YooKassa\Model\Metadata|array|null $value) : mixed

Summary

Устанавливает метаданные, привязанные к выплате

Details:

Parameters:
Type Name Description
\YooKassa\Model\Metadata OR array OR null value Метаданные выплаты, устанавливаемые мерчантом
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданные данные не удалось интерпретировать как метаданные выплаты

Returns: mixed -

public setPaymentMethodId() : $this

public setPaymentMethodId(string|null $value = null) : $this

Summary

Устанавливает идентификатор сохраненного способа оплаты.

Details:

Parameters:
Type Name Description
string OR null value Идентификатор сохраненного способа оплаты

Returns: $this -

public setPayoutDestinationData() : mixed

public setPayoutDestinationData(\YooKassa\Request\Payouts\PayoutDestinationData\AbstractPayoutDestinationData|array|null $value) : mixed

Summary

Устанавливает объект с информацией для создания метода оплаты

Details:

Parameters:
Type Name Description
\YooKassa\Request\Payouts\PayoutDestinationData\AbstractPayoutDestinationData OR array OR null value Объект создания метода оплаты или null
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если был передан объект невалидного типа

Returns: mixed -

public setPayoutToken() : mixed

public setPayoutToken(string $value) : mixed

Summary

Устанавливает токенизированные данные для выплаты

Details:

Parameters:
Type Name Description
string value Токенизированные данные для выплаты
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданное значение не является строкой

Returns: mixed -

public setPersonalData() : $this

public setPersonalData(\YooKassa\Request\Payouts\PayoutPersonalData[]|array|null $value = null) : $this

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Request\Payouts\PayoutPersonalData[] OR array OR null value Персональные данные получателя выплаты

Returns: $this -

public setReceiptData() : $this

public setReceiptData(\YooKassa\Request\Payouts\IncomeReceiptData|array|null $value = null) : $this

Summary

Устанавливает данные для формирования чека в сервисе Мой налог.

Details:

Parameters:
Type Name Description
\YooKassa\Request\Payouts\IncomeReceiptData OR array OR null value Данные для формирования чека в сервисе Мой налог

Returns: $this -

public setSelfEmployed() : $this

public setSelfEmployed(\YooKassa\Request\Payouts\PayoutSelfEmployedInfo|array|null $value = null) : $this

Summary

Устанавливает данные самозанятого, который получит выплату.

Details:

Parameters:
Type Name Description
\YooKassa\Request\Payouts\PayoutSelfEmployedInfo OR array OR null value Данные самозанятого, который получит выплату

Returns: $this -

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