Александра Д. Спиридонова
7a7f5cafa8
Добавлено поле `metadata` в сохраненных методах оплаты Увеличено максимальное значение числа цифр параметра `oktmo` в данных платежных поручений `PaymentOrder`
9.3 KiB
YooKassa API SDK
Interface: PayoutInterface
Namespace: \YooKassa\Model\Payout
Summary:
Interface DealInterface.
Constants
- No constants found
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | getAmount() | Возвращает баланс сделки. | |
| public | getCancellationDetails() | Возвращает комментарий к статусу canceled: кто отменил выплату и по какой причине. | |
| public | getCreatedAt() | Возвращает время создания выплаты. | |
| public | getDeal() | Возвращает сделку, в рамках которой нужно провести выплату. | |
| public | getDescription() | Возвращает описание транзакции (не более 128 символов). | |
| public | getId() | Возвращает Id сделки. | |
| public | getMetadata() | Возвращает дополнительные данные сделки. | |
| public | getPayoutDestination() | Возвращает платежное средство, на которое ЮKassa зачисляет выплату. | |
| public | getStatus() | Возвращает статус сделки. | |
| public | getSucceededAt() | Возвращает время успешного проведения выплаты. | |
| public | getTest() | Возвращает признак тестовой операции. |
Details
- File: lib/Model/Payout/PayoutInterface.php
- Package: \YooKassa\Model
- See Also:
Tags
| Tag | Version | Description |
|---|---|---|
| category | Interface | |
| author | cms@yoomoney.ru | |
| property | Идентификатор выплаты | |
| property | Сумма выплаты | |
| property | Текущее состояние выплаты | |
| property | Способ проведения выплаты | |
| property | Способ проведения выплаты | |
| property | Описание транзакции | |
| property | Время создания заказа | |
| property | Время создания заказа | |
| property | Время успешного проведения выплаты | |
| property | Время успешного проведения выплаты | |
| property | Сделка, в рамках которой нужно провести выплату | |
| property | Комментарий к отмене выплаты | |
| property | Комментарий к отмене выплаты | |
| property | Метаданные платежа указанные мерчантом | |
| property | Признак тестовой операции |
Methods
public getId() : string|null
public getId() : string|null
Summary
Возвращает Id сделки.
Details:
- Inherited From: \YooKassa\Model\Payout\PayoutInterface
Returns: string|null - Id сделки
public getAmount() : \YooKassa\Model\AmountInterface|null
public getAmount() : \YooKassa\Model\AmountInterface|null
Summary
Возвращает баланс сделки.
Details:
- Inherited From: \YooKassa\Model\Payout\PayoutInterface
Returns: \YooKassa\Model\AmountInterface|null - Баланс сделки
public getStatus() : string|null
public getStatus() : string|null
Summary
Возвращает статус сделки.
Details:
- Inherited From: \YooKassa\Model\Payout\PayoutInterface
Returns: string|null - Статус сделки
public getPayoutDestination() : \YooKassa\Model\Payout\AbstractPayoutDestination|null
public getPayoutDestination() : \YooKassa\Model\Payout\AbstractPayoutDestination|null
Summary
Возвращает платежное средство, на которое ЮKassa зачисляет выплату.
Details:
- Inherited From: \YooKassa\Model\Payout\PayoutInterface
Returns: \YooKassa\Model\Payout\AbstractPayoutDestination|null - Платежное средство, на которое ЮKassa зачисляет выплату.
public getDescription() : string|null
public getDescription() : string|null
Summary
Возвращает описание транзакции (не более 128 символов).
Details:
- Inherited From: \YooKassa\Model\Payout\PayoutInterface
Returns: string|null - Описание транзакции
public getCreatedAt() : \DateTime|null
public getCreatedAt() : \DateTime|null
Summary
Возвращает время создания выплаты.
Details:
- Inherited From: \YooKassa\Model\Payout\PayoutInterface
Returns: \DateTime|null - Время создания сделки
public getSucceededAt() : \DateTime|null
public getSucceededAt() : \DateTime|null
Summary
Возвращает время успешного проведения выплаты.
Details:
- Inherited From: \YooKassa\Model\Payout\PayoutInterface
Returns: \DateTime|null - Время создания выплаты
public getDeal() : \YooKassa\Model\Deal\PayoutDealInfo|null
public getDeal() : \YooKassa\Model\Deal\PayoutDealInfo|null
Summary
Возвращает сделку, в рамках которой нужно провести выплату.
Details:
- Inherited From: \YooKassa\Model\Payout\PayoutInterface
Returns: \YooKassa\Model\Deal\PayoutDealInfo|null - Сделка, в рамках которой нужно провести выплату
public getCancellationDetails() : null|\YooKassa\Model\Payout\PayoutCancellationDetails
public getCancellationDetails() : null|\YooKassa\Model\Payout\PayoutCancellationDetails
Summary
Возвращает комментарий к статусу canceled: кто отменил выплату и по какой причине.
Details:
- Inherited From: \YooKassa\Model\Payout\PayoutInterface
Returns: null|\YooKassa\Model\Payout\PayoutCancellationDetails - Комментарий к статусу canceled: кто отменил выплату и по какой причине
public getMetadata() : \YooKassa\Model\Metadata|null
public getMetadata() : \YooKassa\Model\Metadata|null
Summary
Возвращает дополнительные данные сделки.
Details:
- Inherited From: \YooKassa\Model\Payout\PayoutInterface
Returns: \YooKassa\Model\Metadata|null - Дополнительные данные сделки
public getTest() : bool|null
public getTest() : bool|null
Summary
Возвращает признак тестовой операции.
Details:
- Inherited From: \YooKassa\Model\Payout\PayoutInterface
Returns: bool|null - Признак тестовой операции
Top Namespaces
Reports
This document was automatically generated from source code comments on 2026-08-12 using phpDocumentor
© 2026 YooMoney