geckon01/yookassa-sdk-php
1
0
Fork 0
mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-08-30 03:58:43 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
yookassa-sdk-php/docs/classes/YooKassa-Request-Payouts-CreatePayoutResponse.md
T

50 KiB
Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Request\Payouts\CreatePayoutResponse

Namespace: \YooKassa\Request\Payouts

Summary:

Класс, представляющий CreatePayoutResponse.

Description:

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

Constants

Visibility Name Flag Summary
public MAX_LENGTH_DESCRIPTION
public MAX_LENGTH_ID
public MIN_LENGTH_ID

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 $succeeded_at Время успешного проведения выплаты
public $succeededAt Время успешного проведения выплаты
public $test Признак тестовой операции
protected $_amount Сумма выплаты
protected $_cancellation_details Комментарий к статусу canceled: кто отменил выплаты и по какой причине
protected $_created_at Время создания выплаты. Пример: ~2017-11-03T11:52:31.827Z
protected $_deal Сделка, в рамках которой нужно провести выплату. Присутствует, если вы проводите Безопасную сделку
protected $_description Описание транзакции (не более 128 символов). Например: «Выплата по договору 37».
protected $_id Идентификатор выплаты.
protected $_metadata Метаданные выплаты указанные мерчантом
protected $_payout_destination Способ проведения выплаты
protected $_receipt Данные чека, зарегистрированного в ФНС. Присутствует, если вы делаете выплату самозанятому.
protected $_self_employed Данные самозанятого, который получит выплату. Присутствует, если вы делаете выплату самозанятому
protected $_status Текущее состояние выплаты
protected $_succeeded_at Время успешного проведения выплаты. Пример: ~2017-11-03T11:52:42.312Z Обязательный параметр для выплат в статусе ~succeeded
protected $_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 getSucceededAt() Возвращает время успешного проведения выплаты.
public getTest() Возвращает признак тестовой операции.
public getValidator()
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
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 setSucceededAt() Устанавливает время успешного проведения выплаты.
public setTest() Устанавливает признак тестовой операции.
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected validatePropertyValue()

Details

Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Constants

MAX_LENGTH_DESCRIPTION

Inherited from \YooKassa\Model\Payout\Payout

MAX_LENGTH_DESCRIPTION = 128 : int

MAX_LENGTH_ID

Inherited from \YooKassa\Model\Payout\Payout

MAX_LENGTH_ID = 50 : int

MIN_LENGTH_ID

Inherited from \YooKassa\Model\Payout\Payout

MIN_LENGTH_ID = 36 : int

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\Payout\AbstractPayoutDestination

Description

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

Type: AbstractPayoutDestination

Details:

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

Description

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

Type: AbstractPayoutDestination

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 $succeeded_at : \DateTime

Description

Время успешного проведения выплаты

Type: \DateTime

Details:

public $succeededAt : \DateTime

Description

Время успешного проведения выплаты

Type: \DateTime

Details:

public $test : bool

Description

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

Type: bool

Details:

protected $_amount : ?\YooKassa\Model\AmountInterface

Summary

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

Type: AmountInterface

Details:

protected $_cancellation_details : ?\YooKassa\Model\Payout\PayoutCancellationDetails

Summary

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

Type: PayoutCancellationDetails

Details:

protected $_created_at : ?\DateTime

Summary

Время создания выплаты. Пример: ~2017-11-03T11:52:31.827Z

Type: DateTime

Details:

protected $_deal : ?\YooKassa\Model\Deal\PayoutDealInfo

Summary

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

Type: PayoutDealInfo

Details:

protected $_description : ?string

Summary

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

Type: ?string

Details:

protected $_id : ?string

Summary

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

Type: ?string

Details:

protected $_metadata : ?\YooKassa\Model\Metadata

Summary

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

Type: Metadata

Details:

protected $_payout_destination : ?\YooKassa\Model\Payout\AbstractPayoutDestination

Summary

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

Type: AbstractPayoutDestination

Details:

protected $_receipt : ?\YooKassa\Model\Payout\IncomeReceipt

Summary

Данные чека, зарегистрированного в ФНС. Присутствует, если вы делаете выплату самозанятому.

Type: IncomeReceipt

Details:

protected $_self_employed : ?\YooKassa\Model\Payout\PayoutSelfEmployed

Summary

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

Type: PayoutSelfEmployed

Details:

protected $_status : ?string

Summary

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

Type: ?string

Details:

protected $_succeeded_at : ?\DateTime

Summary

Время успешного проведения выплаты. Пример: ~2017-11-03T11:52:42.312Z Обязательный параметр для выплат в статусе ~succeeded

Type: DateTime

Details:

protected $_test : ?bool

Summary

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

Type: ?bool

Details:

Methods

public __construct() : mixed

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

Summary

AbstractObject constructor.

Details:

Parameters:
Type Name Description
array OR null 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() : void

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

Summary

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

Details:

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

Returns: void -

public __unset() : void

public __unset(string $propertyName) : void

Summary

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

Details:

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

Returns: void -

public fromArray() : void

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

Summary

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

Details:

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

Returns: void -

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

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

Summary

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

Details:

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

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

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

Summary

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

Details:

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

public getCreatedAt() : \DateTime|null

public getCreatedAt() : \DateTime|null

Summary

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

Details:

Returns: \DateTime|null - Время создания выплаты

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

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

Summary

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

Details:

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

public getDescription() : string|null

public getDescription() : string|null

Summary

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

Details:

Returns: string|null -

public getId() : string|null

public getId() : string|null

Summary

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

Details:

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

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

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

Summary

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

Details:

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

public getPayoutDestination() : \YooKassa\Model\Payout\AbstractPayoutDestination|null

public getPayoutDestination() : \YooKassa\Model\Payout\AbstractPayoutDestination|null

Summary

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

Details:

Returns: \YooKassa\Model\Payout\AbstractPayoutDestination|null - Способ проведения выплаты

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|null

public getStatus() : string|null

Summary

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

Details:

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

public getSucceededAt() : \DateTime|null

public getSucceededAt() : \DateTime|null

Summary

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

Details:

Returns: \DateTime|null - Время успешного проведения выплаты

public getTest() : bool|null

public getTest() : bool|null

Summary

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

Details:

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

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

public jsonSerialize() : array

public jsonSerialize() : array

Summary

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

Details:

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

public offsetExists() : bool

public offsetExists(string $offset) : bool

Summary

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

Details:

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

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

public offsetGet() : mixed

public offsetGet(string $offset) : mixed

Summary

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

Details:

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

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

public offsetSet() : void

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

Summary

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

Details:

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

Returns: void -

public offsetUnset() : void

public offsetUnset(string $offset) : void

Summary

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

Details:

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

Returns: void -

public setAmount() : self

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

Summary

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

Details:

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

Returns: self -

public setCancellationDetails() : self

public setCancellationDetails(\YooKassa\Model\Payout\PayoutCancellationDetails|array|null $cancellation_details = null) : self

Summary

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

Details:

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

Returns: self -

public setCreatedAt() : self

public setCreatedAt(\DateTime|string|null $created_at = null) : self

Summary

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

Details:

Parameters:
Type Name Description
\DateTime OR string OR null created_at Время создания выплаты. Пример: ~2017-11-03T11:52:31.827Z

Returns: self -

public setDeal() : self

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

Summary

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

Details:

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:

Parameters:
Type Name Description
string OR null description Описание транзакции (не более 128 символов). Например: «Выплата по договору 37».

Returns: self -

public setId() : self

public setId(string|null $id = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null id Идентификатор выплаты

Returns: self -

public setMetadata() : self

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\Metadata OR array OR null metadata Метаданные выплаты указанные мерчантом

Returns: self -

public setPayoutDestination() : $this

public setPayoutDestination(\YooKassa\Model\Payout\AbstractPayoutDestination|array|null $payout_destination) : $this

Summary

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

Details:

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

Returns: $this -

public setReceipt() : self

public setReceipt(\YooKassa\Model\Payout\IncomeReceipt|array|null $receipt = null) : self

Summary

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

Details:

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

Returns: self -

public setSelfEmployed() : self

public setSelfEmployed(\YooKassa\Model\Payout\PayoutSelfEmployed|array|null $self_employed = null) : self

Summary

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

Details:

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

Returns: self -

public setStatus() : self

public setStatus(string|null $status = null) : self

Summary

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

Details:

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

Returns: self -

public setSucceededAt() : self

public setSucceededAt(\DateTime|string|null $succeeded_at = null) : self

Summary

Устанавливает время успешного проведения выплаты.

Details:

Parameters:
Type Name Description
\DateTime OR string OR null succeeded_at Время успешного проведения выплаты. Указывается по UTC и передается в формате ISO 8601. Пример: ~2017-11-03T11:52:42.312Z Обязательный параметр для выплат в статусе ~succeeded.

Returns: self -

public setTest() : self

public setTest(bool|null $test = null) : self

Summary

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

Details:

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

Returns: self -

public toArray() : array

public toArray() : array

Summary

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

Details:

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

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

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

protected validatePropertyValue() : mixed

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

Details:

Parameters:
Type Name Description
string propertyName
mixed propertyValue

Returns: mixed -

Top Namespaces

Reports

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

© 2026 YooMoney

Reference in New Issue View Git Blame Copy Permalink