# [YooKassa API SDK](../home.md)
# Class: \YooKassa\Request\Deals\DealResponse
### Namespace: [\YooKassa\Request\Deals](../namespaces/yookassa-request-deals.md)
---
**Summary:**
Класс объекта ответа, возвращаемого API при запросе конкретной сделки
---
### Constants
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| public | [MAX_LENGTH_DESCRIPTION](../classes/YooKassa-Model-SafeDeal.md#constant_MAX_LENGTH_DESCRIPTION) | | Максимальная длина строки описания сделки |
---
### 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 | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива |
| public | [getBalance()](../classes/YooKassa-Model-SafeDeal.md#method_getBalance) | | Возвращает баланс сделки |
| public | [getCreatedAt()](../classes/YooKassa-Model-SafeDeal.md#method_getCreatedAt) | | Возвращает время создания сделки |
| public | [getDescription()](../classes/YooKassa-Model-SafeDeal.md#method_getDescription) | | Возвращает описание сделки (не более 128 символов). |
| public | [getExpiresAt()](../classes/YooKassa-Model-SafeDeal.md#method_getExpiresAt) | | Возвращает время автоматического закрытия сделки |
| public | [getFeeMoment()](../classes/YooKassa-Model-SafeDeal.md#method_getFeeMoment) | | Возвращает момент перечисления вам вознаграждения платформы |
| public | [getId()](../classes/YooKassa-Model-SafeDeal.md#method_getId) | | Возвращает Id сделки |
| public | [getMetadata()](../classes/YooKassa-Model-SafeDeal.md#method_getMetadata) | | Возвращает дополнительные данные сделки |
| public | [getPayoutBalance()](../classes/YooKassa-Model-SafeDeal.md#method_getPayoutBalance) | | Возвращает сумму вознаграждения продавца |
| public | [getStatus()](../classes/YooKassa-Model-SafeDeal.md#method_getStatus) | | Возвращает статус сделки |
| public | [getTest()](../classes/YooKassa-Model-SafeDeal.md#method_getTest) | | Возвращает признак тестовой операции |
| public | [getType()](../classes/YooKassa-Model-BaseDeal.md#method_getType) | | Возвращает тип сделки |
| 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 | [setBalance()](../classes/YooKassa-Model-SafeDeal.md#method_setBalance) | | Устанавливает баланс сделки |
| public | [setCreatedAt()](../classes/YooKassa-Model-SafeDeal.md#method_setCreatedAt) | | Устанавливает время создания сделки |
| public | [setDescription()](../classes/YooKassa-Model-SafeDeal.md#method_setDescription) | | Устанавливает описание сделки (не более 128 символов). |
| public | [setExpiresAt()](../classes/YooKassa-Model-SafeDeal.md#method_setExpiresAt) | | Устанавливает время автоматического закрытия сделки |
| public | [setFeeMoment()](../classes/YooKassa-Model-SafeDeal.md#method_setFeeMoment) | | Устанавливает момент перечисления вам вознаграждения платформы |
| public | [setId()](../classes/YooKassa-Model-SafeDeal.md#method_setId) | | Устанавливает Id сделки |
| public | [setMetadata()](../classes/YooKassa-Model-SafeDeal.md#method_setMetadata) | | Устанавливает дополнительные данные сделки |
| public | [setPayoutBalance()](../classes/YooKassa-Model-SafeDeal.md#method_setPayoutBalance) | | Устанавливает сумму вознаграждения продавца |
| public | [setStatus()](../classes/YooKassa-Model-SafeDeal.md#method_setStatus) | | Устанавливает статус сделки |
| public | [setTest()](../classes/YooKassa-Model-SafeDeal.md#method_setTest) | | Устанавливает признак тестовой операции |
| public | [setType()](../classes/YooKassa-Model-BaseDeal.md#method_setType) | | Устанавливает тип сделки |
| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() |
| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта |
---
### Details
* File: [lib/Request/Deals/DealResponse.php](../../lib/Request/Deals/DealResponse.php)
* Package: YooKassa
* Class Hierarchy:
* [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
* [\YooKassa\Model\BaseDeal](../classes/YooKassa-Model-BaseDeal.md)
* [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
* [\YooKassa\Request\Deals\AbstractDealResponse](../classes/YooKassa-Request-Deals-AbstractDealResponse.md)
* \YooKassa\Request\Deals\DealResponse
---
## Constants
###### MAX_LENGTH_DESCRIPTION
Inherited from [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
Максимальная длина строки описания сделки
```php
MAX_LENGTH_DESCRIPTION = 128
```
---
## Methods
#### 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 |
| ---- | ---- | ----------- |
| array | data | |
**Returns:** mixed -
#### 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 |
| ---- | ---- | ----------- |
| string | propertyName | Имя свойства |
**Returns:** mixed - Значение свойства
#### 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 |
| ---- | ---- | ----------- |
| string | propertyName | Имя проверяемого свойства |
**Returns:** bool - True если свойство имеется, false если нет
#### 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 |
| ---- | ---- | ----------- |
| string | propertyName | Имя свойства |
| mixed | value | Значение свойства |
**Returns:** mixed -
#### 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 |
| ---- | ---- | ----------- |
| string | propertyName | Имя удаляемого свойства |
**Returns:** mixed -
#### 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 |
| ---- | ---- | ----------- |
| array OR \Traversable | sourceArray | Ассоциативный массив с настройками |
**Returns:** mixed -
#### public getBalance() : \YooKassa\Model\MonetaryAmount
```php
public getBalance() : \YooKassa\Model\MonetaryAmount
```
**Summary**
Возвращает баланс сделки
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
**Returns:** \YooKassa\Model\MonetaryAmount - Баланс сделки
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
#### public getCreatedAt() : \DateTime
```php
public getCreatedAt() : \DateTime
```
**Summary**
Возвращает время создания сделки
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
**Returns:** \DateTime - Время создания сделки
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
#### public getDescription() : string
```php
public getDescription() : string
```
**Summary**
Возвращает описание сделки (не более 128 символов).
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
**Returns:** string - Описание сделки
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
#### public getExpiresAt() : \DateTime
```php
public getExpiresAt() : \DateTime
```
**Summary**
Возвращает время автоматического закрытия сделки
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
**Returns:** \DateTime - Время автоматического закрытия сделки
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
#### public getFeeMoment() : string
```php
public getFeeMoment() : string
```
**Summary**
Возвращает момент перечисления вам вознаграждения платформы
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
**Returns:** string - Момент перечисления вознаграждения
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
#### public getId() : string
```php
public getId() : string
```
**Summary**
Возвращает Id сделки
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
**Returns:** string - Id сделки
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
#### public getMetadata() : \YooKassa\Model\Metadata
```php
public getMetadata() : \YooKassa\Model\Metadata
```
**Summary**
Возвращает дополнительные данные сделки
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
**Returns:** \YooKassa\Model\Metadata - Дополнительные данные сделки
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
#### public getPayoutBalance() : \YooKassa\Model\MonetaryAmount
```php
public getPayoutBalance() : \YooKassa\Model\MonetaryAmount
```
**Summary**
Возвращает сумму вознаграждения продавца
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
**Returns:** \YooKassa\Model\MonetaryAmount - Сумма вознаграждения продавца
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
#### public getStatus() : string
```php
public getStatus() : string
```
**Summary**
Возвращает статус сделки
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
**Returns:** string - Статус сделки
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
#### public getTest() : bool
```php
public getTest() : bool
```
**Summary**
Возвращает признак тестовой операции
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
**Returns:** bool - Признак тестовой операции
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
#### public getType() : string
```php
public getType() : string
```
**Summary**
Возвращает тип сделки
**Details:**
* Inherited From: [\YooKassa\Model\BaseDeal](../classes/YooKassa-Model-BaseDeal.md)
**Returns:** string - Тип сделки
#### public jsonSerialize() : mixed
```php
public jsonSerialize() : mixed
```
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
**Returns:** mixed -
#### public offsetExists() : mixed
```php
public offsetExists(mixed $offset) : mixed
```
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| mixed | offset | |
**Returns:** mixed -
#### public offsetGet() : mixed
```php
public offsetGet(mixed $offset) : mixed
```
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| mixed | offset | |
**Returns:** mixed -
#### 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 |
| ---- | ---- | ----------- |
| mixed | offset | |
| mixed | value | |
**Returns:** mixed -
#### public offsetUnset() : mixed
```php
public offsetUnset(mixed $offset) : mixed
```
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| mixed | offset | |
**Returns:** mixed -
#### public setBalance() : \YooKassa\Model\SafeDeal
```php
public setBalance(\YooKassa\Model\Deal\DealBalanceAmount|array $value) : \YooKassa\Model\SafeDeal
```
**Summary**
Устанавливает баланс сделки
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| \YooKassa\Model\Deal\DealBalanceAmount OR array | value | Баланс сделки |
**Returns:** \YooKassa\Model\SafeDeal -
#### public setCreatedAt() : \YooKassa\Model\SafeDeal
```php
public setCreatedAt(\DateTime|string $value) : \YooKassa\Model\SafeDeal
```
**Summary**
Устанавливает время создания сделки
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| \DateTime OR string | value | Время создания сделки |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в метод была передана пустая дата |
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если передали строку, которую не удалось привести к дате |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время |
**Returns:** \YooKassa\Model\SafeDeal -
#### public setDescription() : \YooKassa\Model\SafeDeal
```php
public setDescription(string $value) : \YooKassa\Model\SafeDeal
```
**Summary**
Устанавливает описание сделки (не более 128 символов).
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| string | value | Описание сделки |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение превышает допустимую длину |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой |
**Returns:** \YooKassa\Model\SafeDeal -
#### public setExpiresAt() : \YooKassa\Model\SafeDeal
```php
public setExpiresAt(\DateTime|string $value) : \YooKassa\Model\SafeDeal
```
**Summary**
Устанавливает время автоматического закрытия сделки
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| \DateTime OR string | value | Время автоматического закрытия сделки |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в метод была передана пустая дата |
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если передали строку, которую не удалось привести к дате |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время |
**Returns:** \YooKassa\Model\SafeDeal -
#### public setFeeMoment() : \YooKassa\Model\SafeDeal
```php
public setFeeMoment(string $value) : \YooKassa\Model\SafeDeal
```
**Summary**
Устанавливает момент перечисления вам вознаграждения платформы
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| string | value | Момент перечисления вам вознаграждения платформы |
**Returns:** \YooKassa\Model\SafeDeal -
#### public setId() : \YooKassa\Model\SafeDeal
```php
public setId(string $value) : \YooKassa\Model\SafeDeal
```
**Summary**
Устанавливает Id сделки
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| string | value | Id сделки |
**Returns:** \YooKassa\Model\SafeDeal -
#### public setMetadata() : \YooKassa\Model\SafeDeal
```php
public setMetadata(\YooKassa\Model\Metadata|array $value) : \YooKassa\Model\SafeDeal
```
**Summary**
Устанавливает дополнительные данные сделки
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| \YooKassa\Model\Metadata OR array | value | Дополнительные данные сделки |
**Returns:** \YooKassa\Model\SafeDeal -
#### public setPayoutBalance() : \YooKassa\Model\SafeDeal
```php
public setPayoutBalance(\YooKassa\Model\Deal\DealBalanceAmount $value) : \YooKassa\Model\SafeDeal
```
**Summary**
Устанавливает сумму вознаграждения продавца
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| \YooKassa\Model\Deal\DealBalanceAmount | value | Сумма вознаграждения продавца |
**Returns:** \YooKassa\Model\SafeDeal -
#### public setStatus() : \YooKassa\Model\SafeDeal
```php
public setStatus(string $value) : \YooKassa\Model\SafeDeal
```
**Summary**
Устанавливает статус сделки
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| string | value | Статус сделки |
**Returns:** \YooKassa\Model\SafeDeal -
#### public setTest() : \YooKassa\Model\SafeDeal
```php
public setTest(bool $value) : \YooKassa\Model\SafeDeal
```
**Summary**
Устанавливает признак тестовой операции
**Details:**
* Inherited From: [\YooKassa\Model\SafeDeal](../classes/YooKassa-Model-SafeDeal.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| bool | value | Признак тестовой операции |
**Returns:** \YooKassa\Model\SafeDeal -
#### public setType() : mixed
```php
public setType(string $value) : mixed
```
**Summary**
Устанавливает тип сделки
**Details:**
* Inherited From: [\YooKassa\Model\BaseDeal](../classes/YooKassa-Model-BaseDeal.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| string | value | Тип сделки |
**Returns:** mixed -
#### public toArray() : array
```php
public toArray() : array
```
**Summary**
Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации
Является алиасом метода AbstractObject::jsonSerialize()
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
**Returns:** array - Ассоциативный массив со свойствами текущего объекта
#### protected getUnknownProperties() : array
```php
protected getUnknownProperties() : array
```
**Summary**
Возвращает массив свойств которые не существуют, но были заданы у объекта
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами
---
### 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/)
© 2023 YooMoney