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
release/v3.13.2
yookassa-sdk-php/docs/classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md
T

480 lines
18 KiB
Markdown
Raw Permalink Blame History

# [YooKassa API SDK](../home.md)
# Abstract Class: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder
### Namespace: [\YooKassa\Request\Payments](../namespaces/yookassa-request-payments.md)
---
**Summary:**
Класс, представляющий модель AbstractPaymentRequestBuilder.
**Description:**
Базовый класс билдера объекта платежного запроса, передаваемого в методы клиента API.
---
### Constants
* No constants found
---
### Properties
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| protected | [$amount](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md#property_amount) | | Сумма |
| protected | [$currentObject](../classes/YooKassa-Common-AbstractRequestBuilder.md#property_currentObject) | | Инстанс собираемого запроса. |
| protected | [$receipt](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md#property_receipt) | | Объект с информацией о чеке |
---
### Methods
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| public | [__construct()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method___construct) | | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать. |
| public | [addReceiptItem()](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md#method_addReceiptItem) | | Добавляет в чек товар |
| public | [addReceiptShipping()](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md#method_addReceiptShipping) | | Добавляет в чек доставку товара. |
| public | [addTransfer()](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md#method_addTransfer) | | Добавляет трансфер. |
| public | [build()](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md#method_build) | | Строит запрос, валидирует его и возвращает, если все прошло нормально. |
| public | [setAmount()](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md#method_setAmount) | | Устанавливает сумму. |
| public | [setCurrency()](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md#method_setCurrency) | | Устанавливает валюту в которой будет происходить подтверждение оплаты заказа. |
| public | [setOptions()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_setOptions) | | Устанавливает свойства запроса из массива. |
| public | [setReceipt()](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md#method_setReceipt) | | Устанавливает чек. |
| public | [setReceiptEmail()](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md#method_setReceiptEmail) | | Устанавливает адрес электронной почты получателя чека. |
| public | [setReceiptItems()](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md#method_setReceiptItems) | | Устанавливает список товаров для создания чека. |
| public | [setReceiptPhone()](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md#method_setReceiptPhone) | | Устанавливает телефон получателя чека. |
| public | [setTaxSystemCode()](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md#method_setTaxSystemCode) | | Устанавливает код системы налогообложения. |
| public | [setTransfers()](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md#method_setTransfers) | | Устанавливает трансферы. |
| protected | [initCurrentObject()](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md#method_initCurrentObject) | | Инициализирует пустой запрос |
---
### Details
* File: [lib/Request/Payments/AbstractPaymentRequestBuilder.php](../../lib/Request/Payments/AbstractPaymentRequestBuilder.php)
* Package: YooKassa\Request
* Class Hierarchy:
* [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md)
* \YooKassa\Request\Payments\AbstractPaymentRequestBuilder
* See Also:
* [](https://yookassa.ru/developers/api)
---
### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| category | | Class |
| author | | cms@yoomoney.ru |
---
## Properties
<a name="property_amount"></a>
#### protected $amount : ?\YooKassa\Model\MonetaryAmount
---
**Summary**
Сумма
**Type:** <a href="../?\YooKassa\Model\MonetaryAmount"><abbr title="?\YooKassa\Model\MonetaryAmount">MonetaryAmount</abbr></a>
**Details:**
<a name="property_currentObject"></a>
#### protected $currentObject : ?\YooKassa\Common\AbstractRequestInterface
---
**Summary**
Инстанс собираемого запроса.
**Type:** <a href="../?\YooKassa\Common\AbstractRequestInterface"><abbr title="?\YooKassa\Common\AbstractRequestInterface">AbstractRequestInterface</abbr></a>
**Details:**
* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md)
<a name="property_receipt"></a>
#### protected $receipt : ?\YooKassa\Model\Receipt\Receipt
---
**Summary**
Объект с информацией о чеке
**Type:** <a href="../?\YooKassa\Model\Receipt\Receipt"><abbr title="?\YooKassa\Model\Receipt\Receipt">Receipt</abbr></a>
**Details:**
---
## Methods
<a name="method___construct" class="anchor"></a>
#### public __construct() : mixed
```php
public __construct() : mixed
```
**Summary**
Конструктор, инициализирует пустой запрос, который в будущем начнём собирать.
**Details:**
* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md)
**Returns:** mixed -
<a name="method_addReceiptItem" class="anchor"></a>
#### public addReceiptItem() : self
```php
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](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md)
* See Also:
* [](\YooKassa\Request\Payments\PaymentSubject)
* [](\YooKassa\Request\Payments\PaymentMode)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">string</code> | title | Название или описание товара |
| <code lang="php">string</code> | price | Цена товара в валюте, заданной в заказе |
| <code lang="php">float</code> | quantity | Количество товара |
| <code lang="php">int</code> | vatCode | Ставка НДС |
| <code lang="php">null OR string</code> | paymentMode | значение перечисления PaymentMode |
| <code lang="php">null OR string</code> | paymentSubject | значение перечисления PaymentSubject |
| <code lang="php">null OR mixed</code> | productCode | |
| <code lang="php">null OR mixed</code> | countryOfOriginCode | |
| <code lang="php">null OR mixed</code> | customsDeclarationNumber | |
| <code lang="php">null OR mixed</code> | excise | |
**Returns:** self - Инстанс билдера запросов
<a name="method_addReceiptShipping" class="anchor"></a>
#### public addReceiptShipping() : self
```php
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](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md)
* See Also:
* [](\YooKassa\Request\Payments\PaymentSubject)
* [](\YooKassa\Request\Payments\PaymentMode)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">string</code> | title | Название доставки в чеке |
| <code lang="php">string</code> | price | Стоимость доставки |
| <code lang="php">int</code> | vatCode | Ставка НДС |
| <code lang="php">null OR string</code> | paymentMode | значение перечисления PaymentMode |
| <code lang="php">null OR string</code> | paymentSubject | значение перечисления PaymentSubject |
**Returns:** self - Инстанс билдера запросов
<a name="method_addTransfer" class="anchor"></a>
#### public addTransfer() : self
```php
public addTransfer(array|\YooKassa\Request\Payments\TransferDataInterface $value) : self
```
**Summary**
Добавляет трансфер.
**Details:**
* Inherited From: [\YooKassa\Request\Payments\AbstractPaymentRequestBuilder](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">array OR \YooKassa\Request\Payments\TransferDataInterface</code> | value | Трансфер |
**Returns:** self - Инстанс билдера запросов
<a name="method_build" class="anchor"></a>
#### public build() : \YooKassa\Common\AbstractRequestInterface
```php
public build(?array $options = null) : \YooKassa\Common\AbstractRequestInterface
```
**Summary**
Строит запрос, валидирует его и возвращает, если все прошло нормально.
**Details:**
* Inherited From: [\YooKassa\Request\Payments\AbstractPaymentRequestBuilder](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">?array</code> | options | Массив свойств запроса, если нужно их установить перед сборкой |
**Returns:** \YooKassa\Common\AbstractRequestInterface - Инстанс собранного запроса
<a name="method_setAmount" class="anchor"></a>
#### public setAmount() : self
```php
public setAmount(\YooKassa\Model\AmountInterface|array|\YooKassa\Request\Payments\numeric $value, string|null $currency = null) : self
```
**Summary**
Устанавливает сумму.
**Details:**
* Inherited From: [\YooKassa\Request\Payments\AbstractPaymentRequestBuilder](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">\YooKassa\Model\AmountInterface OR array OR \YooKassa\Request\Payments\numeric</code> | value | Сумма оплаты |
| <code lang="php">string OR null</code> | currency | Валюта |
**Returns:** self - Инстанс билдера запросов
<a name="method_setCurrency" class="anchor"></a>
#### public setCurrency() : self
```php
public setCurrency(string $value) : self
```
**Summary**
Устанавливает валюту в которой будет происходить подтверждение оплаты заказа.
**Details:**
* Inherited From: [\YooKassa\Request\Payments\AbstractPaymentRequestBuilder](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">string</code> | value | Валюта в которой подтверждается оплата |
**Returns:** self - Инстанс билдера запросов
<a name="method_setOptions" class="anchor"></a>
#### public setOptions() : \YooKassa\Common\AbstractRequestBuilder
```php
public setOptions(iterable|null $options) : \YooKassa\Common\AbstractRequestBuilder
```
**Summary**
Устанавливает свойства запроса из массива.
**Details:**
* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">iterable OR null</code> | options | Массив свойств запроса |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \InvalidArgumentException | Выбрасывается если аргумент не массив и не итерируемый объект |
| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданных в массиве настроек |
**Returns:** \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов
<a name="method_setReceipt" class="anchor"></a>
#### public setReceipt() : self
```php
public setReceipt(array|\YooKassa\Model\Receipt\ReceiptInterface $value) : self
```
**Summary**
Устанавливает чек.
**Details:**
* Inherited From: [\YooKassa\Request\Payments\AbstractPaymentRequestBuilder](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">array OR \YooKassa\Model\Receipt\ReceiptInterface</code> | value | Инстанс чека или ассоциативный массив с данными чека |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Генерируется если было передано значение невалидного типа |
**Returns:** self - Инстанс билдера запросов
<a name="method_setReceiptEmail" class="anchor"></a>
#### public setReceiptEmail() : self
```php
public setReceiptEmail(string|null $value) : self
```
**Summary**
Устанавливает адрес электронной почты получателя чека.
**Details:**
* Inherited From: [\YooKassa\Request\Payments\AbstractPaymentRequestBuilder](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">string OR null</code> | value | Email получателя чека |
**Returns:** self - Инстанс билдера запросов
<a name="method_setReceiptItems" class="anchor"></a>
#### public setReceiptItems() : self
```php
public setReceiptItems(array $value = []) : self
```
**Summary**
Устанавливает список товаров для создания чека.
**Details:**
* Inherited From: [\YooKassa\Request\Payments\AbstractPaymentRequestBuilder](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">array</code> | value | Массив товаров в заказе |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если хотя бы один из товаров имеет неверную структуру |
**Returns:** self - Инстанс билдера запросов
<a name="method_setReceiptPhone" class="anchor"></a>
#### public setReceiptPhone() : self
```php
public setReceiptPhone(string|null $value) : self
```
**Summary**
Устанавливает телефон получателя чека.
**Details:**
* Inherited From: [\YooKassa\Request\Payments\AbstractPaymentRequestBuilder](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">string OR null</code> | value | Телефон получателя чека |
**Returns:** self - Инстанс билдера запросов
<a name="method_setTaxSystemCode" class="anchor"></a>
#### public setTaxSystemCode() : self
```php
public setTaxSystemCode(int|null $value) : self
```
**Summary**
Устанавливает код системы налогообложения.
**Details:**
* Inherited From: [\YooKassa\Request\Payments\AbstractPaymentRequestBuilder](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">int OR null</code> | value | Код системы налогообложения. Число 1-6. |
**Returns:** self - Инстанс билдера запросов
<a name="method_setTransfers" class="anchor"></a>
#### public setTransfers() : self
```php
public setTransfers(array|\YooKassa\Request\Payments\TransferDataInterface[]|\YooKassa\Common\ListObjectInterface $value) : self
```
**Summary**
Устанавливает трансферы.
**Details:**
* Inherited From: [\YooKassa\Request\Payments\AbstractPaymentRequestBuilder](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">array OR \YooKassa\Request\Payments\TransferDataInterface[] OR \YooKassa\Common\ListObjectInterface</code> | value | Массив трансферов |
**Returns:** self - Инстанс билдера запросов
<a name="method_initCurrentObject" class="anchor"></a>
#### protected initCurrentObject() : \YooKassa\Common\AbstractRequestInterface|null
```php
protected initCurrentObject() : \YooKassa\Common\AbstractRequestInterface|null
```
**Summary**
Инициализирует пустой запрос
**Details:**
* Inherited From: [\YooKassa\Request\Payments\AbstractPaymentRequestBuilder](../classes/YooKassa-Request-Payments-AbstractPaymentRequestBuilder.md)
**Returns:** \YooKassa\Common\AbstractRequestInterface|null -
---
### Top Namespaces
* [\YooKassa](../namespaces/yookassa.md)
---
### Reports
* [Errors - 0](../reports/errors.md)
* [Markers - 0](../reports/markers.md)
* [Deprecated - 43](../reports/deprecated.md)
---
This document was automatically generated from source code comments on 2026-04-22 using [phpDocumentor](http://www.phpdoc.org/)
&copy; 2026 YooMoney
Reference in New Issue View Git Blame Copy Permalink