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

17 KiB
Raw Permalink Blame History

YooKassa API SDK

Abstract Class: \YooKassa\Common\AbstractPaymentRequestBuilder

Namespace: \YooKassa\Common

Summary:

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

Constants

  • No constants found

Properties

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

Methods

Visibility Name Flag Summary
public __construct() Конструктор, инициализирует пустой запрос, который в будущем начнём собирать
public addReceiptItem() Добавляет в чек товар
public addReceiptShipping() Добавляет в чек доставку товара
public build() Строит запрос, валидирует его и возвращает, если все прошло нормально
public setAmount() Устанавливает сумму
public setCurrency() Устанавливает валюту в которой будет происходить подтверждение оплаты заказа
public setOptions() Устанавливает свойства запроса из массива
public setReceipt() Устанавливает чек
public setReceiptEmail() Устанавливает адрес электронной почты получателя чека
public setReceiptItems() Устанавлвиает список товаров для создания чека
public setReceiptPhone() Устанавливает телефон получателя чека
public setTaxSystemCode() Устанавливает код системы налогообложения.
public setTransfers() Устанавливает трансферы
protected initCurrentObject() Инициализирует пустой запрос

Details

Tags

Tag Version Description
since 1.0.18

Properties

protected $amount : \YooKassa\Model\MonetaryAmount

Summary

Сумма

Type: MonetaryAmount

Details:

protected $currentObject : \YooKassa\Common\AbstractRequest

Summary

Инстанс собираемого запроса

Type: AbstractRequest

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\Common\AbstractRequest

public build(array $options = null) : \YooKassa\Common\AbstractRequest

Summary

Строит запрос, валидирует его и возвращает, если все прошло нормально

Details:

Parameters:
Type Name Description
array options Массив свойств запроса, если нужно их установить перед сборкой

Returns: \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 setCurrency() : self

public setCurrency(string $value) : self

Summary

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

Details:

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

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

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 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 setReceiptEmail() : self

public setReceiptEmail(string $value) : self

Summary

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

Details:

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

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 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 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 initCurrentObject() : self

protected initCurrentObject() : self

Summary

Инициализирует пустой запрос

Details:

Returns: self -

Top Namespaces

Reports

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

© 2023 YooMoney