geckon01/yookassa-sdk-php
1
0
Fork 0
mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-08-30 20:17:36 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
3.8.1
yookassa-sdk-php/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequestBuilder.md
T
Антон Н. Николаев 27c2aef05a Добавлена поддержка кассовых ссылок в СБП
2025-07-01 14:52:30 +03:00

18 KiB
Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

Namespace: \YooKassa\Request\Payouts

Summary:

Класс, представляющий модель CreatePayoutRequestBuilder.

Description:

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

Examples

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

try {
    $payoutBuilder = \YooKassa\Request\Payouts\CreatePayoutRequest::builder();
    $payoutBuilder
        ->setAmount(new \YooKassa\Model\MonetaryAmount(80))
        ->setPayoutDestinationData(
            new \YooKassa\Request\Payouts\PayoutDestinationData\PayoutDestinationDataYooMoney(
                [
                    'type' => \YooKassa\Model\Payment\PaymentMethodType::YOO_MONEY,
                    'account_number' => '4100116075156746'
                ]
            )
        )
        ->setDeal(new \YooKassa\Model\Deal\PayoutDealInfo(['id' => 'dl-2909e77d-0022-5000-8000-0c37205b3208']))
        ->setDescription('Выплата по заказу №37')
    ;

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

    $idempotenceKey = uniqid('', true);
    $response = $client->createPayout($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

Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Properties

protected $currentObject : ?\YooKassa\Common\AbstractRequestInterface

Summary

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

Type: AbstractRequestInterface

Details:

Methods

public __construct() : mixed

public __construct() : mixed

Summary

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

Details:

Returns: mixed -

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

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

Summary

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

Details:

Parameters:
Type Name Description
null OR array options Массив параметров для установки в объект запроса

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

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() : \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

public setDeal(array|\YooKassa\Model\Deal\PayoutDealInfo $value) : \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

Summary

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

Details:

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

Returns: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder -

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

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

Summary

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

Details:

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

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

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

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

Summary

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

Details:

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

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

public setOptions() : \YooKassa\Common\AbstractRequestBuilder

public setOptions(iterable|null $options) : \YooKassa\Common\AbstractRequestBuilder

Summary

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

Details:

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

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

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

public setPaymentMethodId(null|string $value) : \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

Summary

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

Details:

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

Returns: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder -

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

public setPayoutDestinationData(null|\YooKassa\Model\Payout\AbstractPayoutDestination|array $value) : \YooKassa\Request\Payouts\CreatePayoutRequestBuilder

Summary

Устанавливает объект с информацией для создания метода оплаты.

Details:

Parameters:
Type Name Description
null OR \YooKassa\Model\Payout\AbstractPayoutDestination OR array value Объект создания метода оплаты или null

Returns: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder -

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

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

Summary

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

Details:

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

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

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

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

Summary

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

Details:

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

Returns: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder -

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

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

Summary

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

Details:

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

Returns: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder -

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

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

Summary

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

Details:

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

Returns: \YooKassa\Request\Payouts\CreatePayoutRequestBuilder -

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 2025-07-01 using phpDocumentor

© 2025 YooMoney

Reference in New Issue View Git Blame Copy Permalink