meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Request-Deals-CreateDealResponse.md

YooKassa API SDK

Class: \YooKassa\Request\Deals\CreateDealResponse

Namespace: \YooKassa\Request\Deals

---

Summary:

Класс объекта ответа возвращаемого API при запросе на создание сделки

---

Constants

Visibility	Name	Flag	Summary
public	MAX_LENGTH_DESCRIPTION		Максимальная длина строки описания сделки

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства
public	__isset()		Проверяет наличие свойства
public	__set()		Устанавливает значение свойства
public	__unset()		Удаляет свойство
public	fromArray()		Устанавливает значения свойств текущего объекта из массива
public	getBalance()		Возвращает баланс сделки
public	getCreatedAt()		Возвращает время создания сделки
public	getDescription()		Возвращает описание сделки (не более 128 символов).
public	getExpiresAt()		Возвращает время автоматического закрытия сделки
public	getFeeMoment()		Возвращает момент перечисления вам вознаграждения платформы
public	getId()		Возвращает Id сделки
public	getMetadata()		Возвращает дополнительные данные сделки
public	getPayoutBalance()		Возвращает сумму вознаграждения продавца
public	getStatus()		Возвращает статус сделки
public	getTest()		Возвращает признак тестовой операции
public	getType()		Возвращает тип сделки
public	jsonSerialize()
public	offsetExists()
public	offsetGet()
public	offsetSet()
public	offsetUnset()
public	setBalance()		Устанавливает баланс сделки
public	setCreatedAt()		Устанавливает время создания сделки
public	setDescription()		Устанавливает описание сделки (не более 128 символов).
public	setExpiresAt()		Устанавливает время автоматического закрытия сделки
public	setFeeMoment()		Устанавливает момент перечисления вам вознаграждения платформы
public	setId()		Устанавливает Id сделки
public	setMetadata()		Устанавливает дополнительные данные сделки
public	setPayoutBalance()		Устанавливает сумму вознаграждения продавца
public	setStatus()		Устанавливает статус сделки
public	setTest()		Устанавливает признак тестовой операции
public	setType()		Устанавливает тип сделки
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта

---

Details

• File: lib/Request/Deals/CreateDealResponse.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Model\BaseDeal
  • \YooKassa\Model\SafeDeal
  • \YooKassa\Request\Deals\AbstractDealResponse
  • \YooKassa\Request\Deals\CreateDealResponse

---

Constants

MAX_LENGTH_DESCRIPTION

Inherited from \YooKassa\Model\SafeDeal

Максимальная длина строки описания сделки

MAX_LENGTH_DESCRIPTION = 128

---

Methods

public __construct() : mixed

public __construct(array $data = array()) : mixed

Summary

AbstractObject constructor.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array	data

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() : mixed

public __set(string $propertyName, mixed $value) : mixed

Summary

Устанавливает значение свойства

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя свойства
mixed	value	Значение свойства

Returns: mixed -

public __unset() : mixed

public __unset(string $propertyName) : mixed

Summary

Удаляет свойство

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя удаляемого свойства

Returns: mixed -

public fromArray() : mixed

public fromArray(array|\Traversable $sourceArray) : mixed

Summary

Устанавливает значения свойств текущего объекта из массива

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array OR \Traversable	sourceArray	Ассоциативный массив с настройками

Returns: mixed -

public getBalance() : \YooKassa\Model\MonetaryAmount

public getBalance() : \YooKassa\Model\MonetaryAmount

Summary

Возвращает баланс сделки

Details:

• Inherited From: \YooKassa\Model\SafeDeal

Returns: \YooKassa\Model\MonetaryAmount - Баланс сделки

Tags

Tag	Version	Description
inheritDoc

public getCreatedAt() : \DateTime

public getCreatedAt() : \DateTime

Summary

Возвращает время создания сделки

Details:

• Inherited From: \YooKassa\Model\SafeDeal

Returns: \DateTime - Время создания сделки

Tags

Tag	Version	Description
inheritDoc

public getDescription() : string

public getDescription() : string

Summary

Возвращает описание сделки (не более 128 символов).

Details:

• Inherited From: \YooKassa\Model\SafeDeal

Returns: string - Описание сделки

Tags

Tag	Version	Description
inheritDoc

public getExpiresAt() : \DateTime

public getExpiresAt() : \DateTime

Summary

Возвращает время автоматического закрытия сделки

Details:

• Inherited From: \YooKassa\Model\SafeDeal

Returns: \DateTime - Время автоматического закрытия сделки

Tags

Tag	Version	Description
inheritDoc

public getFeeMoment() : string

public getFeeMoment() : string

Summary

Возвращает момент перечисления вам вознаграждения платформы

Details:

• Inherited From: \YooKassa\Model\SafeDeal

Returns: string - Момент перечисления вознаграждения

Tags

Tag	Version	Description
inheritDoc

public getId() : string

public getId() : string

Summary

Возвращает Id сделки

Details:

• Inherited From: \YooKassa\Model\SafeDeal

Returns: string - Id сделки

Tags

Tag	Version	Description
inheritDoc

public getMetadata() : \YooKassa\Model\Metadata

public getMetadata() : \YooKassa\Model\Metadata

Summary

Возвращает дополнительные данные сделки

Details:

• Inherited From: \YooKassa\Model\SafeDeal

Returns: \YooKassa\Model\Metadata - Дополнительные данные сделки

Tags

Tag	Version	Description
inheritDoc

public getPayoutBalance() : \YooKassa\Model\MonetaryAmount

public getPayoutBalance() : \YooKassa\Model\MonetaryAmount

Summary

Возвращает сумму вознаграждения продавца

Details:

• Inherited From: \YooKassa\Model\SafeDeal

Returns: \YooKassa\Model\MonetaryAmount - Сумма вознаграждения продавца

Tags

Tag	Version	Description
inheritDoc

public getStatus() : string

public getStatus() : string

Summary

Возвращает статус сделки

Details:

• Inherited From: \YooKassa\Model\SafeDeal

Returns: string - Статус сделки

Tags

Tag	Version	Description
inheritDoc

public getTest() : bool

public getTest() : bool

Summary

Возвращает признак тестовой операции

Details:

• Inherited From: \YooKassa\Model\SafeDeal

Returns: bool - Признак тестовой операции

Tags

Tag	Version	Description
inheritDoc

public getType() : string

public getType() : string

Summary

Возвращает тип сделки

Details:

• Inherited From: \YooKassa\Model\BaseDeal

Returns: string - Тип сделки

public jsonSerialize() : mixed

public jsonSerialize() : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: mixed -

public offsetExists() : mixed

public offsetExists(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetGet() : mixed

public offsetGet(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetSet() : mixed

public offsetSet(mixed $offset, mixed $value) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset
mixed	value

Returns: mixed -

public offsetUnset() : mixed

public offsetUnset(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public setBalance() : \YooKassa\Model\SafeDeal

public setBalance(\YooKassa\Model\Deal\DealBalanceAmount|array $value) : \YooKassa\Model\SafeDeal

Summary

Устанавливает баланс сделки

Details:

• Inherited From: \YooKassa\Model\SafeDeal

Parameters:

Type	Name	Description
\YooKassa\Model\Deal\DealBalanceAmount OR array	value	Баланс сделки

Returns: \YooKassa\Model\SafeDeal -

public setCreatedAt() : \YooKassa\Model\SafeDeal

public setCreatedAt(\DateTime|string $value) : \YooKassa\Model\SafeDeal

Summary

Устанавливает время создания сделки

Details:

• Inherited From: \YooKassa\Model\SafeDeal

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

public setDescription(string $value) : \YooKassa\Model\SafeDeal

Summary

Устанавливает описание сделки (не более 128 символов).

Details:

• Inherited From: \YooKassa\Model\SafeDeal

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

public setExpiresAt(\DateTime|string $value) : \YooKassa\Model\SafeDeal

Summary

Устанавливает время автоматического закрытия сделки

Details:

• Inherited From: \YooKassa\Model\SafeDeal

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

public setFeeMoment(string $value) : \YooKassa\Model\SafeDeal

Summary

Устанавливает момент перечисления вам вознаграждения платформы

Details:

• Inherited From: \YooKassa\Model\SafeDeal

Parameters:

Type	Name	Description
string	value	Момент перечисления вам вознаграждения платформы

Returns: \YooKassa\Model\SafeDeal -

public setId() : \YooKassa\Model\SafeDeal

public setId(string $value) : \YooKassa\Model\SafeDeal

Summary

Устанавливает Id сделки

Details:

• Inherited From: \YooKassa\Model\SafeDeal

Parameters:

Type	Name	Description
string	value	Id сделки

Returns: \YooKassa\Model\SafeDeal -

public setMetadata() : \YooKassa\Model\SafeDeal

public setMetadata(\YooKassa\Model\Metadata|array $value) : \YooKassa\Model\SafeDeal

Summary

Устанавливает дополнительные данные сделки

Details:

• Inherited From: \YooKassa\Model\SafeDeal

Parameters:

Type	Name	Description
\YooKassa\Model\Metadata OR array	value	Дополнительные данные сделки

Returns: \YooKassa\Model\SafeDeal -

public setPayoutBalance() : \YooKassa\Model\SafeDeal

public setPayoutBalance(\YooKassa\Model\Deal\DealBalanceAmount $value) : \YooKassa\Model\SafeDeal

Summary

Устанавливает сумму вознаграждения продавца

Details:

• Inherited From: \YooKassa\Model\SafeDeal

Parameters:

Type	Name	Description
\YooKassa\Model\Deal\DealBalanceAmount	value	Сумма вознаграждения продавца

Returns: \YooKassa\Model\SafeDeal -

public setStatus() : \YooKassa\Model\SafeDeal

public setStatus(string $value) : \YooKassa\Model\SafeDeal

Summary

Устанавливает статус сделки

Details:

• Inherited From: \YooKassa\Model\SafeDeal

Parameters:

Type	Name	Description
string	value	Статус сделки

Returns: \YooKassa\Model\SafeDeal -

public setTest() : \YooKassa\Model\SafeDeal

public setTest(bool $value) : \YooKassa\Model\SafeDeal

Summary

Устанавливает признак тестовой операции

Details:

• Inherited From: \YooKassa\Model\SafeDeal

Parameters:

Type	Name	Description
bool	value	Признак тестовой операции

Returns: \YooKassa\Model\SafeDeal -

public setType() : mixed

public setType(string $value) : mixed

Summary

Устанавливает тип сделки

Details:

• Inherited From: \YooKassa\Model\BaseDeal

Parameters:

Type	Name	Description
string	value	Тип сделки

Returns: mixed -

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 - Ассоциативный массив с не существующими у текущего объекта свойствами

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 1
• Deprecated - 25

---

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

© 2023 YooMoney