keboss/meraproject
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
main
meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md
keboss-m 5c21d25d45 Initial commit: Merakomis portal, Docker stack and user-reader API. 
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-06-24 11:04:05 +03:00

29 KiB
Raw Permalink Blame History

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 getReceiptData() Возвращает данные для формирования чека в сервисе Мой налог.
public getSelfEmployed() Возвращает данные самозанятого, который получит выплату.
public hasAmount() Проверяет наличие суммы в создаваемой выплате
public hasDeal() Проверяет установлена ли сделка, в рамках которой нужно провести выплату
public hasDescription() Проверяет наличие описания транзакции в создаваемой выплате
public hasMetadata() Проверяет, были ли установлены метаданные заказа
public hasPaymentMethodId() Проверяет наличие идентификатора сохраненного способа оплаты
public hasPayoutDestinationData() Проверяет наличие данных платежного средства, на которое нужно сделать выплату
public hasPayoutToken() Проверяет наличие токенизированных данных для выплаты
public hasPersonalData() Проверяет наличие персональных данных в создаваемой выплате
public hasReceiptData() Проверяет наличие данных для формирования чека в сервисе Мой налог.
public hasSelfEmployed() Проверяет наличие данных самозанятого в создаваемой выплате
public setAmount() Устанавливает сумму выплаты
public setDeal() Устанавливает сделку, в рамках которой нужно провести выплату
public setDescription() Устанавливает описание транзакции
public setMetadata() Устанавливает метаданные, привязанные к выплате
public setPaymentMethodId() Устанавливает идентификатор сохраненного способа оплаты.
public setPayoutDestinationData() Устанавливает данные платежного средства, на которое нужно сделать выплату
public setPayoutToken() Устанавливает токенизированные данные для выплаты
public setPersonalData() Устанавливает персональные данные получателя выплаты.
public setReceiptData() Устанавливает данные для формирования чека в сервисе Мой налог.
public setSelfEmployed() Устанавливает данные самозанятого, который получит выплату.

Details

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 Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату самозанятому. Только для обычных выплат.
property Данные самозанятого, который получит выплату. Необходимо передавать, если вы делаете выплату самозанятому. Только для обычных выплат.
property Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату самозанятому. Только для обычных выплат.
property Данные для формирования чека в сервисе Мой налог. Необходимо передавать, если вы делаете выплату самозанятому. Только для обычных выплат.
property Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с проверкой получателя (только для выплат через СБП).
property Персональные данные получателя выплаты. Необходимо передавать, если вы делаете выплаты с проверкой получателя (только для выплат через СБП).
property Метаданные привязанные к выплате

Methods

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

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

Summary

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

Details:

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

public hasAmount() : bool

public hasAmount() : bool

Summary

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

Details:

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

public setAmount() : mixed

public setAmount(\YooKassa\Model\AmountInterface|array $value) : mixed

Summary

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

Details:

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

Returns: mixed -

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

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

Summary

Возвращает данные платежного средства, на которое нужно сделать выплату

Details:

Returns: \YooKassa\Model\Payout\AbstractPayoutDestination|null - Данные платежного средства, на которое нужно сделать выплату

public hasPayoutDestinationData() : bool

public hasPayoutDestinationData() : bool

Summary

Проверяет наличие данных платежного средства, на которое нужно сделать выплату

Details:

Returns: bool - True если данные есть, false если нет

public setPayoutDestinationData() : mixed

public setPayoutDestinationData(\YooKassa\Model\Payout\AbstractPayoutDestination|array|null $value) : mixed

Summary

Устанавливает данные платежного средства, на которое нужно сделать выплату

Details:

Parameters:
Type Name Description
\YooKassa\Model\Payout\AbstractPayoutDestination OR array OR null value Данные платежного средства, на которое нужно сделать выплату

Returns: mixed -

public getPayoutToken() : string

public getPayoutToken() : string

Summary

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

Details:

Returns: string - Токенизированные данные для выплаты

public hasPayoutToken() : bool

public hasPayoutToken() : bool

Summary

Проверяет наличие токенизированных данных для выплаты

Details:

Returns: bool - True если токен установлен, false если нет

public setPayoutToken() : mixed

public setPayoutToken(string $value) : mixed

Summary

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

Details:

Parameters:
Type Name Description
string value Токенизированные данные для выплаты

Returns: mixed -

public getPaymentMethodId() : string|null

public getPaymentMethodId() : string|null

Summary

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

Details:

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

public hasPaymentMethodId() : bool

public hasPaymentMethodId() : bool

Summary

Проверяет наличие идентификатора сохраненного способа оплаты

Details:

Returns: bool - True если идентификатора установлен, false если нет

public setPaymentMethodId() : $this

public setPaymentMethodId(string|null $value = null) : $this

Summary

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

Details:

Parameters:
Type Name Description
string OR null value Идентификатор сохраненного способа оплаты

Returns: $this -

public getDescription() : string

public getDescription() : string

Summary

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

Details:

Returns: string - Описание транзакции

public hasDescription() : bool

public hasDescription() : bool

Summary

Проверяет наличие описания транзакции в создаваемой выплате

Details:

Returns: bool - True если описание транзакции установлено, false если нет

public setDescription() : mixed

public setDescription(string $value) : mixed

Summary

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

Details:

Parameters:
Type Name Description
string value Описание транзакции

Returns: mixed -

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

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

Summary

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

Details:

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

public hasDeal() : bool

public hasDeal() : bool

Summary

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

Details:

Returns: bool - True если сделка установлена, false если нет

public setDeal() : mixed

public setDeal(\YooKassa\Model\Deal\PayoutDealInfo|array|null $value) : mixed

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\Deal\PayoutDealInfo OR array OR null value Сделка, в рамках которой нужно провести выплату

Returns: mixed -

public getSelfEmployed() : \YooKassa\Request\Payouts\PayoutSelfEmployedInfo|null

public getSelfEmployed() : \YooKassa\Request\Payouts\PayoutSelfEmployedInfo|null

Summary

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

Details:

Returns: \YooKassa\Request\Payouts\PayoutSelfEmployedInfo|null - Данные самозанятого, который получит выплату

public hasSelfEmployed() : bool

public hasSelfEmployed() : bool

Summary

Проверяет наличие данных самозанятого в создаваемой выплате

Details:

Returns: bool - True если данные самозанятого есть, false если нет

public setSelfEmployed() : $this

public setSelfEmployed(\YooKassa\Request\Payouts\PayoutSelfEmployedInfo|array|null $value = null) : $this

Summary

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

Details:

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

Returns: $this -

public getReceiptData() : \YooKassa\Request\Payouts\IncomeReceiptData|null

public getReceiptData() : \YooKassa\Request\Payouts\IncomeReceiptData|null

Summary

Возвращает данные для формирования чека в сервисе Мой налог.

Details:

Returns: \YooKassa\Request\Payouts\IncomeReceiptData|null - Данные для формирования чека в сервисе Мой налог

public hasReceiptData() : bool

public hasReceiptData() : bool

Summary

Проверяет наличие данных для формирования чека в сервисе Мой налог.

Details:

Returns: bool - True если данные для формирования чека есть, false если нет

public setReceiptData() : $this

public setReceiptData(\YooKassa\Request\Payouts\IncomeReceiptData|array|null $value = null) : $this

Summary

Устанавливает данные для формирования чека в сервисе Мой налог.

Description

.

Details:

Parameters:
Type Name Description
\YooKassa\Request\Payouts\IncomeReceiptData OR array OR null value Данные для формирования чека в сервисе Мой налог.

Returns: $this -

public getPersonalData() : \YooKassa\Request\Payouts\PayoutPersonalData[]|null

public getPersonalData() : \YooKassa\Request\Payouts\PayoutPersonalData[]|null

Summary

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

Details:

Returns: \YooKassa\Request\Payouts\PayoutPersonalData[]|null - Персональные данные получателя выплаты

public hasPersonalData() : bool

public hasPersonalData() : bool

Summary

Проверяет наличие персональных данных в создаваемой выплате

Details:

Returns: bool - True если персональные данные есть, false если нет

public setPersonalData() : $this

public setPersonalData(\YooKassa\Request\Payouts\PayoutPersonalData[]|array|null $value = null) : $this

Summary

Устанавливает персональные данные получателя выплаты.

Details:

Parameters:
Type Name Description
\YooKassa\Request\Payouts\PayoutPersonalData[] OR array OR null value Персональные данные получателя выплаты

Returns: $this -

public getMetadata() : \YooKassa\Model\Metadata

public getMetadata() : \YooKassa\Model\Metadata

Summary

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

Details:

Returns: \YooKassa\Model\Metadata - Метаданные привязанные к выплате

public hasMetadata() : bool

public hasMetadata() : bool

Summary

Проверяет, были ли установлены метаданные заказа

Details:

Returns: bool - True если метаданные были установлены, false если нет

public setMetadata() : mixed

public setMetadata(\YooKassa\Model\Metadata|array|null $value) : mixed

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\Metadata OR array OR null value Метаданные платежа, устанавливаемые мерчантом

Returns: mixed -

Top Namespaces

Reports

This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor

© 2023 YooMoney