meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.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

46 KiB
Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Namespace: \YooKassa\Request\Payments


Summary:

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


Examples

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



Constants

  • No constants found

Properties

Visibility Name Flag Summary
protected $amount Сумма
protected $currentObject Собираемый объект запроса
protected $deal Объект с информацией о сделке, в составе которой проходит платеж.
protected $fraud_data Объект с информацией о сделке, в составе которой проходит платеж.
protected $receipt Объект с информацией о чеке
protected $transfers Массив платежей в пользу разных мерчантов

Methods

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

Details


Properties

protected $amount : \YooKassa\Model\MonetaryAmount


Summary

Сумма

Type: MonetaryAmount

Details:

protected $currentObject : \YooKassa\Request\Payments\CreatePaymentRequest


Summary

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

Type: CreatePaymentRequest

Details:

protected $deal : \YooKassa\Model\Deal\PaymentDealInfo


Summary

Объект с информацией о сделке, в составе которой проходит платеж.

Type: PaymentDealInfo

Details:

protected $fraud_data : \YooKassa\Model\FraudData


Summary

Объект с информацией о сделке, в составе которой проходит платеж.

Type: FraudData

Details:

protected $receipt : \YooKassa\Model\Receipt


Summary

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

Type: Receipt

Details:

protected $transfers : \YooKassa\Model\TransferInterface[]


Summary

Массив платежей в пользу разных мерчантов

Type: TransferInterface[]

Details:


Methods

public __construct() : mixed

public __construct() : mixed

Summary

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

Details:

Returns: mixed -

public addReceiptItem() : self

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

Summary

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

Details:

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

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

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

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

public build(array|null $options = null) : \YooKassa\Request\Payments\CreatePaymentRequestInterface|\YooKassa\Common\AbstractPaymentRequest|\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\Payments\CreatePaymentRequestInterface|\YooKassa\Common\AbstractPaymentRequest|\YooKassa\Common\AbstractRequest - Инстанс объекта запроса

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

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

Summary

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

Details:

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

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

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

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

Summary

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

Details:

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

Returns: \YooKassa\Request\Payments\CreatePaymentRequestBuilder -

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 setCapture() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

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

Summary

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

Details:

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 $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

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

Details:

Parameters:
Type Name Description
string value IPv4 или IPv6-адрес покупателя
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданный аргумент не является строкой

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

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

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes OR string OR array OR null value Способ подтверждения платежа
array OR null options Настройки способа подтверждения платежа в виде массива
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданное значение не является объектом типа AbstractConfirmationAttributes или null

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

public setCurrency() : self

public setCurrency(string $value) : self

Summary

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

Details:

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

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

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

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

Summary

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

Details:

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

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

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

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

Summary

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

Details:

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

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

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

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\FraudData OR array OR null 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:

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

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

public setMerchantCustomerId() : mixed

public setMerchantCustomerId(string $value) : mixed

Summary

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

Details:

Parameters:
Type Name Description
string value Идентификатор покупателя в вашей системе, например электронная почта или номер телефона. Не более 200 символов
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданный аргумент не является строкой

Returns: mixed -

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

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

Summary

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

Details:

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

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

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 setPaymentMethodData() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\PaymentData\AbstractPaymentData OR string OR array OR null value Объект создания метода оплаты или null
array options Настройки способа оплаты в виде ассоциативного массива
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если был передан объект невалидного типа

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

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

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

Summary

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

Details:

Parameters:
Type Name Description
string value Идентификатор записи о сохраненных платежных данных покупателя
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Генерируется если переданные значение не является строкой или null

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

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

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

Summary

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

Details:

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

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

public setReceipt() : self

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\ReceiptInterface OR array value Инстанс чека или ассоциативный массив с данными чека
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Генерируется если было передано значение невалидного типа

Returns: self -

public setReceiptAdditionalUserProps() : self

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

Summary

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

Details:

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

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

public setReceiptEmail() : self

public setReceiptEmail(string $value) : self

Summary

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

Details:

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

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

public setReceiptIndustryDetails() : self

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

Summary

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

Details:

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

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

public setReceiptItems() : self

public setReceiptItems(array $value) : self

Summary

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

Details:

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[] $value) : self

Summary

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

Details:

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

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

public setReceiptPhone() : self

public setReceiptPhone(string $value) : self

Summary

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

Details:

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

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

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

public setRecipient(\YooKassa\Model\RecipientInterface|array $value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

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

Details:

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

Returns: \YooKassa\Request\Payments\CreatePaymentRequestBuilder -

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

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

Summary

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

Details:

Parameters:
Type Name Description
bool value Сохранить платежные данные для последующего использования
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Генерируется если переданный аргумент не кастится в bool

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

public setTaxSystemCode() : self

public setTaxSystemCode(int $value) : self

Summary

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

Details:

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

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

public setTransfers() : self

public setTransfers(\YooKassa\Model\TransferInterface[]|array|null $value) : self

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\TransferInterface[] OR array OR null value Массив трансферов

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

protected getConfirmationFactory() : \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesFactory

protected getConfirmationFactory() : \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesFactory

Summary

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

Details:

Returns: \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesFactory - Фабрика объектов методов подтверждения платежей

protected getPaymentDataFactory() : \YooKassa\Model\PaymentData\PaymentDataFactory

protected getPaymentDataFactory() : \YooKassa\Model\PaymentData\PaymentDataFactory

Summary

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

Details:

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

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

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

Summary

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

Details:

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


Top Namespaces


Reports


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

© 2023 YooMoney