meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Common-AbstractPaymentRequest.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

651 lines
20 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# [YooKassa API SDK](../home.md)
# Class: \YooKassa\Common\AbstractPaymentRequest
### Namespace: [\YooKassa\Common](../namespaces/yookassa-common.md)
---
**Summary:**
Класс объекта запроса к API
---
### Constants
* No constants found
---
### Properties
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| public | [$amount](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_amount) | | Сумма |
| public | [$receipt](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_receipt) | | Данные фискального чека 54-ФЗ |
| public | [$transfers](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_transfers) | | Данные о распределении платежа между магазинами |
---
### Methods
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. |
| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства |
| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства |
| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства |
| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство |
| public | [clearValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_clearValidationError) | | Очищает статус валидации текущего запроса |
| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива |
| public | [getAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_getAmount) | | Возвращает сумму оплаты |
| public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации |
| public | [getReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_getReceipt) | | Возвращает чек, если он есть |
| public | [getTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_getTransfers) | | Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести. |
| public | [hasAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasAmount) | | Проверяет, была ли установлена сумма оплаты |
| public | [hasReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasReceipt) | | Проверяет наличие чека |
| public | [hasTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasTransfers) | | Проверяет наличие данных о распределении денег |
| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | |
| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | |
| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | |
| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | |
| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | |
| public | [removeReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_removeReceipt) | | Удаляет чек из запроса |
| public | [setAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setAmount) | | Устанавливает сумму оплаты |
| public | [setReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setReceipt) | | Устанавливает чек |
| public | [setTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setTransfers) | | Устанавливает transfers (массив распределения денег между магазинами) |
| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() |
| public | [validate()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_validate) | | Валидирует объект запроса |
| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта |
| protected | [setValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_setValidationError) | | Устанавливает ошибку валидации |
---
### Details
* File: [lib/Common/AbstractPaymentRequest.php](../../lib/Common/AbstractPaymentRequest.php)
* Package: YooKassa
* Class Hierarchy:
* [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
* [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md)
* \YooKassa\Common\AbstractPaymentRequest
---
### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| since | 1.0.18 | |
---
## Properties
<a name="property_amount"></a>
#### public $amount : \YooKassa\Model\AmountInterface
---
***Description***
Сумма
**Type:** <a href="classes/YooKassa-Model-AmountInterface.html"><abbr title="\YooKassa\Model\AmountInterface">AmountInterface</abbr></a>
**Details:**
<a name="property_receipt"></a>
#### public $receipt : \YooKassa\Model\ReceiptInterface
---
***Description***
Данные фискального чека 54-ФЗ
**Type:** <a href="classes/YooKassa-Model-ReceiptInterface.html"><abbr title="\YooKassa\Model\ReceiptInterface">ReceiptInterface</abbr></a>
**Details:**
<a name="property_transfers"></a>
#### public $transfers : \YooKassa\Model\TransferInterface[]
---
***Description***
Данные о распределении платежа между магазинами
**Type:** <a href="\YooKassa\Model\TransferInterface[]"><abbr title="\YooKassa\Model\TransferInterface[]">TransferInterface[]</abbr></a>
**Details:**
---
## Methods
<a name="method___construct" class="anchor"></a>
#### public __construct() : mixed
```php
public __construct(array $data = array()) : mixed
```
**Summary**
AbstractObject constructor.
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">array</code> | data | |
**Returns:** mixed -
<a name="method___get" class="anchor"></a>
#### public __get() : mixed
```php
public __get(string $propertyName) : mixed
```
**Summary**
Возвращает значение свойства
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">string</code> | propertyName | Имя свойства |
**Returns:** mixed - Значение свойства
<a name="method___isset" class="anchor"></a>
#### public __isset() : bool
```php
public __isset(string $propertyName) : bool
```
**Summary**
Проверяет наличие свойства
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">string</code> | propertyName | Имя проверяемого свойства |
**Returns:** bool - True если свойство имеется, false если нет
<a name="method___set" class="anchor"></a>
#### public __set() : mixed
```php
public __set(string $propertyName, mixed $value) : mixed
```
**Summary**
Устанавливает значение свойства
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">string</code> | propertyName | Имя свойства |
| <code lang="php">mixed</code> | value | Значение свойства |
**Returns:** mixed -
<a name="method___unset" class="anchor"></a>
#### public __unset() : mixed
```php
public __unset(string $propertyName) : mixed
```
**Summary**
Удаляет свойство
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">string</code> | propertyName | Имя удаляемого свойства |
**Returns:** mixed -
<a name="method_clearValidationError" class="anchor"></a>
#### public clearValidationError() : mixed
```php
public clearValidationError() : mixed
```
**Summary**
Очищает статус валидации текущего запроса
**Details:**
* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md)
**Returns:** mixed -
<a name="method_fromArray" class="anchor"></a>
#### public fromArray() : mixed
```php
public fromArray(array|\Traversable $sourceArray) : mixed
```
**Summary**
Устанавливает значения свойств текущего объекта из массива
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">array OR \Traversable</code> | sourceArray | Ассоциативный массив с настройками |
**Returns:** mixed -
<a name="method_getAmount" class="anchor"></a>
#### public getAmount() : \YooKassa\Model\AmountInterface
```php
public getAmount() : \YooKassa\Model\AmountInterface
```
**Summary**
Возвращает сумму оплаты
**Details:**
* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md)
**Returns:** \YooKassa\Model\AmountInterface - Сумма оплаты
<a name="method_getLastValidationError" class="anchor"></a>
#### public getLastValidationError() : string
```php
public getLastValidationError() : string
```
**Summary**
Возвращает последнюю ошибку валидации
**Details:**
* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md)
**Returns:** string - Последняя произошедшая ошибка валидации
<a name="method_getReceipt" class="anchor"></a>
#### public getReceipt() : \YooKassa\Model\ReceiptInterface|null
```php
public getReceipt() : \YooKassa\Model\ReceiptInterface|null
```
**Summary**
Возвращает чек, если он есть
**Details:**
* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md)
**Returns:** \YooKassa\Model\ReceiptInterface|null - Данные фискального чека 54-ФЗ или null, если чека нет
<a name="method_getTransfers" class="anchor"></a>
#### public getTransfers() : \YooKassa\Model\TransferInterface[]
```php
public getTransfers() : \YooKassa\Model\TransferInterface[]
```
**Summary**
Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести.
**Description**
Присутствует, если вы используете решение ЮKassa для платформ.
(https://yookassa.ru/developers/special-solutions/checkout-for-platforms/basics)
**Details:**
* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md)
**Returns:** \YooKassa\Model\TransferInterface[] - Данные о распределении денег
<a name="method_hasAmount" class="anchor"></a>
#### public hasAmount() : bool
```php
public hasAmount() : bool
```
**Summary**
Проверяет, была ли установлена сумма оплаты
**Details:**
* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md)
**Returns:** bool - True если сумма оплаты была установлена, false если нет
<a name="method_hasReceipt" class="anchor"></a>
#### public hasReceipt() : bool
```php
public hasReceipt() : bool
```
**Summary**
Проверяет наличие чека
**Details:**
* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md)
**Returns:** bool - True если чек есть, false если нет
<a name="method_hasTransfers" class="anchor"></a>
#### public hasTransfers() : bool
```php
public hasTransfers() : bool
```
**Summary**
Проверяет наличие данных о распределении денег
**Details:**
* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md)
**Returns:** bool -
<a name="method_jsonSerialize" class="anchor"></a>
#### public jsonSerialize() : mixed
```php
public jsonSerialize() : mixed
```
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
**Returns:** mixed -
<a name="method_offsetExists" class="anchor"></a>
#### public offsetExists() : mixed
```php
public offsetExists(mixed $offset) : mixed
```
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">mixed</code> | offset | |
**Returns:** mixed -
<a name="method_offsetGet" class="anchor"></a>
#### public offsetGet() : mixed
```php
public offsetGet(mixed $offset) : mixed
```
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">mixed</code> | offset | |
**Returns:** mixed -
<a name="method_offsetSet" class="anchor"></a>
#### public offsetSet() : mixed
```php
public offsetSet(mixed $offset, mixed $value) : mixed
```
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">mixed</code> | offset | |
| <code lang="php">mixed</code> | value | |
**Returns:** mixed -
<a name="method_offsetUnset" class="anchor"></a>
#### public offsetUnset() : mixed
```php
public offsetUnset(mixed $offset) : mixed
```
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">mixed</code> | offset | |
**Returns:** mixed -
<a name="method_removeReceipt" class="anchor"></a>
#### public removeReceipt() : mixed
```php
public removeReceipt() : mixed
```
**Summary**
Удаляет чек из запроса
**Details:**
* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md)
**Returns:** mixed -
<a name="method_setAmount" class="anchor"></a>
#### public setAmount() : mixed
```php
public setAmount(\YooKassa\Model\AmountInterface $value) : mixed
```
**Summary**
Устанавливает сумму оплаты
**Details:**
* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">\YooKassa\Model\AmountInterface</code> | value | Сумма оплаты |
**Returns:** mixed -
<a name="method_setReceipt" class="anchor"></a>
#### public setReceipt() : mixed
```php
public setReceipt(\YooKassa\Model\ReceiptInterface|null $value) : mixed
```
**Summary**
Устанавливает чек
**Details:**
* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">\YooKassa\Model\ReceiptInterface OR null</code> | value | Инстанс чека или null для удаления информации о чеке |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если передан не инстанс класса чека и не null |
**Returns:** mixed -
<a name="method_setTransfers" class="anchor"></a>
#### public setTransfers() : mixed
```php
public setTransfers(\YooKassa\Model\TransferInterface[]|array|null $value) : mixed
```
**Summary**
Устанавливает transfers (массив распределения денег между магазинами)
**Details:**
* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">\YooKassa\Model\TransferInterface[] OR array OR null</code> | value | |
**Returns:** mixed -
<a name="method_toArray" class="anchor"></a>
#### public toArray() : array
```php
public toArray() : array
```
**Summary**
Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации
Является алиасом метода AbstractObject::jsonSerialize()
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
**Returns:** array - Ассоциативный массив со свойствами текущего объекта
<a name="method_validate" class="anchor"></a>
#### public validate() : bool
```php
public validate() : bool
```
**Summary**
Валидирует объект запроса
**Details:**
* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md)
**Returns:** bool - True если запрос валиден и его можно отправить в API, false если нет
<a name="method_getUnknownProperties" class="anchor"></a>
#### protected getUnknownProperties() : array
```php
protected getUnknownProperties() : array
```
**Summary**
Возвращает массив свойств которые не существуют, но были заданы у объекта
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами
<a name="method_setValidationError" class="anchor"></a>
#### protected setValidationError() : mixed
```php
protected setValidationError(string $value) : mixed
```
**Summary**
Устанавливает ошибку валидации
**Details:**
* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">string</code> | value | Ошибка, произошедшая при валидации объекта |
**Returns:** mixed -
---
### Top Namespaces
* [\YooKassa](../namespaces/yookassa.md)
---
### Reports
* [Errors - 0](../reports/errors.md)
* [Markers - 1](../reports/markers.md)
* [Deprecated - 25](../reports/deprecated.md)
---
This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/)
&copy; 2023 YooMoney