Евгений Ю. Лозный
260d13f890
Добавлены нулевые привязки по СБП Добавлена причина отмены возвратов `payment_expired`
23 KiB
YooKassa API SDK
Interface: CreatePayoutRequestInterface
Namespace: \YooKassa\Request\Payouts
Summary:
Interface CreatePayoutRequestInterface.
Constants
- No constants found
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | getAmount() | Возвращает сумму выплаты. | |
| public | getDeal() | Возвращает сделку, в рамках которой нужно провести выплату. | |
| public | getDescription() | Возвращает описание транзакции. | |
| public | getMetadata() | Возвращает данные оплаты установленные мерчантом | |
| public | getPaymentMethodId() | Возвращает идентификатор сохраненного способа оплаты. | |
| public | getPayoutDestinationData() | Возвращает данные платежного средства, на которое нужно сделать выплату. | |
| public | getPayoutToken() | Возвращает токенизированные данные для выплаты. | |
| public | getPersonalData() | Возвращает персональные данные получателя выплаты. | |
| public | hasAmount() | Проверяет наличие суммы в создаваемой выплате. | |
| public | hasDeal() | Проверяет установлена ли сделка, в рамках которой нужно провести выплату. | |
| public | hasDescription() | Проверяет наличие описания транзакции в создаваемой выплате. | |
| public | hasMetadata() | Проверяет, были ли установлены метаданные заказа. | |
| public | hasPaymentMethodId() | Проверяет наличие идентификатора сохраненного способа оплаты. | |
| public | hasPayoutDestinationData() | Проверяет наличие данных платежного средства, на которое нужно сделать выплату. | |
| public | hasPayoutToken() | Проверяет наличие токенизированных данных для выплаты. | |
| public | hasPersonalData() | Проверяет наличие персональных данных в создаваемой выплате. | |
| public | setAmount() | Устанавливает сумму выплаты. | |
| public | setDeal() | Устанавливает сделку, в рамках которой нужно провести выплату. | |
| public | setDescription() | Устанавливает описание транзакции. | |
| public | setMetadata() | Устанавливает метаданные, привязанные к выплате. | |
| public | setPaymentMethodId() | Устанавливает идентификатор сохраненного способа оплаты. | |
| public | setPayoutDestinationData() | Устанавливает данные платежного средства, на которое нужно сделать выплату. | |
| public | setPayoutToken() | Устанавливает токенизированные данные для выплаты. | |
| public | setPersonalData() | Устанавливает персональные данные получателя выплаты. |
Details
- File: lib/Request/Payouts/CreatePayoutRequestInterface.php
- Package: \YooKassa\Request
- See Also:
Tags
| Tag | Version | Description |
|---|---|---|
| category | Interface | |
| author | cms@yoomoney.ru | |
| property | Сумма создаваемой выплаты | |
| property | Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token. | |
| property | Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token. | |
| property | Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data | |
| property | Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data | |
| property | Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты | |
| property | Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты | |
| property | Сделка, в рамках которой нужно провести выплату. Необходимо передавать, если вы проводите Безопасную сделку | |
| property | Описание транзакции (не более 128 символов). Например: «Выплата по договору N» | |
| property | Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с проверкой получателя (только для выплат через СБП). | |
| property | Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с проверкой получателя (только для выплат через СБП). | |
| property | Метаданные привязанные к выплате |
Methods
public getAmount() : \YooKassa\Model\AmountInterface|null
public getAmount() : \YooKassa\Model\AmountInterface|null
Summary
Возвращает сумму выплаты.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Returns: \YooKassa\Model\AmountInterface|null - Сумма выплаты
public hasAmount() : bool
public hasAmount() : bool
Summary
Проверяет наличие суммы в создаваемой выплате.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Returns: bool - True если сумма установлена, false если нет
public setAmount() : self
public setAmount(\YooKassa\Model\AmountInterface|array $amount) : self
Summary
Устанавливает сумму выплаты.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\AmountInterface OR array |
amount | Сумма выплаты |
Returns: self -
public getPayoutDestinationData() : null|\YooKassa\Model\Payout\AbstractPayoutDestination
public getPayoutDestinationData() : null|\YooKassa\Model\Payout\AbstractPayoutDestination
Summary
Возвращает данные платежного средства, на которое нужно сделать выплату.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Returns: null|\YooKassa\Model\Payout\AbstractPayoutDestination - Данные платежного средства, на которое нужно сделать выплату
public hasPayoutDestinationData() : bool
public hasPayoutDestinationData() : bool
Summary
Проверяет наличие данных платежного средства, на которое нужно сделать выплату.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Returns: bool - True если данные есть, false если нет
public setPayoutDestinationData() : self
public setPayoutDestinationData(null|\YooKassa\Model\Payout\AbstractPayoutDestination|array $payout_destination_data) : self
Summary
Устанавливает данные платежного средства, на которое нужно сделать выплату.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
null OR \YooKassa\Model\Payout\AbstractPayoutDestination OR array |
payout_destination_data | Данные платежного средства, на которое нужно сделать выплату |
Returns: self -
public getPayoutToken() : string|null
public getPayoutToken() : string|null
Summary
Возвращает токенизированные данные для выплаты.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Returns: string|null - Токенизированные данные для выплаты
public hasPayoutToken() : bool
public hasPayoutToken() : bool
Summary
Проверяет наличие токенизированных данных для выплаты.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Returns: bool - True если токен установлен, false если нет
public setPayoutToken() : self
public setPayoutToken(string|null $payout_token) : self
Summary
Устанавливает токенизированные данные для выплаты.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
payout_token | Токенизированные данные для выплаты |
Returns: self -
public getPaymentMethodId() : null|string
public getPaymentMethodId() : null|string
Summary
Возвращает идентификатор сохраненного способа оплаты.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Returns: null|string - Идентификатор сохраненного способа оплаты
public hasPaymentMethodId() : bool
public hasPaymentMethodId() : bool
Summary
Проверяет наличие идентификатора сохраненного способа оплаты.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Returns: bool - True если идентификатора установлен, false если нет
public setPaymentMethodId() : self
public setPaymentMethodId(null|string $payment_method_id) : self
Summary
Устанавливает идентификатор сохраненного способа оплаты.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
null OR string |
payment_method_id | Идентификатор сохраненного способа оплаты |
Returns: self -
public getDescription() : string|null
public getDescription() : string|null
Summary
Возвращает описание транзакции.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Returns: string|null - Описание транзакции
public hasDescription() : bool
public hasDescription() : bool
Summary
Проверяет наличие описания транзакции в создаваемой выплате.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Returns: bool - True если описание транзакции установлено, false если нет
public setDescription() : self
public setDescription(string|null $description) : self
Summary
Устанавливает описание транзакции.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
description | Описание транзакции |
Returns: self -
public getDeal() : null|\YooKassa\Model\Deal\PayoutDealInfo
public getDeal() : null|\YooKassa\Model\Deal\PayoutDealInfo
Summary
Возвращает сделку, в рамках которой нужно провести выплату.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Returns: null|\YooKassa\Model\Deal\PayoutDealInfo - Сделка, в рамках которой нужно провести выплату
public hasDeal() : bool
public hasDeal() : bool
Summary
Проверяет установлена ли сделка, в рамках которой нужно провести выплату.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Returns: bool - True если сделка установлена, false если нет
public setDeal() : self
public setDeal(null|array|\YooKassa\Model\Deal\PayoutDealInfo $deal) : self
Summary
Устанавливает сделку, в рамках которой нужно провести выплату.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
null OR array OR \YooKassa\Model\Deal\PayoutDealInfo |
deal | Сделка, в рамках которой нужно провести выплату |
Returns: self -
public getPersonalData() : \YooKassa\Request\Payouts\PayoutPersonalData[]|\YooKassa\Common\ListObjectInterface
public getPersonalData() : \YooKassa\Request\Payouts\PayoutPersonalData[]|\YooKassa\Common\ListObjectInterface
Summary
Возвращает персональные данные получателя выплаты.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Returns: \YooKassa\Request\Payouts\PayoutPersonalData[]|\YooKassa\Common\ListObjectInterface - Персональные данные получателя выплаты
public hasPersonalData() : bool
public hasPersonalData() : bool
Summary
Проверяет наличие персональных данных в создаваемой выплате.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Returns: bool - True если персональные данные есть, false если нет
public setPersonalData() : self
public setPersonalData(null|array|\YooKassa\Common\ListObjectInterface $personal_data = null) : self
Summary
Устанавливает персональные данные получателя выплаты.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
null OR array OR \YooKassa\Common\ListObjectInterface |
personal_data | Персональные данные получателя выплаты |
Returns: self -
public getMetadata() : \YooKassa\Model\Metadata|null
public getMetadata() : \YooKassa\Model\Metadata|null
Summary
Возвращает данные оплаты установленные мерчантом
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Returns: \YooKassa\Model\Metadata|null - Метаданные привязанные к выплате
public hasMetadata() : bool
public hasMetadata() : bool
Summary
Проверяет, были ли установлены метаданные заказа.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Returns: bool - True если метаданные были установлены, false если нет
public setMetadata() : self
public setMetadata(null|array|\YooKassa\Model\Metadata $metadata) : self
Summary
Устанавливает метаданные, привязанные к выплате.
Details:
- Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
null OR array OR \YooKassa\Model\Metadata |
metadata | Метаданные платежа, устанавливаемые мерчантом |
Returns: self -
Top Namespaces
Reports
This document was automatically generated from source code comments on 2026-06-29 using phpDocumentor
© 2026 YooMoney