yookassa-sdk-php/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequest.md

YooKassa API SDK

Class: \YooKassa\Request\Payouts\CreatePayoutRequest

Namespace: \YooKassa\Request\Payouts

---

Summary:

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

Description:

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

---

Examples

Пример использования билдера

try {
    $payoutBuilder = \YooKassa\Request\Payouts\CreatePayoutRequest::builder();
    $payoutBuilder
        ->setAmount(new \YooKassa\Model\MonetaryAmount(80))
        ->setPayoutDestinationData(
            new \YooKassa\Request\Payouts\PayoutDestinationData\PayoutDestinationDataYooMoney(
                [
                    'type' => \YooKassa\Model\Payment\PaymentMethodType::YOO_MONEY,
                    'account_number' => '4100116075156746'
                ]
            )
        )
        ->setDeal(new \YooKassa\Model\Deal\PayoutDealInfo(['id' => 'dl-2909e77d-0022-5000-8000-0c37205b3208']))
        ->setDescription('Выплата по заказу №37')
    ;

    // Создаем объект запроса
    $request = $payoutBuilder->build();

    $idempotenceKey = uniqid('', true);
    $response = $client->createPayout($request, $idempotenceKey);
} catch (Exception $e) {
    $response = $e;
}

var_dump($response);

---

Constants

Visibility	Name	Flag	Summary
public	MAX_LENGTH_DESCRIPTION
public	MAX_PERSONAL_DATA
public	MIN_PERSONAL_DATA

---

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		Персональные данные получателя выплаты. Только для обычных выплат. Необходимо передавать в этих сценариях: - выплаты с проверкой получателя (только для выплат через СБП); - выплаты с передачей данных получателя для выписок из реестра. В массиве можно одновременно передать несколько идентификаторов, но только для разных типов данных.

---

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	getValidator()
public	hasAmount()		Проверяет, была ли установлена сумма выплаты.
public	hasDeal()		Проверяет наличие сделки в создаваемой выплате.
public	hasDescription()		Проверяет наличие описания транзакции в создаваемом платеже.
public	hasMetadata()		Проверяет, были ли установлены метаданные выплаты.
public	hasPaymentMethodId()		Проверяет наличие идентификатора сохраненного способа оплаты.
public	hasPayoutDestinationData()		Проверяет установлен ли объект с методом оплаты.
public	hasPayoutToken()		Проверяет наличие токенизированных данных для выплаты.
public	hasPersonalData()		Проверяет наличие персональных данных в создаваемой выплате.
public	jsonSerialize()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
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	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
public	validate()		Проверяет на валидность текущий объект
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected	setValidationError()		Устанавливает ошибку валидации.
protected	validatePropertyValue()

---

Details

• File: lib/Request/Payouts/CreatePayoutRequest.php

• Package: YooKassa\Request

• Class Hierarchy:

  • \YooKassa\Common\AbstractObject
  • \YooKassa\Common\AbstractRequest
  • \YooKassa\Request\Payouts\CreatePayoutRequest

• Implements:

  • \YooKassa\Request\Payouts\CreatePayoutRequestInterface

• See Also:

---

Tags

Tag	Version	Description
category		Class
author		cms@yoomoney.ru

---

Constants

MAX_LENGTH_DESCRIPTION

MAX_LENGTH_DESCRIPTION = 128 : int

MAX_PERSONAL_DATA

MAX_PERSONAL_DATA = 2 : int

MIN_PERSONAL_DATA

MIN_PERSONAL_DATA = 1 : int

---

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\Request\Payouts\PayoutDestinationData\AbstractPayoutDestinationData

---

Description

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

Type: AbstractPayoutDestinationData

Details:

public $payout_token : string

---

Description

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

Type: string

Details:

public $payoutDestinationData : \YooKassa\Request\Payouts\PayoutDestinationData\AbstractPayoutDestinationData

---

Description

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

Type: AbstractPayoutDestinationData

Details:

public $payoutToken : string

---

Description

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

Type: string

Details:

public $personal_data : \YooKassa\Common\ListObjectInterface|\YooKassa\Request\Payouts\PayoutPersonalData[]

---

Description

Персональные данные получателя выплаты. Только для обычных выплат. Необходимо передавать в этих сценариях: - выплаты с проверкой получателя (только для выплат через СБП); - выплаты с передачей данных получателя для выписок из реестра. В массиве можно одновременно передать несколько идентификаторов, но только для разных типов данных.

Type: PayoutPersonalData[]

Details:

public $personalData : \YooKassa\Common\ListObjectInterface|\YooKassa\Request\Payouts\PayoutPersonalData[]

---

Description

Персональные данные получателя выплаты. Только для обычных выплат. Необходимо передавать в этих сценариях: - выплаты с проверкой получателя (только для выплат через СБП); - выплаты с передачей данных получателя для выписок из реестра. В массиве можно одновременно передать несколько идентификаторов, но только для разных типов данных.

Type: PayoutPersonalData[]

Details:

---

Methods

public __construct() : mixed

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

Summary

AbstractObject constructor.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array OR null	data

Returns: mixed -

public __get() : mixed

public __get(string $propertyName) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public __isset() : bool

public __isset(string $propertyName) : bool

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public __set() : void

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public __unset() : void

public __unset(string $propertyName) : void

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

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

public clearValidationError() : void

public clearValidationError() : void

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Returns: void -

public fromArray() : void

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public getAmount() : \YooKassa\Model\AmountInterface|null

public getAmount() : \YooKassa\Model\AmountInterface|null

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

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

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

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

public getDescription() : string|null

public getDescription() : string|null

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

Returns: string|null - Описание транзакции

public getLastValidationError() : string|null

public getLastValidationError() : string|null

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

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

public getMetadata() : \YooKassa\Model\Metadata|null

public getMetadata() : \YooKassa\Model\Metadata|null

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

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

public getPaymentMethodId() : null|string

public getPaymentMethodId() : null|string

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

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

public getPayoutDestinationData() : \YooKassa\Request\Payouts\PayoutDestinationData\AbstractPayoutDestinationData|null

public getPayoutDestinationData() : \YooKassa\Request\Payouts\PayoutDestinationData\AbstractPayoutDestinationData|null

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

Returns: \YooKassa\Request\Payouts\PayoutDestinationData\AbstractPayoutDestinationData|null - Данные используемые для создания метода оплаты

public getPayoutToken() : string|null

public getPayoutToken() : string|null

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

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

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

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

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: \YooKassa\Validator\Validator -

public hasAmount() : bool

public hasAmount() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

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

public hasDeal() : bool

public hasDeal() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

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

public hasDescription() : bool

public hasDescription() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

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

public hasMetadata() : bool

public hasMetadata() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

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

public hasPaymentMethodId() : bool

public hasPaymentMethodId() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

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

public hasPayoutDestinationData() : bool

public hasPayoutDestinationData() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

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

public hasPayoutToken() : bool

public hasPayoutToken() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

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

public hasPersonalData() : bool

public hasPersonalData() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

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

public jsonSerialize() : array

public jsonSerialize() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

public offsetExists() : bool

public offsetExists(string $offset) : bool

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public offsetGet() : mixed

public offsetGet(string $offset) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public offsetSet() : void

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public offsetUnset() : void

public offsetUnset(string $offset) : void

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public setAmount() : self

public setAmount(\YooKassa\Model\AmountInterface|array|null $amount) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

Parameters:

Type	Name	Description
\YooKassa\Model\AmountInterface OR array OR null	amount	Сумма выплаты

Returns: self -

public setDeal() : self

public setDeal(\YooKassa\Model\Deal\PayoutDealInfo|array|null $deal) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

Parameters:

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

Returns: self -

public setDescription() : self

public setDescription(string|null $description = null) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

Parameters:

Type	Name	Description
string OR null	description	Описание транзакции

Returns: self -

public setMetadata() : $this

public setMetadata(\YooKassa\Model\Metadata|array|null $metadata = null) : $this

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

Parameters:

Type	Name	Description
\YooKassa\Model\Metadata OR array OR null	metadata	Метаданные выплаты, устанавливаемые мерчантом

Returns: $this -

public setPaymentMethodId() : self

public setPaymentMethodId(null|string $payment_method_id = null) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

Parameters:

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

Returns: self -

public setPayoutDestinationData() : self

public setPayoutDestinationData(\YooKassa\Request\Payouts\PayoutDestinationData\AbstractPayoutDestinationData|array|null $payout_destination_data) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

Parameters:

Type	Name	Description
\YooKassa\Request\Payouts\PayoutDestinationData\AbstractPayoutDestinationData OR array OR null	payout_destination_data	Объект создания метода оплаты или null

Returns: self -

public setPayoutToken() : self

public setPayoutToken(string|null $payout_token) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

Parameters:

Type	Name	Description
string OR null	payout_token	Токенизированные данные для выплаты

Returns: self -

public setPersonalData() : self

public setPersonalData(\YooKassa\Common\ListObjectInterface|array|null $personal_data = null) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

Parameters:

Type	Name	Description
\YooKassa\Common\ListObjectInterface OR array OR null	personal_data	Персональные данные получателя выплаты

Returns: self -

public toArray() : array

public toArray() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

public validate() : bool

public validate() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequest

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

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

protected setValidationError() : void

protected setValidationError(string $value) : void

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Parameters:

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

Returns: void -

protected validatePropertyValue() : mixed

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName
mixed	propertyValue

Returns: mixed -

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 0
• Deprecated - 43

---

This document was automatically generated from source code comments on 2026-08-13 using phpDocumentor

© 2026 YooMoney