keboss/meraproject
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
5c21d25d45
meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.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

18 KiB
Raw Blame History

YooKassa API SDK

Class: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

Namespace: \YooKassa\Request\Payouts

Summary:

Класс билдера объектов запросов к API на создание платежа

Examples

02-builder.php 11 78 Пример использования билдера

Constants

  • No constants found

Properties

Visibility Name Flag Summary
protected $currentObject Собираемый объект запроса

Methods

Visibility Name Flag Summary
public __construct() Конструктор, инициализирует пустой запрос, который в будущем начнём собирать
public build() Строит и возвращает объект запроса для отправки в API ЮKassa
public setAmount() Устанавливает сумму
public setDeal() Устанавливает сделку, в рамках которой нужно провести выплату
public setDescription() Устанавливает описание транзакции
public setMetadata() Устанавливает метаданные, привязанные к платежу
public setOptions() Устанавливает свойства запроса из массива
public setPaymentMethodId() Устанавливает идентификатор сохраненного способа оплаты.
public setPayoutDestinationData() Устанавливает объект с информацией для создания метода оплаты
public setPayoutToken() Устанавливает одноразовый токен для проведения выплаты
public setPersonalData() Устанавливает персональные данные получателя выплаты.
public setReceiptData() Устанавливает данные для формирования чека в сервисе Мой налог.
public setSelfEmployed() Устанавливает данные самозанятого, который получит выплату.
protected initCurrentObject() Инициализирует объект запроса, который в дальнейшем будет собираться билдером

Details

Properties

protected $currentObject : \YooKassa\Request\Payouts\CreatePayoutRequest

Summary

Собираемый объект запроса

Type: CreatePayoutRequest

Details:

Methods

public __construct() : mixed

public __construct() : mixed

Summary

Конструктор, инициализирует пустой запрос, который в будущем начнём собирать

Details:

Returns: mixed -

public build() : \YooKassa\Request\Payouts\CreatePayoutRequestInterface|\YooKassa\Request\Payouts\CreatePayoutRequest|\YooKassa\Common\AbstractRequest

public build(array|null $options = null) : \YooKassa\Request\Payouts\CreatePayoutRequestInterface|\YooKassa\Request\Payouts\CreatePayoutRequest|\YooKassa\Common\AbstractRequest

Summary

Строит и возвращает объект запроса для отправки в API ЮKassa

Details:

Parameters:
Type Name Description
array OR null options Массив параметров для установки в объект запроса
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidRequestException Выбрасывается если собрать объект запроса не удалось

Returns: \YooKassa\Request\Payouts\CreatePayoutRequestInterface|\YooKassa\Request\Payouts\CreatePayoutRequest|\YooKassa\Common\AbstractRequest - Инстанс объекта запроса

public setAmount() : self

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

Summary

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

Details:

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

Returns: self - Инстанс билдера запросов

public setDeal() : mixed

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\Deal\PayoutDealInfo OR array value Сделка, в рамках которой нужно провести выплату
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если был передан объект невалидного типа

Returns: mixed -

public setDescription() : \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

public setDescription(string $value) : \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

Summary

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

Details:

Parameters:
Type Name Description
string value Описание транзакции
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException Выбрасывается если переданное значение превышает допустимую длину
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданное значение не является строкой

Returns: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder - Инстанс текущего билдера

public setMetadata() : \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

public setMetadata(\YooKassa\Model\Metadata|array|null $value) : \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\Metadata OR array OR null value Метаданные платежа, устанавливаемые мерчантом
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданные данные не удалось интерпретировать как метаданные платежа

Returns: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder - Инстанс текущего билдера

public setOptions() : \YooKassa\Common\AbstractRequestBuilder

public setOptions(array|\Traversable $options) : \YooKassa\Common\AbstractRequestBuilder

Summary

Устанавливает свойства запроса из массива

Details:

Parameters:
Type Name Description
array OR \Traversable options Массив свойств запроса
Throws:
Type Description
\InvalidArgumentException Выбрасывается если аргумент не массив и не итерируемый объект
\YooKassa\Common\Exceptions\InvalidPropertyException Выбрасывается если не удалось установить один из параметров, переданныч в массиве настроек

Returns: \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов

public setPaymentMethodId() : mixed

public setPaymentMethodId(string|null $value) : mixed

Summary

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

Details:

Parameters:
Type Name Description
string OR null value Идентификатор сохраненного способа оплаты
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если был передан объект невалидного типа

Returns: mixed -

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 Объект создания метода оплаты или null
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если был передан объект невалидного типа

Returns: mixed -

public setPayoutToken() : \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

public setPayoutToken(string $value) : \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

Summary

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

Details:

Parameters:
Type Name Description
string value Одноразовый токен для проведения выплаты
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданное значение не является строкой

Returns: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder - Инстанс текущего билдера

public setPersonalData() : mixed

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Request\Payouts\PayoutPersonalData[] OR array OR null value Персональные данные получателя выплаты
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если был передан объект невалидного типа

Returns: mixed -

public setReceiptData() : mixed

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Request\Payouts\IncomeReceiptData OR array OR null value Данные для формирования чека в сервисе Мой налог
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если был передан объект невалидного типа

Returns: mixed -

public setSelfEmployed() : mixed

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

Summary

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

Details:

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

Returns: mixed -

protected initCurrentObject() : \YooKassa\Request\Payouts\CreatePayoutRequest

protected initCurrentObject() : \YooKassa\Request\Payouts\CreatePayoutRequest

Summary

Инициализирует объект запроса, который в дальнейшем будет собираться билдером

Details:

Returns: \YooKassa\Request\Payouts\CreatePayoutRequest - Инстанс собираемого объекта запроса к API

Top Namespaces

Reports

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

© 2023 YooMoney