yookassa-sdk-php/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md

YooKassa API SDK

Class: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

Namespace: \YooKassa\Request\Payouts

---

Summary:

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

---

Examples

Пример использования билдера

try {
    $builder = \YooKassa\Request\Payments\CreatePaymentRequest::builder();
    $builder->setAmount(100)
            ->setCurrency(\YooKassa\Model\CurrencyCode::RUB)
            ->setCapture(true)
            ->setDescription('Оплата заказа 112233')
            ->setMetadata(array(
                'cms_name'       => 'yoo_api_test',
                'order_id'       => '112233',
                'language'       => 'ru',
                'transaction_id' => '123-456-789',
            ));

    // Устанавливаем страницу для редиректа после оплаты
    $builder->setConfirmation(array(
        'type'      => \YooKassa\Model\ConfirmationType::REDIRECT,
        'returnUrl' => 'https://merchant-site.ru/payment-return-page',
    ));

    // Можем установить конкретный способ оплаты
    $builder->setPaymentMethodData(\YooKassa\Model\PaymentMethodType::BANK_CARD);

    // Составляем чек
    $builder->setReceiptEmail('john.doe@merchant.com');
    $builder->setReceiptPhone('71111111111');
    // Добавим товар
    $builder->addReceiptItem(
        'Платок Gucci',
        3000,
        1.0,
        2,
        'full_payment',
        'commodity'
    );
    // Добавим доставку
    $builder->addReceiptShipping(
        'Delivery/Shipping/Доставка',
        100,
        1,
        \YooKassa\Model\Receipt\PaymentMode::FULL_PAYMENT,
        \YooKassa\Model\Receipt\PaymentSubject::SERVICE
    );

    // Можно добавить распределение денег по магазинам
    $builder->setTransfers(array(
        array(
            'account_id' => 123456,
            'amount' => array(
                array(
                    'value' => 1000,
                    'currency' => \YooKassa\Model\CurrencyCode::RUB
                )
            ),
        ),
        array(
            'account_id' => 654321,
            'amount' => array(
                array(
                    'value' => 2000,
                    'currency' => \YooKassa\Model\CurrencyCode::RUB
                )
            ),
        )
    ));

    // Создаем объект запроса
    $request = $builder->build();

    // Можно изменить данные, если нужно
    $request->setDescription($request->getDescription() . ' - merchant comment');

    $idempotenceKey = uniqid('', true);
    $response = $client->createPayment($request, $idempotenceKey);
} catch (\Exception $e) {
    $response = $e;
}

var_dump($response);

---

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

• File: lib/Request/Payouts/CreatePayoutRequestBuilder.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractRequestBuilder
  • \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

---

Properties

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

---

Summary

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

Type: CreatePayoutRequest

Details:

---

Methods

public __construct() : mixed

public __construct() : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequestBuilder

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:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

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:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

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:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

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:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

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:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

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:

• Inherited From: \YooKassa\Common\AbstractRequestBuilder

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:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

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:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

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:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

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:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

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:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

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:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

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:

• Inherited From: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

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

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 1
• Deprecated - 43

---

This document was automatically generated from source code comments on 2025-07-08 using phpDocumentor

© 2025 YooMoney