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

26 KiB
Raw Blame History

YooKassa API SDK

Class: \YooKassa\Request\Deals\CreateDealRequest

Namespace: \YooKassa\Request\Deals

Summary:

Класс, представляющий модель SafeDealRequest.

Description:

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

Examples

Пример использования билдера

try {
    $dealBuilder = \YooKassa\Request\Deals\CreateDealRequest::builder();
    $dealBuilder
        ->setType(\YooKassa\Model\Deal\DealType::SAFE_DEAL)
        ->setFeeMoment(\YooKassa\Model\Deal\FeeMoment::PAYMENT_SUCCEEDED)
        ->setDescription('SAFE_DEAL 123554642-2432FF344R')
        ->setMetadata(['order_id' => '37'])
    ;

    // Создаем объект запроса
    $request = $dealBuilder->build();

    $idempotenceKey = uniqid('', true);
    $response = $client->createDeal($request, $idempotenceKey);
} catch (Exception $e) {
    $response = $e;
}

var_dump($response);

Constants

  • No constants found

Properties

Visibility Name Flag Summary
public $description Описание сделки
public $fee_moment Момент перечисления вам вознаграждения платформы
public $feeMoment Момент перечисления вам вознаграждения платформы
public $metadata Метаданные привязанные к сделке
public $type Тип сделки

Methods

Visibility Name Flag Summary
public __construct() AbstractObject constructor.
public __get() Возвращает значение свойства.
public __isset() Проверяет наличие свойства.
public __set() Устанавливает значение свойства.
public __unset() Удаляет свойство.
public builder() Возвращает билдер объектов запросов создания сделки.
public clearValidationError() Очищает статус валидации текущего запроса.
public fromArray() Устанавливает значения свойств текущего объекта из массива.
public getDescription() Возвращает описание сделки.
public getFeeMoment() Возвращает момент перечисления вам вознаграждения платформы.
public getLastValidationError() Возвращает последнюю ошибку валидации.
public getMetadata() Возвращает данные оплаты установленные мерчантом
public getType() Возвращает тип сделки.
public getValidator()
public hasDescription() Проверяет наличие описания в создаваемой сделке.
public hasFeeMoment() Проверяет, был ли установлен момент перечисления вознаграждения.
public hasMetadata() Проверяет, были ли установлены метаданные заказа.
public hasType() Проверяет наличие типа в создаваемой сделке.
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public setDescription() Устанавливает описание сделки.
public setFeeMoment() Устанавливает момент перечисления вам вознаграждения платформы.
public setMetadata() Устанавливает метаданные, привязанные к платежу.
public setType() Устанавливает тип сделки.
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
public validate() Проверяет на валидность текущий объект
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected setValidationError() Устанавливает ошибку валидации.
protected validatePropertyValue()

Details

Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Properties

public $description : string

Description

Описание сделки

Type: string

Details:

public $fee_moment : string

Description

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

Type: string

Details:

public $feeMoment : string

Description

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

Type: string

Details:

public $metadata : \YooKassa\Model\Metadata

Description

Метаданные привязанные к сделке

Type: Metadata

Details:

public $type : string

Description

Тип сделки

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 builder() : \YooKassa\Request\Deals\CreateDealRequestBuilder

Static public builder() : \YooKassa\Request\Deals\CreateDealRequestBuilder

Summary

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

Details:

Returns: \YooKassa\Request\Deals\CreateDealRequestBuilder - Инстанс билдера объектов запросов

public clearValidationError() : void

public clearValidationError() : void

Summary

Очищает статус валидации текущего запроса.

Details:

Returns: void -

public fromArray() : void

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

Summary

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

Details:

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

Returns: void -

public getDescription() : string|null

public getDescription() : string|null

Summary

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

Details:

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

public getFeeMoment() : string|null

public getFeeMoment() : string|null

Summary

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

Details:

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

public getLastValidationError() : string|null

public getLastValidationError() : string|null

Summary

Возвращает последнюю ошибку валидации.

Details:

Returns: string|null - Последняя произошедшая ошибка валидации

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

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

Summary

Возвращает данные оплаты установленные мерчантом

Details:

Returns: \YooKassa\Model\Metadata|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 hasDescription() : bool

public hasDescription() : bool

Summary

Проверяет наличие описания в создаваемой сделке.

Details:

Returns: bool - True если описание сделки есть, false если нет

public hasFeeMoment() : bool

public hasFeeMoment() : bool

Summary

Проверяет, был ли установлен момент перечисления вознаграждения.

Details:

Returns: bool - True если момент перечисления был установлен, false если нет

public hasMetadata() : bool

public hasMetadata() : bool

Summary

Проверяет, были ли установлены метаданные заказа.

Details:

Returns: bool - True если метаданные были установлены, false если нет

public hasType() : bool

public hasType() : bool

Summary

Проверяет наличие типа в создаваемой сделке.

Details:

Returns: bool - True если тип сделки есть, false если нет

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 setDescription() : self

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

Summary

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

Details:

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

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 setMetadata() : self

public setMetadata(string|array|null $metadata = null) : self

Summary

Устанавливает метаданные, привязанные к платежу.

Details:

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

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

public validate() : bool

public validate() : bool

Summary

Проверяет на валидность текущий объект

Details:

Returns: bool - True если объект запроса валиден, false если нет

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

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

protected setValidationError() : void

protected setValidationError(string $value) : void

Summary

Устанавливает ошибку валидации.

Details:

Parameters:
Type Name Description
string value Ошибка, произошедшая при валидации объекта

Returns: void -

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