# [YooKassa API SDK](../home.md) # Interface: CreatePayoutRequestInterface ### Namespace: [\YooKassa\Request\Payouts](../namespaces/yookassa-request-payouts.md) --- **Summary:** Interface CreatePayoutRequestInterface --- ### Constants * No constants found --- ### Methods | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | | public | [getAmount()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getAmount) | | Возвращает сумму выплаты | | public | [getDeal()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getDeal) | | Возвращает сделку, в рамках которой нужно провести выплату | | public | [getDescription()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getDescription) | | Возвращает описание транзакции | | public | [getMetadata()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getMetadata) | | Возвращает данные оплаты установленные мерчантом | | public | [getPaymentMethodId()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getPaymentMethodId) | | Возвращает идентификатор сохраненного способа оплаты. | | public | [getPayoutDestinationData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getPayoutDestinationData) | | Возвращает данные платежного средства, на которое нужно сделать выплату | | public | [getPayoutToken()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getPayoutToken) | | Возвращает токенизированные данные для выплаты | | public | [getPersonalData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getPersonalData) | | Возвращает персональные данные получателя выплаты. | | public | [getReceiptData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getReceiptData) | | Возвращает данные для формирования чека в сервисе Мой налог. | | public | [getSelfEmployed()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_getSelfEmployed) | | Возвращает данные самозанятого, который получит выплату. | | public | [hasAmount()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasAmount) | | Проверяет наличие суммы в создаваемой выплате | | public | [hasDeal()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasDeal) | | Проверяет установлена ли сделка, в рамках которой нужно провести выплату | | public | [hasDescription()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasDescription) | | Проверяет наличие описания транзакции в создаваемой выплате | | public | [hasMetadata()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasMetadata) | | Проверяет, были ли установлены метаданные заказа | | public | [hasPaymentMethodId()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasPaymentMethodId) | | Проверяет наличие идентификатора сохраненного способа оплаты | | public | [hasPayoutDestinationData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasPayoutDestinationData) | | Проверяет наличие данных платежного средства, на которое нужно сделать выплату | | public | [hasPayoutToken()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasPayoutToken) | | Проверяет наличие токенизированных данных для выплаты | | public | [hasPersonalData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasPersonalData) | | Проверяет наличие персональных данных в создаваемой выплате | | public | [hasReceiptData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasReceiptData) | | Проверяет наличие данных для формирования чека в сервисе Мой налог. | | public | [hasSelfEmployed()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_hasSelfEmployed) | | Проверяет наличие данных самозанятого в создаваемой выплате | | public | [setAmount()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setAmount) | | Устанавливает сумму выплаты | | public | [setDeal()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setDeal) | | Устанавливает сделку, в рамках которой нужно провести выплату | | public | [setDescription()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setDescription) | | Устанавливает описание транзакции | | public | [setMetadata()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setMetadata) | | Устанавливает метаданные, привязанные к выплате | | public | [setPaymentMethodId()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setPaymentMethodId) | | Устанавливает идентификатор сохраненного способа оплаты. | | public | [setPayoutDestinationData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setPayoutDestinationData) | | Устанавливает данные платежного средства, на которое нужно сделать выплату | | public | [setPayoutToken()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setPayoutToken) | | Устанавливает токенизированные данные для выплаты | | public | [setPersonalData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setPersonalData) | | Устанавливает персональные данные получателя выплаты. | | public | [setReceiptData()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setReceiptData) | | Устанавливает данные для формирования чека в сервисе Мой налог. | | public | [setSelfEmployed()](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md#method_setSelfEmployed) | | Устанавливает данные самозанятого, который получит выплату. | --- ### Details * File: [lib/Request/Payouts/CreatePayoutRequestInterface.php](../../lib/Request/Payouts/CreatePayoutRequestInterface.php) * Package: \YooKassa --- ### Tags | Tag | Version | Description | | --- | ------- | ----------- | | property | | Сумма создаваемой выплаты | | property | | Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token. | | property | | Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token. | | property | | Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data | | property | | Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data | | property | | Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты | | property | | Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты | | property | | Сделка, в рамках которой нужно провести выплату. Необходимо передавать, если вы проводите Безопасную сделку | | property | | Описание транзакции (не более 128 символов). Например: «Выплата по договору N» | | property | | Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. | | property | | Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. | | property | | Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. | | property | | Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату [самозанятому](https://yookassa.ru/developers/payouts/scenario-extensions/self-employed). Только для обычных выплат. | | property | | Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с [проверкой получателя](/developers/payouts/scenario-extensions/recipient-check) (только для выплат через СБП). | | property | | Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с [проверкой получателя](/developers/payouts/scenario-extensions/recipient-check) (только для выплат через СБП). | | property | | Метаданные привязанные к выплате | --- ## Methods #### public getAmount() : \YooKassa\Model\AmountInterface|\YooKassa\Model\MonetaryAmount ```php public getAmount() : \YooKassa\Model\AmountInterface|\YooKassa\Model\MonetaryAmount ``` **Summary** Возвращает сумму выплаты **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** \YooKassa\Model\AmountInterface|\YooKassa\Model\MonetaryAmount - Сумма выплаты #### public hasAmount() : bool ```php public hasAmount() : bool ``` **Summary** Проверяет наличие суммы в создаваемой выплате **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** bool - True если сумма установлена, false если нет #### public setAmount() : mixed ```php public setAmount(\YooKassa\Model\AmountInterface|array $value) : mixed ``` **Summary** Устанавливает сумму выплаты **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | \YooKassa\Model\AmountInterface OR array | value | Сумма выплаты | **Returns:** mixed - #### public getPayoutDestinationData() : \YooKassa\Model\Payout\AbstractPayoutDestination|null ```php public getPayoutDestinationData() : \YooKassa\Model\Payout\AbstractPayoutDestination|null ``` **Summary** Возвращает данные платежного средства, на которое нужно сделать выплату **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** \YooKassa\Model\Payout\AbstractPayoutDestination|null - Данные платежного средства, на которое нужно сделать выплату #### public hasPayoutDestinationData() : bool ```php public hasPayoutDestinationData() : bool ``` **Summary** Проверяет наличие данных платежного средства, на которое нужно сделать выплату **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** bool - True если данные есть, false если нет #### public setPayoutDestinationData() : mixed ```php public setPayoutDestinationData(\YooKassa\Model\Payout\AbstractPayoutDestination|array|null $value) : mixed ``` **Summary** Устанавливает данные платежного средства, на которое нужно сделать выплату **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | \YooKassa\Model\Payout\AbstractPayoutDestination OR array OR null | value | Данные платежного средства, на которое нужно сделать выплату | **Returns:** mixed - #### public getPayoutToken() : string ```php public getPayoutToken() : string ``` **Summary** Возвращает токенизированные данные для выплаты **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** string - Токенизированные данные для выплаты #### public hasPayoutToken() : bool ```php public hasPayoutToken() : bool ``` **Summary** Проверяет наличие токенизированных данных для выплаты **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** bool - True если токен установлен, false если нет #### public setPayoutToken() : mixed ```php public setPayoutToken(string $value) : mixed ``` **Summary** Устанавливает токенизированные данные для выплаты **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string | value | Токенизированные данные для выплаты | **Returns:** mixed - #### public getPaymentMethodId() : string|null ```php public getPaymentMethodId() : string|null ``` **Summary** Возвращает идентификатор сохраненного способа оплаты. **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** string|null - Идентификатор сохраненного способа оплаты #### public hasPaymentMethodId() : bool ```php public hasPaymentMethodId() : bool ``` **Summary** Проверяет наличие идентификатора сохраненного способа оплаты **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** bool - True если идентификатора установлен, false если нет #### public setPaymentMethodId() : $this ```php public setPaymentMethodId(string|null $value = null) : $this ``` **Summary** Устанавливает идентификатор сохраненного способа оплаты. **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string OR null | value | Идентификатор сохраненного способа оплаты | **Returns:** $this - #### public getDescription() : string ```php public getDescription() : string ``` **Summary** Возвращает описание транзакции **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** string - Описание транзакции #### public hasDescription() : bool ```php public hasDescription() : bool ``` **Summary** Проверяет наличие описания транзакции в создаваемой выплате **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** bool - True если описание транзакции установлено, false если нет #### public setDescription() : mixed ```php public setDescription(string $value) : mixed ``` **Summary** Устанавливает описание транзакции **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string | value | Описание транзакции | **Returns:** mixed - #### public getDeal() : \YooKassa\Model\Deal\PayoutDealInfo|null ```php public getDeal() : \YooKassa\Model\Deal\PayoutDealInfo|null ``` **Summary** Возвращает сделку, в рамках которой нужно провести выплату **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** \YooKassa\Model\Deal\PayoutDealInfo|null - Сделка, в рамках которой нужно провести выплату #### public hasDeal() : bool ```php public hasDeal() : bool ``` **Summary** Проверяет установлена ли сделка, в рамках которой нужно провести выплату **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** bool - True если сделка установлена, false если нет #### public setDeal() : mixed ```php public setDeal(\YooKassa\Model\Deal\PayoutDealInfo|array|null $value) : mixed ``` **Summary** Устанавливает сделку, в рамках которой нужно провести выплату **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | \YooKassa\Model\Deal\PayoutDealInfo OR array OR null | value | Сделка, в рамках которой нужно провести выплату | **Returns:** mixed - #### public getSelfEmployed() : \YooKassa\Request\Payouts\PayoutSelfEmployedInfo|null ```php public getSelfEmployed() : \YooKassa\Request\Payouts\PayoutSelfEmployedInfo|null ``` **Summary** Возвращает данные самозанятого, который получит выплату. **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** \YooKassa\Request\Payouts\PayoutSelfEmployedInfo|null - Данные самозанятого, который получит выплату #### public hasSelfEmployed() : bool ```php public hasSelfEmployed() : bool ``` **Summary** Проверяет наличие данных самозанятого в создаваемой выплате **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** bool - True если данные самозанятого есть, false если нет #### public setSelfEmployed() : $this ```php public setSelfEmployed(\YooKassa\Request\Payouts\PayoutSelfEmployedInfo|array|null $value = null) : $this ``` **Summary** Устанавливает данные самозанятого, который получит выплату. **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | \YooKassa\Request\Payouts\PayoutSelfEmployedInfo OR array OR null | value | Данные самозанятого, который получит выплату | **Returns:** $this - #### public getReceiptData() : \YooKassa\Request\Payouts\IncomeReceiptData|null ```php public getReceiptData() : \YooKassa\Request\Payouts\IncomeReceiptData|null ``` **Summary** Возвращает данные для формирования чека в сервисе Мой налог. **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** \YooKassa\Request\Payouts\IncomeReceiptData|null - Данные для формирования чека в сервисе Мой налог #### public hasReceiptData() : bool ```php public hasReceiptData() : bool ``` **Summary** Проверяет наличие данных для формирования чека в сервисе Мой налог. **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** bool - True если данные для формирования чека есть, false если нет #### public setReceiptData() : $this ```php public setReceiptData(\YooKassa\Request\Payouts\IncomeReceiptData|array|null $value = null) : $this ``` **Summary** Устанавливает данные для формирования чека в сервисе Мой налог. **Description** . **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | \YooKassa\Request\Payouts\IncomeReceiptData OR array OR null | value | Данные для формирования чека в сервисе Мой налог. | **Returns:** $this - #### public getPersonalData() : \YooKassa\Request\Payouts\PayoutPersonalData[]|null ```php public getPersonalData() : \YooKassa\Request\Payouts\PayoutPersonalData[]|null ``` **Summary** Возвращает персональные данные получателя выплаты. **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** \YooKassa\Request\Payouts\PayoutPersonalData[]|null - Персональные данные получателя выплаты #### public hasPersonalData() : bool ```php public hasPersonalData() : bool ``` **Summary** Проверяет наличие персональных данных в создаваемой выплате **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** bool - True если персональные данные есть, false если нет #### public setPersonalData() : $this ```php public setPersonalData(\YooKassa\Request\Payouts\PayoutPersonalData[]|array|null $value = null) : $this ``` **Summary** Устанавливает персональные данные получателя выплаты. **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | \YooKassa\Request\Payouts\PayoutPersonalData[] OR array OR null | value | Персональные данные получателя выплаты | **Returns:** $this - #### public getMetadata() : \YooKassa\Model\Metadata ```php public getMetadata() : \YooKassa\Model\Metadata ``` **Summary** Возвращает данные оплаты установленные мерчантом **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** \YooKassa\Model\Metadata - Метаданные привязанные к выплате #### public hasMetadata() : bool ```php public hasMetadata() : bool ``` **Summary** Проверяет, были ли установлены метаданные заказа **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) **Returns:** bool - True если метаданные были установлены, false если нет #### public setMetadata() : mixed ```php public setMetadata(\YooKassa\Model\Metadata|array|null $value) : mixed ``` **Summary** Устанавливает метаданные, привязанные к выплате **Details:** * Inherited From: [\YooKassa\Request\Payouts\CreatePayoutRequestInterface](../classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | \YooKassa\Model\Metadata OR array OR null | value | Метаданные платежа, устанавливаемые мерчантом | **Returns:** mixed - --- ### Top Namespaces * [\YooKassa](../namespaces/yookassa.md) --- ### Reports * [Errors - 0](../reports/errors.md) * [Markers - 1](../reports/markers.md) * [Deprecated - 25](../reports/deprecated.md) --- This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney