yookassa-sdk-php/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md

YooKassa API SDK

Class: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Namespace: \YooKassa\Request\Payments

---

Summary:

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

Description:

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

---

Examples

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

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

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

    // Можем установить конкретный способ оплаты
    $builder->setPaymentMethodData(\YooKassa\Model\Payment\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([
        [
            'account_id' => '1b68e7b15f3f',
            'amount' => [
                'value' => 1000,
                'currency' => \YooKassa\Model\CurrencyCode::RUB,
            ],
        ],
        [
            'account_id' => '0c37205b3208',
            'amount' => [
                '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	$amount		Сумма
protected	$currentObject		Собираемый объект запроса.
protected	$receipt		Объект с информацией о чеке

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		Конструктор, инициализирует пустой запрос, который в будущем начнём собирать.
public	addReceiptItem()		Добавляет в чек товар
public	addReceiptShipping()		Добавляет в чек доставку товара.
public	addStatement()		Добавляет данные для получения справки.
public	addTransfer()		Добавляет трансфер.
public	build()		Строит и возвращает объект запроса для отправки в API ЮKassa.
public	setAccountId()	deprecated	Устанавливает идентификатор магазина получателя платежа.
public	setAirline()		Устанавливает информацию об авиабилетах.
public	setAmount()		Устанавливает сумму.
public	setCapture()		Устанавливает флаг автоматического принятия поступившей оплаты.
public	setClientIp()		Устанавливает IP адрес покупателя.
public	setConfirmation()		Устанавливает способ подтверждения платежа.
public	setCurrency()		Устанавливает валюту в которой будет происходить подтверждение оплаты заказа.
public	setDeal()		Устанавливает сделку.
public	setDescription()		Устанавливает описание транзакции.
public	setFraudData()	deprecated	Устанавливает информацию для проверки операции на мошенничество.
public	setGatewayId()		Устанавливает идентификатор шлюза.
public	setMerchantCustomerId()		Устанавливает идентификатор покупателя в вашей системе.
public	setMetadata()		Устанавливает метаданные, привязанные к платежу.
public	setOptions()		Устанавливает свойства запроса из массива.
public	setPaymentMethodData()		Устанавливает объект с информацией для создания метода оплаты.
public	setPaymentMethodId()		Устанавливает идентификатор записи о сохранённых данных покупателя.
public	setPaymentOrder()		Устанавливает платежное поручение.
public	setPaymentToken()		Устанавливает одноразовый токен для проведения оплаты.
public	setPosLink()		Устанавливает данные о кассовой ссылке для проведения платежа в офлайне.
public	setReceipt()		Устанавливает чек.
public	setReceiptEmail()		Устанавливает адрес электронной почты получателя чека.
public	setReceiptIndustryDetails()		Устанавливает отраслевой реквизит чека.
public	setReceiptItems()		Устанавливает список товаров для создания чека.
public	setReceiptOperationalDetails()		Устанавливает отраслевой реквизит чека.
public	setReceiptPhone()		Устанавливает телефон получателя чека.
public	setReceiver()		Устанавливает реквизиты получателя оплаты.
public	setRecipient()		Устанавливает получателя платежа из объекта или ассоциативного массива.
public	setSavePaymentMethod()		Устанавливает флаг сохранения платёжных данных. Значение true инициирует создание многоразового payment_method.
public	setTaxSystemCode()		Устанавливает код системы налогообложения.
public	setTransfers()		Устанавливает трансферы.
protected	getPaymentDataFactory()		Возвращает фабрику методов проведения платежей.
protected	initCurrentObject()		Инициализирует объект запроса, который в дальнейшем будет собираться билдером

---

Details

• File: lib/Request/Payments/CreatePaymentRequestBuilder.php

• Package: YooKassa\Request

• Class Hierarchy:

  • \YooKassa\Common\AbstractRequestBuilder
  • \YooKassa\Request\Payments\AbstractPaymentRequestBuilder
  • \YooKassa\Request\Payments\CreatePaymentRequestBuilder

• See Also:

---

Tags

Tag	Version	Description
category		Class
author		cms@yoomoney.ru

---

Properties

protected $amount : ?\YooKassa\Model\MonetaryAmount

---

Summary

Сумма

Type: MonetaryAmount

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

protected $currentObject : ?\YooKassa\Common\AbstractRequestInterface

---

Summary

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

Type: AbstractRequestInterface

Details:

protected $receipt : ?\YooKassa\Model\Receipt\Receipt

---

Summary

Объект с информацией о чеке

Type: Receipt

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

---

Methods

public __construct() : mixed

public __construct() : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequestBuilder

Returns: mixed -

public addReceiptItem() : self

public addReceiptItem(string $title, string $price, float $quantity, int $vatCode, null|string $paymentMode = null, null|string $paymentSubject = null, null|mixed $productCode = null, null|mixed $countryOfOriginCode = null, null|mixed $customsDeclarationNumber = null, null|mixed $excise = null) : self

Summary

Добавляет в чек товар

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder
• See Also:

Parameters:

Type	Name	Description
string	title	Название или описание товара
string	price	Цена товара в валюте, заданной в заказе
float	quantity	Количество товара
int	vatCode	Ставка НДС
null OR string	paymentMode	значение перечисления PaymentMode
null OR string	paymentSubject	значение перечисления PaymentSubject
null OR mixed	productCode
null OR mixed	countryOfOriginCode
null OR mixed	customsDeclarationNumber
null OR mixed	excise

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

public addReceiptShipping() : self

public addReceiptShipping(string $title, string $price, int $vatCode, null|string $paymentMode = null, null|string $paymentSubject = null) : self

Summary

Добавляет в чек доставку товара.

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder
• See Also:

Parameters:

Type	Name	Description
string	title	Название доставки в чеке
string	price	Стоимость доставки
int	vatCode	Ставка НДС
null OR string	paymentMode	значение перечисления PaymentMode
null OR string	paymentSubject	значение перечисления PaymentSubject

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

public addStatement() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public addStatement(null|array|\YooKassa\Request\Payments\StatementData\AbstractStatement $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

Добавляет данные для получения справки.

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
null OR array OR \YooKassa\Request\Payments\StatementData\AbstractStatement	value	Данные для получения справки

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException

Returns: \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс билдера запросов

public addTransfer() : self

public addTransfer(array|\YooKassa\Request\Payments\TransferDataInterface $value) : self

Summary

Добавляет трансфер.

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
array OR \YooKassa\Request\Payments\TransferDataInterface	value	Трансфер

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

public build() : \YooKassa\Request\Payments\CreatePaymentRequestInterface|\YooKassa\Common\AbstractRequestInterface

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

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

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

(deprecated) - public setAccountId() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public setAccountId(string $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

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

Deprecated DeprecatedБольше не используется Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
string	value	Идентификатор магазина

Throws:

Type	Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException	Выбрасывается если было передано пустое значение
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если было передано не строковое значение
\Exception

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

public setAirline() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public setAirline(\YooKassa\Request\Payments\AirlineInterface|array|null $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

Устанавливает информацию об авиабилетах.

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
\YooKassa\Request\Payments\AirlineInterface OR array OR null	value	Объект данных длинной записи или ассоциативный массив с данными

Returns: \YooKassa\Request\Payments\CreatePaymentRequestBuilder -

public setAmount() : self

public setAmount(\YooKassa\Model\AmountInterface|array|\YooKassa\Request\Payments\numeric $value, string|null $currency = null) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
\YooKassa\Model\AmountInterface OR array OR \YooKassa\Request\Payments\numeric	value	Сумма оплаты
string OR null	currency	Валюта

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

public setCapture() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public setCapture(bool $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
bool	value	Автоматически принять поступившую оплату

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Генерируется если переданный аргумент не кастится в bool

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

public setClientIp() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public setClientIp(string|null $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

Устанавливает IP адрес покупателя.

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
string OR null	value	IPv4 или IPv6-адрес покупателя

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданный аргумент не является строкой

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

public setConfirmation() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public setConfirmation(null|\YooKassa\Request\Payments\ConfirmationAttributes\AbstractConfirmationAttributes|array|string $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

Устанавливает способ подтверждения платежа.

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
null OR \YooKassa\Request\Payments\ConfirmationAttributes\AbstractConfirmationAttributes OR array OR string	value	Способ подтверждения платежа

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданное значение не является объектом типа AbstractConfirmationAttributes или null

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

public setCurrency() : self

public setCurrency(string $value) : self

Summary

Устанавливает валюту в которой будет происходить подтверждение оплаты заказа.

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
string	value	Валюта в которой подтверждается оплата

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

public setDeal() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public setDeal(null|array|\YooKassa\Model\Deal\PaymentDealInfo $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

Устанавливает сделку.

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
null OR array OR \YooKassa\Model\Deal\PaymentDealInfo	value	Данные о сделке, в составе которой проходит платеж

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException

Returns: \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс билдера запросов

public setDescription() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public setDescription(string|null $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

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

Throws:

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

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

(deprecated) - public setFraudData() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public setFraudData(null|array|\YooKassa\Request\Payments\FraudData $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

Устанавливает информацию для проверки операции на мошенничество.

Deprecated DeprecatedБольше не поддерживается. Вместо него нужно использовать setReceiver() Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
null OR array OR \YooKassa\Request\Payments\FraudData	value	Информация для проверки операции на мошенничество

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException

Returns: \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс билдера запросов

public setGatewayId() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public setGatewayId(string $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

Устанавливает идентификатор шлюза.

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
string	value	Идентификатор шлюза

Throws:

Type	Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException	Выбрасывается если было передано пустое значение
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если было передано не строковое значение

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

public setMerchantCustomerId() : self

public setMerchantCustomerId(string|null $value) : self

Summary

Устанавливает идентификатор покупателя в вашей системе.

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
string OR null	value	Идентификатор покупателя в вашей системе, например электронная почта или номер телефона. Не более 200 символов

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданный аргумент не является строкой

Returns: self -

public setMetadata() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public setMetadata(null|array|\YooKassa\Model\Metadata $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданные данные не удалось интерпретировать как метаданные платежа

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

public setOptions() : \YooKassa\Common\AbstractRequestBuilder

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequestBuilder

Parameters:

Type	Name	Description
iterable OR null	options	Массив свойств запроса

Throws:

Type	Description
\InvalidArgumentException	Выбрасывается если аргумент не массив и не итерируемый объект
\YooKassa\Common\Exceptions\InvalidPropertyException	Выбрасывается если не удалось установить один из параметров, переданных в массиве настроек

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

public setPaymentMethodData() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public setPaymentMethodData(null|\YooKassa\Request\Payments\PaymentData\AbstractPaymentData|array|string $value, array|null $options = null) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
null OR \YooKassa\Request\Payments\PaymentData\AbstractPaymentData OR array OR string	value	Объект создания метода оплаты или null
array OR null	options	Настройки способа оплаты в виде ассоциативного массива

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если был передан объект невалидного типа

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

public setPaymentMethodId() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public setPaymentMethodId(string|null $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

Устанавливает идентификатор записи о сохранённых данных покупателя.

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
string OR null	value	Идентификатор записи о сохраненных платежных данных покупателя

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

public setPaymentOrder() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public setPaymentOrder(null|array|\YooKassa\Request\Payments\PaymentOrderData\AbstractPaymentOrder $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

Устанавливает платежное поручение.

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
null OR array OR \YooKassa\Request\Payments\PaymentOrderData\AbstractPaymentOrder	value	Платежное поручение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException

Returns: \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс билдера запросов

public setPaymentToken() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public setPaymentToken(string|null $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

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

Throws:

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

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

public setPosLink() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public setPosLink(\YooKassa\Model\PosLink\PosLinkPayment|array|null $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
\YooKassa\Model\PosLink\PosLinkPayment OR array OR null	value	Данные о кассовой ссылке

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

public setReceipt() : self

public setReceipt(array|\YooKassa\Model\Receipt\ReceiptInterface $value) : self

Summary

Устанавливает чек.

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
array OR \YooKassa\Model\Receipt\ReceiptInterface	value	Инстанс чека или ассоциативный массив с данными чека

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Генерируется если было передано значение невалидного типа

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

public setReceiptEmail() : self

public setReceiptEmail(string|null $value) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
string OR null	value	Email получателя чека

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

public setReceiptIndustryDetails() : self

public setReceiptIndustryDetails(array|\YooKassa\Model\Receipt\IndustryDetails[]|null $value) : self

Summary

Устанавливает отраслевой реквизит чека.

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
array OR \YooKassa\Model\Receipt\IndustryDetails[] OR null	value	Отраслевой реквизит чека

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

public setReceiptItems() : self

public setReceiptItems(array $value = []) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
array	value	Массив товаров в заказе

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если хотя бы один из товаров имеет неверную структуру

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

public setReceiptOperationalDetails() : self

public setReceiptOperationalDetails(array|\YooKassa\Model\Receipt\IndustryDetails[]|null $value) : self

Summary

Устанавливает отраслевой реквизит чека.

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
array OR \YooKassa\Model\Receipt\IndustryDetails[] OR null	value	Отраслевой реквизит чека

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

public setReceiptPhone() : self

public setReceiptPhone(string|null $value) : self

Summary

Устанавливает телефон получателя чека.

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
string OR null	value	Телефон получателя чека

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

public setReceiver() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public setReceiver(null|array|\YooKassa\Request\Payments\ReceiverData\AbstractReceiver $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
null OR array OR \YooKassa\Request\Payments\ReceiverData\AbstractReceiver	value	Реквизиты получателя оплаты при пополнении электронного кошелька, банковского счета или баланса телефона

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException

Returns: \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс билдера запросов

public setRecipient() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public setRecipient(array|\YooKassa\Request\Payments\Recipient|null $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

Устанавливает получателя платежа из объекта или ассоциативного массива.

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
array OR \YooKassa\Request\Payments\Recipient OR null	value	Получатель платежа

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если передан аргумент не валидного типа

Returns: \YooKassa\Request\Payments\CreatePaymentRequestBuilder -

public setSavePaymentMethod() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

public setSavePaymentMethod(bool|null $value = null) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

Устанавливает флаг сохранения платёжных данных. Значение true инициирует создание многоразового payment_method.

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Parameters:

Type	Name	Description
bool OR null	value	Сохранить платежные данные для последующего использования

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Генерируется если переданный аргумент не кастится в bool

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

public setTaxSystemCode() : self

public setTaxSystemCode(int|null $value) : self

Summary

Устанавливает код системы налогообложения.

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
int OR null	value	Код системы налогообложения. Число 1-6.

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

public setTransfers() : self

public setTransfers(array|\YooKassa\Request\Payments\TransferDataInterface[]|\YooKassa\Common\ListObjectInterface $value) : self

Summary

Устанавливает трансферы.

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
array OR \YooKassa\Request\Payments\TransferDataInterface[] OR \YooKassa\Common\ListObjectInterface	value	Массив трансферов

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

protected getPaymentDataFactory() : \YooKassa\Request\Payments\PaymentData\PaymentDataFactory

protected getPaymentDataFactory() : \YooKassa\Request\Payments\PaymentData\PaymentDataFactory

Summary

Возвращает фабрику методов проведения платежей.

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Returns: \YooKassa\Request\Payments\PaymentData\PaymentDataFactory - Фабрика методов проведения платежей

protected initCurrentObject() : \YooKassa\Request\Payments\CreatePaymentRequest

protected initCurrentObject() : \YooKassa\Request\Payments\CreatePaymentRequest

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

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

---

Top Namespaces

• \YooKassa

---

Reports

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

---

This document was automatically generated from source code comments on 2026-08-13 using phpDocumentor

© 2026 YooMoney