Добавлены нулевые привязки по СБП Добавлена причина отмены возвратов `payment_expired`
16 KiB
YooKassa API SDK
Class: \YooKassa\Model\Deal\DealBalanceAmount
Namespace: \YooKassa\Model\Deal
Summary:
Класс, представляющий модель DealBalanceAmount.
Description:
Баланс сделки.
Constants
- No constants found
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | $currency | Трехбуквенный код валюты в формате ISO-4217. Пример: RUB. | |
| public | $value | Сумма в выбранной валюте. |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | MonetaryAmount constructor. | |
| public | __get() | Возвращает значение свойства. | |
| public | __isset() | Проверяет наличие свойства. | |
| public | __set() | Устанавливает значение свойства. | |
| public | __unset() | Удаляет свойство. | |
| public | fromArray() | Устанавливает значения свойств текущего объекта из массива. | |
| public | getCurrency() | Возвращает валюту. | |
| public | getIntegerValue() | Возвращает сумму в копейках в виде целого числа. | |
| public | getValidator() | ||
| public | getValue() | Возвращает значение суммы. | |
| public | jsonSerialize() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации. | |
| public | offsetExists() | Проверяет наличие свойства. | |
| public | offsetGet() | Возвращает значение свойства. | |
| public | offsetSet() | Устанавливает значение свойства. | |
| public | offsetUnset() | Удаляет свойство. | |
| public | setCurrency() | Устанавливает код валюты. | |
| public | setValue() | Устанавливает сумму. | |
| public | toArray() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize(). | |
| protected | getUnknownProperties() | Возвращает массив свойств которые не существуют, но были заданы у объекта. | |
| protected | validatePropertyValue() |
Details
-
Package: YooKassa\Model
-
Class Hierarchy:
- \YooKassa\Common\AbstractObject
- \YooKassa\Model\Deal\DealBalanceAmount
-
Implements:
-
See Also:
Tags
| Tag | Version | Description |
|---|---|---|
| category | Class | |
| author | cms@yoomoney.ru |
Properties
public $currency : string
Description
Трехбуквенный код валюты в формате ISO-4217. Пример: RUB.
Type: string
Details:
public $value : int
Description
Сумма в выбранной валюте.
Type: int
Details:
Methods
public __construct() : mixed
public __construct(null|array|\YooKassa\Model\Deal\numeric $value = null, null|string $currency = null) : mixed
Summary
MonetaryAmount constructor.
Details:
- Inherited From: \YooKassa\Model\Deal\DealBalanceAmount
Parameters:
| Type | Name | Description |
|---|---|---|
null OR array OR \YooKassa\Model\Deal\numeric |
value | Сумма |
null OR string |
currency | Код валюты |
Returns: mixed -
public __get() : mixed
public __get(string $propertyName) : mixed
Summary
Возвращает значение свойства.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | Имя свойства |
Returns: mixed - Значение свойства
public __isset() : bool
public __isset(string $propertyName) : bool
Summary
Проверяет наличие свойства.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | Имя проверяемого свойства |
Returns: bool - True если свойство имеется, false если нет
public __set() : void
public __set(string $propertyName, mixed $value) : void
Summary
Устанавливает значение свойства.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | Имя свойства |
mixed |
value | Значение свойства |
Returns: void -
public __unset() : void
public __unset(string $propertyName) : void
Summary
Удаляет свойство.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | Имя удаляемого свойства |
Returns: void -
public fromArray() : void
public fromArray(array|\Traversable $sourceArray) : void
Summary
Устанавливает значения свойств текущего объекта из массива.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
array OR \Traversable |
sourceArray | Ассоциативный массив с настройками |
Returns: void -
public getCurrency() : string
public getCurrency() : string
Summary
Возвращает валюту.
Details:
- Inherited From: \YooKassa\Model\Deal\DealBalanceAmount
Returns: string - Код валюты
public getIntegerValue() : int
public getIntegerValue() : int
Summary
Возвращает сумму в копейках в виде целого числа.
Details:
- Inherited From: \YooKassa\Model\Deal\DealBalanceAmount
Returns: int - Сумма в копейках/центах
public getValidator() : \YooKassa\Validator\Validator
public getValidator() : \YooKassa\Validator\Validator
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: \YooKassa\Validator\Validator -
public getValue() : string
public getValue() : string
Summary
Возвращает значение суммы.
Details:
- Inherited From: \YooKassa\Model\Deal\DealBalanceAmount
Returns: string - Сумма
public jsonSerialize() : array
public jsonSerialize() : array
Summary
Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
Details:
- Inherited From: \YooKassa\Model\Deal\DealBalanceAmount
Returns: array -
public offsetExists() : bool
public offsetExists(string $offset) : bool
Summary
Проверяет наличие свойства.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
offset | Имя проверяемого свойства |
Returns: bool - True если свойство имеется, false если нет
public offsetGet() : mixed
public offsetGet(string $offset) : mixed
Summary
Возвращает значение свойства.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
offset | Имя свойства |
Returns: mixed - Значение свойства
public offsetSet() : void
public offsetSet(string $offset, mixed $value) : void
Summary
Устанавливает значение свойства.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
offset | Имя свойства |
mixed |
value | Значение свойства |
Returns: void -
public offsetUnset() : void
public offsetUnset(string $offset) : void
Summary
Удаляет свойство.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
offset | Имя удаляемого свойства |
Returns: void -
public setCurrency() : self
public setCurrency(string|null $currency) : self
Summary
Устанавливает код валюты.
Details:
- Inherited From: \YooKassa\Model\Deal\DealBalanceAmount
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
currency | Код валюты |
Returns: self -
public setValue() : self
public setValue(\YooKassa\Model\Deal\numeric|string $value) : self
Summary
Устанавливает сумму.
Details:
- Inherited From: \YooKassa\Model\Deal\DealBalanceAmount
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\Deal\numeric OR string |
value | Сумма |
Returns: self -
public toArray() : array
public toArray() : array
Summary
Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: array - Ассоциативный массив со свойствами текущего объекта
protected getUnknownProperties() : array
protected getUnknownProperties() : array
Summary
Возвращает массив свойств которые не существуют, но были заданы у объекта.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: array - Ассоциативный массив с не существующими у текущего объекта свойствами
protected validatePropertyValue() : mixed
protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | |
mixed |
propertyValue |
Returns: mixed -
Top Namespaces
Reports
This document was automatically generated from source code comments on 2026-06-29 using phpDocumentor
© 2026 YooMoney