geckon01/yookassa-sdk-php
1
0
Fork 0
mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-08-17 16:01:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
27c2aef05a6d30e508fdb99dab49cd5e205bb5ee
yookassa-sdk-php/docs/classes/YooKassa-Request-Deals-CreateDealResponse.md
T
Антон Н. Николаев 27c2aef05a Добавлена поддержка кассовых ссылок в СБП
2025-07-01 14:52:30 +03:00

40 KiB
Raw Blame History

YooKassa API SDK

Class: \YooKassa\Request\Deals\CreateDealResponse

Namespace: \YooKassa\Request\Deals

Summary:

Класс, представляющий CreateDealResponse.

Description:

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

Constants

Visibility Name Flag Summary
public MAX_LENGTH_ID
public MIN_LENGTH_ID
public MAX_LENGTH_DESCRIPTION

Properties

Visibility Name Flag Summary
public $balance Баланс сделки.
public $created_at Время создания сделки.
public $createdAt Время создания сделки.
public $description Описание сделки (не более 128 символов).
public $expires_at Время автоматического закрытия сделки.
public $expiresAt Время автоматического закрытия сделки.
public $fee_moment Момент перечисления вам вознаграждения платформы.
public $feeMoment Момент перечисления вам вознаграждения платформы.
public $id Идентификатор сделки.
public $metadata Любые дополнительные данные, которые нужны вам для работы.
public $payout_balance Сумма вознаграждения продавцаю.
public $payoutBalance Сумма вознаграждения продавца.
public $status Статус сделки.
public $test Признак тестовой операции.
public $type Тип сделки
protected $_balance Баланс сделки
protected $_created_at Время создания сделки.
protected $_description Описание сделки (не более 128 символов). Используется для фильтрации при получении списка сделок.
protected $_expires_at Время автоматического закрытия сделки.
protected $_fee_moment Момент перечисления вам вознаграждения платформы
protected $_id Идентификатор сделки.
protected $_metadata Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа).
protected $_payout_balance Сумма вознаграждения продавца
protected $_status Статус сделки
protected $_test Признак тестовой операции.
protected $_type Тип сделки

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 getValidator()
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public setBalance() Устанавливает баланс сделки.
public setCreatedAt() Устанавливает created_at.
public setDescription() Устанавливает описание сделки (не более 128 символов).
public setExpiresAt() Устанавливает время автоматического закрытия сделки.
public setFeeMoment() Устанавливает момент перечисления вам вознаграждения платформы.
public setId() Устанавливает Id сделки.
public setMetadata() Устанавливает metadata.
public setPayoutBalance() Устанавливает сумму вознаграждения продавца.
public setStatus() Устанавливает статус сделки.
public setTest() Устанавливает признак тестовой операции.
public setType() Устанавливает тип сделки.
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected validatePropertyValue()

Details

Tags

Tag Version Description
category Abstract Class
author cms@yoomoney.ru

Constants

MAX_LENGTH_ID

Inherited from \YooKassa\Model\Deal\SafeDeal

MAX_LENGTH_ID = 50 : int

MIN_LENGTH_ID

Inherited from \YooKassa\Model\Deal\SafeDeal

MIN_LENGTH_ID = 36 : int

MAX_LENGTH_DESCRIPTION

Inherited from \YooKassa\Model\Deal\SafeDeal

MAX_LENGTH_DESCRIPTION = 128 : int

Properties

public $balance : \YooKassa\Model\AmountInterface

Description

Баланс сделки.

Type: AmountInterface

Details:

public $created_at : \DateTime

Description

Время создания сделки.

Type: \DateTime

Details:

public $createdAt : \DateTime

Description

Время создания сделки.

Type: \DateTime

Details:

public $description : string

Description

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

Type: string

Details:

public $expires_at : \DateTime

Description

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

Type: \DateTime

Details:

public $expiresAt : \DateTime

Description

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

Type: \DateTime

Details:

public $fee_moment : string

Description

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

Type: string

Details:

public $feeMoment : string

Description

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

Type: string

Details:

public $id : string

Description

Идентификатор сделки.

Type: string

Details:

public $metadata : \YooKassa\Model\Metadata

Description

Любые дополнительные данные, которые нужны вам для работы.

Type: Metadata

Details:

public $payout_balance : \YooKassa\Model\AmountInterface

Description

Сумма вознаграждения продавцаю.

Type: AmountInterface

Details:

public $payoutBalance : \YooKassa\Model\AmountInterface

Description

Сумма вознаграждения продавца.

Type: AmountInterface

Details:

public $status : string

Description

Статус сделки.

Type: string

Details:

public $test : bool

Description

Признак тестовой операции.

Type: bool

Details:

public $type : string

Description

Тип сделки

Type: string

Details:

protected $_balance : ?\YooKassa\Model\AmountInterface

Summary

Баланс сделки

Type: AmountInterface

Details:

protected $_created_at : ?\DateTime

Summary

Время создания сделки.

Type: DateTime

Details:

protected $_description : ?string

Summary

Описание сделки (не более 128 символов). Используется для фильтрации при получении списка сделок.

Type: ?string

Details:

protected $_expires_at : ?\DateTime

Summary

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

Type: DateTime

Details:

protected $_fee_moment : ?string

Summary

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

Type: ?string

Details:

protected $_id : ?string

Summary

Идентификатор сделки.

Type: ?string

Details:

protected $_metadata : ?\YooKassa\Model\Metadata

Summary

Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа).

Type: Metadata

Details:

protected $_payout_balance : ?\YooKassa\Model\AmountInterface

Summary

Сумма вознаграждения продавца

Type: AmountInterface

Details:

protected $_status : ?string

Summary

Статус сделки

Type: ?string

Details:

protected $_test : ?bool

Summary

Признак тестовой операции.

Type: ?bool

Details:

protected $_type : ?string

Summary

Тип сделки

Type: ?string

Details:

Methods

public __construct() : mixed

public __construct(array|null $data = []) : mixed

Summary

AbstractObject constructor.

Details:

Parameters:
Type Name Description
array OR null data

Returns: mixed -

public __get() : mixed

public __get(string $propertyName) : mixed

Summary

Возвращает значение свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя свойства

Returns: mixed - Значение свойства

public __isset() : bool

public __isset(string $propertyName) : bool

Summary

Проверяет наличие свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public __set() : void

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

Summary

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

Details:

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

Returns: void -

public __unset() : void

public __unset(string $propertyName) : void

Summary

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

Details:

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

Returns: void -

public fromArray() : void

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

Summary

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

Details:

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

Returns: void -

public getBalance() : \YooKassa\Model\AmountInterface|null

public getBalance() : \YooKassa\Model\AmountInterface|null

Summary

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

Details:

Returns: \YooKassa\Model\AmountInterface|null - Баланс сделки

public getCreatedAt() : \DateTime|null

public getCreatedAt() : \DateTime|null

Summary

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

Details:

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

public getDescription() : string|null

public getDescription() : string|null

Summary

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

Details:

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

public getExpiresAt() : \DateTime|null

public getExpiresAt() : \DateTime|null

Summary

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

Details:

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

public getFeeMoment() : string|null

public getFeeMoment() : string|null

Summary

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

Details:

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

public getId() : string|null

public getId() : string|null

Summary

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

Details:

Returns: string|null - Id сделки

public getMetadata() : \YooKassa\Model\Metadata|null

public getMetadata() : \YooKassa\Model\Metadata|null

Summary

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

Details:

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

public getPayoutBalance() : \YooKassa\Model\AmountInterface|null

public getPayoutBalance() : \YooKassa\Model\AmountInterface|null

Summary

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

Details:

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

public getStatus() : string|null

public getStatus() : string|null

Summary

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

Details:

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

public getTest() : bool|null

public getTest() : bool|null

Summary

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

Details:

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

public getType() : string|null

public getType() : string|null

Summary

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

Details:

Returns: string|null -

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

public jsonSerialize() : array

public jsonSerialize() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.

Details:

Returns: array - Ассоциативный массив со свойствами текущего объекта

public offsetExists() : bool

public offsetExists(string $offset) : bool

Summary

Проверяет наличие свойства.

Details:

Parameters:
Type Name Description
string offset Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public offsetGet() : mixed

public offsetGet(string $offset) : mixed

Summary

Возвращает значение свойства.

Details:

Parameters:
Type Name Description
string offset Имя свойства

Returns: mixed - Значение свойства

public offsetSet() : void

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

Summary

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

Details:

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

Returns: void -

public offsetUnset() : void

public offsetUnset(string $offset) : void

Summary

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

Details:

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

Returns: void -

public setBalance() : self

public setBalance(\YooKassa\Model\AmountInterface|array|null $balance = null) : self

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\AmountInterface OR array OR null balance

Returns: self -

public setCreatedAt() : self

public setCreatedAt(\DateTime|string|null $created_at = null) : self

Summary

Устанавливает created_at.

Details:

Parameters:
Type Name Description
\DateTime OR string OR null created_at Время создания сделки.

Returns: self -

public setDescription() : self

public setDescription(string|null $description = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null description Описание сделки (не более 128 символов).

Returns: self -

public setExpiresAt() : self

public setExpiresAt(\DateTime|string|null $expires_at = null) : self

Summary

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

Details:

Parameters:
Type Name Description
\DateTime OR string OR null expires_at Время автоматического закрытия сделки.

Returns: self -

public setFeeMoment() : self

public setFeeMoment(string|null $fee_moment = null) : self

Summary

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

Details:

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

Returns: self -

public setId() : self

public setId(string|null $id = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null id Идентификатор сделки.

Returns: self -

public setMetadata() : self

public setMetadata(\YooKassa\Model\Metadata|array|null $metadata = null) : self

Summary

Устанавливает metadata.

Details:

Parameters:
Type Name Description
\YooKassa\Model\Metadata OR array OR null metadata Любые дополнительные данные, которые нужны вам для работы.

Returns: self -

public setPayoutBalance() : self

public setPayoutBalance(\YooKassa\Model\AmountInterface|array|null $payout_balance = null) : self

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\AmountInterface OR array OR null payout_balance Сумма вознаграждения продавца

Returns: self -

public setStatus() : self

public setStatus(string|null $status = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null status Статус сделки

Returns: self -

public setTest() : self

public setTest(bool|null $test = null) : self

Summary

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

Details:

Parameters:
Type Name Description
bool OR null test Признак тестовой операции

Returns: self -

public setType() : self

public setType(string|null $type = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null type

Returns: self -

public toArray() : array

public toArray() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().

Details:

Returns: array - Ассоциативный массив со свойствами текущего объекта

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

Возвращает массив свойств которые не существуют, но были заданы у объекта.

Details:

Returns: array - Ассоциативный массив с не существующими у текущего объекта свойствами

protected validatePropertyValue() : mixed

protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed

Details:

Parameters:
Type Name Description
string propertyName
mixed propertyValue

Returns: mixed -

Top Namespaces

Reports

This document was automatically generated from source code comments on 2025-07-01 using phpDocumentor

© 2025 YooMoney

Reference in New Issue View Git Blame Copy Permalink