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

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	$payout_destination_data		Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token.
public	$payout_token		Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data
public	$payoutDestinationData		Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token.
public	$payoutToken		Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data

---

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	getPayoutDestinationData()		Возвращает данные для создания метода оплаты
public	getPayoutToken()		Проверяет наличие токенизированных данных для выплаты
public	hasAmount()		Проверяет, была ли установлена сумма выплаты
public	hasDeal()		Проверяет наличие сделки в создаваемой выплате
public	hasDescription()		Проверяет наличие описания транзакции в создаваемом платеже
public	hasMetadata()		Проверяет, были ли установлены метаданные выплаты
public	hasPayoutDestinationData()		Проверяет установлен ли объект с методом оплаты
public	hasPayoutToken()		Проверяет наличие одноразового токена для проведения оплаты
public	jsonSerialize()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации
public	offsetExists()		Проверяет наличие свойства
public	offsetGet()		Возвращает значение свойства
public	offsetSet()		Устанавливает значение свойства
public	offsetUnset()		Удаляет свойство
public	setAmount()		Устанавливает сумму выплаты
public	setDeal()		Устанавливает сделку, в рамках которой нужно провести выплату
public	setDescription()		Устанавливает описание транзакции
public	setMetadata()		Устанавливает метаданные, привязанные к выплате
public	setPayoutDestinationData()		Устанавливает объект с информацией для создания метода оплаты
public	setPayoutToken()		Устанавливает токенизированные данные для выплаты
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
public	validate()		Проверяет на валидность текущий объект
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта
protected	setValidationError()		Устанавливает ошибку валидации

---

Details

• File: lib/Request/Payouts/CreatePayoutRequest.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Common\AbstractRequest
  • \YooKassa\Request\Payouts\CreatePayoutRequest
• Implements:
  • \YooKassa\Request\Payouts\CreatePayoutRequestInterface

---

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 $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:

---

Methods

public __construct() : mixed

public __construct(array $data = array()) : mixed

Summary

AbstractObject constructor.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array	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() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public __unset() : mixed

public __unset(string $propertyName) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

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

public clearValidationError() : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Returns: mixed -

public fromArray() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public getAmount() : \YooKassa\Model\AmountInterface

public getAmount() : \YooKassa\Model\AmountInterface

Summary

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

Details:

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

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

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

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

Summary

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

Details:

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

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

public getDescription() : string

public getDescription() : string

Summary

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

Details:

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

Returns: string -

public getLastValidationError() : string

public getLastValidationError() : string

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

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

public getMetadata() : \YooKassa\Model\Metadata

public getMetadata() : \YooKassa\Model\Metadata

Summary

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

Details:

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

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

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

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

Summary

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

Details:

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

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

public getPayoutToken() : bool

public getPayoutToken() : bool

Summary

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

Details:

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

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

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

Tags

Tag	Version	Description
retrun		void

public offsetUnset() : mixed

public offsetUnset(string $offset) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

Tags

Tag	Version	Description
retrun		void

public setAmount() : mixed

public setAmount(mixed $value) : mixed

Summary

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

Details:

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

Parameters:

Type	Name	Description
mixed	value

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если был передан объект невалидного типа

Returns: mixed -

public setDeal() : mixed

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

Summary

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

Details:

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

Parameters:

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

Returns: mixed -

public setDescription() : mixed

public setDescription(string $value) : mixed

Summary

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

Details:

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

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:

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

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданные данные не удалось интерпретировать как метаданные выплаты

Returns: mixed -

public setPayoutDestinationData() : mixed

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

Summary

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

Details:

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

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:

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

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданное значение не является строкой

Returns: mixed -

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

protected setValidationError(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Parameters:

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

Returns: mixed -

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 0
• Deprecated - 23

---

This document was automatically generated from source code comments on 2023-01-18 using phpDocumentor

© 2023 YooMoney