8.0 KiB
YooKassa API SDK
Interface: PayoutInterface
Namespace: \YooKassa\Model
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 | getTest() | Возвращает признак тестовой операции |
Details
- File: lib/Model/PayoutInterface.php
- Package: \YooKassa
Tags
| Tag | Version | Description |
|---|---|---|
| property-read | Идентификатор выплаты | |
| property-read | Сумма выплаты | |
| property-read | Текущее состояние выплаты | |
| property-read | Способ проведения выплаты | |
| property-read | Способ проведения выплаты | |
| property-read | Описание транзакции | |
| property-read | Время создания заказа | |
| property-read | Время создания заказа | |
| property-read | Сделка, в рамках которой нужно провести выплату | |
| property-read | Комментарий к отмене выплаты | |
| property-read | Комментарий к отмене выплаты | |
| property-read | Метаданные платежа указанные мерчантом | |
| property-read | Признак тестовой операции |
Methods
public getId() : string
public getId() : string
Summary
Возвращает Id сделки
Details:
- Inherited From: \YooKassa\Model\PayoutInterface
Returns: string - Id сделки
public getAmount() : \YooKassa\Model\MonetaryAmount
public getAmount() : \YooKassa\Model\MonetaryAmount
Summary
Возвращает баланс сделки
Details:
- Inherited From: \YooKassa\Model\PayoutInterface
Returns: \YooKassa\Model\MonetaryAmount - Баланс сделки
public getStatus() : string
public getStatus() : string
Summary
Возвращает статус сделки
Details:
- Inherited From: \YooKassa\Model\PayoutInterface
Returns: string - Статус сделки
public getPayoutDestination() : string
public getPayoutDestination() : string
Summary
Возвращает платежное средство продавца, на которое ЮKassa переводит оплату
Details:
- Inherited From: \YooKassa\Model\PayoutInterface
Returns: string - Платежное средство продавца, на которое ЮKassa переводит оплату
public getDescription() : string
public getDescription() : string
Summary
Возвращает описание транзакции (не более 128 символов)
Details:
- Inherited From: \YooKassa\Model\PayoutInterface
Returns: string - Описание транзакции
public getCreatedAt() : \DateTime
public getCreatedAt() : \DateTime
Summary
Возвращает время создания сделки
Details:
- Inherited From: \YooKassa\Model\PayoutInterface
Returns: \DateTime - Время создания сделки
public getDeal() : \YooKassa\Model\Deal\PayoutDealInfo
public getDeal() : \YooKassa\Model\Deal\PayoutDealInfo
Summary
Возвращает сделку, в рамках которой нужно провести выплату.
Details:
- Inherited From: \YooKassa\Model\PayoutInterface
Returns: \YooKassa\Model\Deal\PayoutDealInfo - Сделка, в рамках которой нужно провести выплату
public getCancellationDetails() : \YooKassa\Model\Payout\PayoutCancellationDetails
public getCancellationDetails() : \YooKassa\Model\Payout\PayoutCancellationDetails
Summary
Возвращает комментарий к статусу canceled: кто отменил выплату и по какой причине.
Details:
- Inherited From: \YooKassa\Model\PayoutInterface
Returns: \YooKassa\Model\Payout\PayoutCancellationDetails - Комментарий к статусу canceled: кто отменил выплату и по какой причине
public getMetadata() : \YooKassa\Model\Metadata
public getMetadata() : \YooKassa\Model\Metadata
Summary
Возвращает дополнительные данные сделки
Details:
- Inherited From: \YooKassa\Model\PayoutInterface
Returns: \YooKassa\Model\Metadata - Дополнительные данные сделки
public getTest() : bool
public getTest() : bool
Summary
Возвращает признак тестовой операции
Details:
- Inherited From: \YooKassa\Model\PayoutInterface
Returns: bool - Признак тестовой операции
Top Namespaces
Reports
This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor
© 2023 YooMoney