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-PayoutResponse.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

37 KiB
Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Request\Payouts\PayoutResponse

Namespace: \YooKassa\Request\Payouts

Summary:

Класс объекта ответа, возвращаемого API при запросе конкретной выплаты

Constants

Visibility Name Flag Summary
public MAX_LENGTH_DESCRIPTION Максимальная длина строки описания выплаты

Properties

Visibility Name Flag Summary
public $amount Сумма выплаты
public $cancellation_details Комментарий к отмене выплаты
public $cancellationDetails Комментарий к отмене выплаты
public $created_at Время создания заказа
public $createdAt Время создания заказа
public $deal Сделка, в рамках которой нужно провести выплату
public $description Описание транзакции
public $id Идентификатор выплаты
public $metadata Метаданные выплаты указанные мерчантом
public $payout_destination Способ проведения выплаты
public $payoutDestination Способ проведения выплаты
public $receipt Данные чека, зарегистрированного в ФНС
public $self_employed Данные самозанятого, который получит выплату
public $selfEmployed Данные самозанятого, который получит выплату
public $status Текущее состояние выплаты
public $test Признак тестовой операции

Methods

Visibility Name Flag Summary
public __construct() AbstractObject constructor.
public __get() Возвращает значение свойства
public __isset() Проверяет наличие свойства
public __set() Устанавливает значение свойства
public __unset() Удаляет свойство
public fromArray() Устанавливает значения свойств текущего объекта из массива
public getAmount() Возвращает сумму
public getCancellationDetails() Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине
public getCreatedAt() Возвращает время создания заказа
public getDeal() Возвращает сделку, в рамках которой нужно провести выплату
public getDescription() Возвращает описание транзакции
public getId() Возвращает идентификатор выплаты
public getMetadata() Возвращает метаданные выплаты установленные мерчантом
public getPayoutDestination() Возвращает используемый способ проведения выплаты
public getReceipt() Возвращает данные чека, зарегистрированного в ФНС.
public getSelfEmployed() Возвращает данные самозанятого, который получит выплату.
public getStatus() Возвращает состояние выплаты
public getTest() Возвращает признак тестовой операции
public jsonSerialize()
public offsetExists()
public offsetGet()
public offsetSet()
public offsetUnset()
public setAmount() Устанавливает сумму выплаты
public setCancellationDetails() Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине
public setCreatedAt() Устанавливает время создания заказа
public setDeal() Устанавливает сделку, в рамках которой нужно провести выплату
public setDescription() Устанавливает описание транзакции
public setId() Устанавливает идентификатор выплаты
public setMetadata() Устанавливает метаданные выплаты
public setPayoutDestination() Устанавливает используемый способ проведения выплаты
public setReceipt() Устанавливает данные чека, зарегистрированного в ФНС.
public setSelfEmployed() Устанавливает данные самозанятого, который получит выплату.
public setStatus() Устанавливает статус выплаты
public setTest() Устанавливает признак тестовой операции
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта

Details

Constants

MAX_LENGTH_DESCRIPTION

Inherited from \YooKassa\Model\Payout

Максимальная длина строки описания выплаты

MAX_LENGTH_DESCRIPTION = 128

Properties

public $amount : \YooKassa\Model\AmountInterface

Description

Сумма выплаты

Type: AmountInterface

Details:

public $cancellation_details : \YooKassa\Model\CancellationDetailsInterface

Description

Комментарий к отмене выплаты

Type: CancellationDetailsInterface

Details:

public $cancellationDetails : \YooKassa\Model\CancellationDetailsInterface

Description

Комментарий к отмене выплаты

Type: CancellationDetailsInterface

Details:

public $created_at : \DateTime

Description

Время создания заказа

Type: \DateTime

Details:

public $createdAt : \DateTime

Description

Время создания заказа

Type: \DateTime

Details:

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

Description

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

Type: PayoutDealInfo

Details:

public $description : string

Description

Описание транзакции

Type: string

Details:

public $id : string

Description

Идентификатор выплаты

Type: string

Details:

public $metadata : \YooKassa\Model\Metadata

Description

Метаданные выплаты указанные мерчантом

Type: Metadata

Details:

public $payout_destination : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod

Description

Способ проведения выплаты

Type: AbstractPaymentMethod

Details:

public $payoutDestination : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod

Description

Способ проведения выплаты

Type: AbstractPaymentMethod

Details:

public $receipt : \YooKassa\Model\Payout\IncomeReceipt

Description

Данные чека, зарегистрированного в ФНС

Type: IncomeReceipt

Details:

public $self_employed : \YooKassa\Model\Payout\PayoutSelfEmployed

Description

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

Type: PayoutSelfEmployed

Details:

public $selfEmployed : \YooKassa\Model\Payout\PayoutSelfEmployed

Description

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

Type: PayoutSelfEmployed

Details:

public $status : string

Description

Текущее состояние выплаты

Type: string

Details:

public $test : bool

Description

Признак тестовой операции

Type: bool

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 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 getCancellationDetails() : \YooKassa\Model\Payout\PayoutCancellationDetails|null

public getCancellationDetails() : \YooKassa\Model\Payout\PayoutCancellationDetails|null

Summary

Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине

Details:

Returns: \YooKassa\Model\Payout\PayoutCancellationDetails|null - Комментарий к статусу canceled

Tags
Tag Version Description
since 1.0.13

public getCreatedAt() : \DateTime

public getCreatedAt() : \DateTime

Summary

Возвращает время создания заказа

Details:

Returns: \DateTime - Время создания заказа

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

public getId() : string

Summary

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

Details:

Returns: string - Идентификатор выплаты

public getMetadata() : \YooKassa\Model\Metadata

public getMetadata() : \YooKassa\Model\Metadata

Summary

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

Details:

Returns: \YooKassa\Model\Metadata - Метаданные выплаты указанные мерчантом

public getPayoutDestination() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod

public getPayoutDestination() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod

Summary

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

Details:

Returns: \YooKassa\Model\PaymentMethod\AbstractPaymentMethod - Способ проведения выплаты

public getReceipt() : \YooKassa\Model\Payout\IncomeReceipt|null

public getReceipt() : \YooKassa\Model\Payout\IncomeReceipt|null

Summary

Возвращает данные чека, зарегистрированного в ФНС.

Details:

Returns: \YooKassa\Model\Payout\IncomeReceipt|null - Данные чека, зарегистрированного в ФНС

public getSelfEmployed() : \YooKassa\Model\Payout\PayoutSelfEmployed|null

public getSelfEmployed() : \YooKassa\Model\Payout\PayoutSelfEmployed|null

Summary

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

Details:

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

public getStatus() : string

public getStatus() : string

Summary

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

Details:

Returns: string - Текущее состояние выплаты

public getTest() : bool

public getTest() : bool

Summary

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

Details:

Returns: bool - Признак тестовой операции

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|null $value = null) : mixed

Summary

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

Details:

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

Returns: mixed -

public setCancellationDetails() : mixed

public setCancellationDetails(\YooKassa\Model\Payout\PayoutCancellationDetails|array|null $value) : mixed

Summary

Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине

Details:

Parameters:
Type Name Description
\YooKassa\Model\Payout\PayoutCancellationDetails OR array OR null value Комментарий к статусу canceled

Returns: mixed -

public setCreatedAt() : mixed

public setCreatedAt(\DateTime|string|int $value) : mixed

Summary

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

Details:

Parameters:
Type Name Description
\DateTime OR string OR int value Время создания заказа
Throws:
Type Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException Выбрасывается если в метод была передана пустая дата
\YooKassa\Common\Exceptions\InvalidPropertyValueException Выбрасывается если передали строку, которую не удалось привести к дате
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException \Exception

Returns: mixed -

public setDeal() : mixed

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\Deal\PayoutDealInfo OR array OR null 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 setId() : mixed

public setId(string $value) : mixed

Summary

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

Details:

Parameters:
Type Name Description
string value Идентификатор выплаты
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException Выбрасывается если длина переданной строки не равна 36
\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 Метаданные выплаты указанные мерчантом

Returns: mixed -

public setPayoutDestination() : mixed

public setPayoutDestination(\YooKassa\Model\Payout\AbstractPayoutDestination|array|null $value) : mixed

Summary

Устанавливает используемый способ проведения выплаты

Details:

Parameters:
Type Name Description
\YooKassa\Model\Payout\AbstractPayoutDestination OR array OR null value Способ проведения выплаты

Returns: mixed -

public setReceipt() : $this

public setReceipt(\YooKassa\Model\Payout\IncomeReceipt|array|null $value = null) : $this

Summary

Устанавливает данные чека, зарегистрированного в ФНС.

Details:

Parameters:
Type Name Description
\YooKassa\Model\Payout\IncomeReceipt OR array OR null value Данные чека, зарегистрированного в ФНС

Returns: $this -

public setSelfEmployed() : $this

public setSelfEmployed(\YooKassa\Model\Payout\PayoutSelfEmployed|array|null $value = null) : $this

Summary

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

Details:

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

Returns: $this -

public setStatus() : mixed

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

public setTest(bool $value) : mixed

Summary

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

Details:

Parameters:
Type Name Description
bool value Признак тестовой операции

Returns: mixed -

public toArray() : array

public toArray() : array

Summary

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

Details:

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

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

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

Top Namespaces

Reports

This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor

© 2023 YooMoney