9.7 KiB
YooKassa API SDK
Interface: CreateDealRequestInterface
Namespace: \YooKassa\Request\Deals
Summary:
Interface DealInterface
Constants
- No constants found
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | getDescription() | Возвращает описание сделки (не более 128 символов). | |
| public | getFeeMoment() | Возвращает момент перечисления вам вознаграждения платформы | |
| public | getMetadata() | Возвращает дополнительные данные сделки | |
| public | getType() | Возвращает тип сделки | |
| public | hasDescription() | Проверяет наличие описания в создаваемой сделке | |
| public | hasFeeMoment() | Проверяет наличие момента перечисления вознаграждения в создаваемой сделке | |
| public | hasMetadata() | Проверяет, были ли установлены метаданные сделки | |
| public | hasType() | Проверяет наличие типа в создаваемой сделке | |
| public | setDescription() | Устанавливает описание сделки | |
| public | setFeeMoment() | Устанавливает момент перечисления вознаграждения платформы | |
| public | setMetadata() | Устанавливает метаданные, привязанные к сделке | |
| public | setType() | Устанавливает тип сделки |
Details
- File: lib/Request/Deals/CreateDealRequestInterface.php
- Package: \YooKassa
Tags
| Tag | Version | Description |
|---|---|---|
| property | Тип сделки | |
| property | Момент перечисления вознаграждения | |
| property | Момент перечисления вознаграждения | |
| property | Описание сделки | |
| property | Дополнительные данные сделки |
Methods
public getType() : string
public getType() : string
Summary
Возвращает тип сделки
Details:
- Inherited From: \YooKassa\Request\Deals\CreateDealRequestInterface
Returns: string - Тип сделки
public hasType() : bool
public hasType() : bool
Summary
Проверяет наличие типа в создаваемой сделке
Details:
- Inherited From: \YooKassa\Request\Deals\CreateDealRequestInterface
Returns: bool - True если тип сделки установлен, false если нет
public setType() : mixed
public setType(string $value) : mixed
Summary
Устанавливает тип сделки
Details:
- Inherited From: \YooKassa\Request\Deals\CreateDealRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Тип сделки |
Returns: mixed -
public getFeeMoment() : string
public getFeeMoment() : string
Summary
Возвращает момент перечисления вам вознаграждения платформы
Details:
- Inherited From: \YooKassa\Request\Deals\CreateDealRequestInterface
Returns: string - Момент перечисления вознаграждения
public hasFeeMoment() : bool
public hasFeeMoment() : bool
Summary
Проверяет наличие момента перечисления вознаграждения в создаваемой сделке
Details:
- Inherited From: \YooKassa\Request\Deals\CreateDealRequestInterface
Returns: bool - True если момент перечисления вознаграждения установлен, false если нет
public setFeeMoment() : mixed
public setFeeMoment(string $value) : mixed
Summary
Устанавливает момент перечисления вознаграждения платформы
Details:
- Inherited From: \YooKassa\Request\Deals\CreateDealRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Момент перечисления вознаграждения |
Returns: mixed -
public getDescription() : string
public getDescription() : string
Summary
Возвращает описание сделки (не более 128 символов).
Details:
- Inherited From: \YooKassa\Request\Deals\CreateDealRequestInterface
Returns: string - Описание сделки
public hasDescription() : bool
public hasDescription() : bool
Summary
Проверяет наличие описания в создаваемой сделке
Details:
- Inherited From: \YooKassa\Request\Deals\CreateDealRequestInterface
Returns: bool - True если описание сделки установлено, false если нет
public setDescription() : mixed
public setDescription(string $value) : mixed
Summary
Устанавливает описание сделки
Details:
- Inherited From: \YooKassa\Request\Deals\CreateDealRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Описание сделки |
Returns: mixed -
public getMetadata() : \YooKassa\Model\Metadata
public getMetadata() : \YooKassa\Model\Metadata
Summary
Возвращает дополнительные данные сделки
Details:
- Inherited From: \YooKassa\Request\Deals\CreateDealRequestInterface
Returns: \YooKassa\Model\Metadata - Дополнительные данные сделки
public hasMetadata() : bool
public hasMetadata() : bool
Summary
Проверяет, были ли установлены метаданные сделки
Details:
- Inherited From: \YooKassa\Request\Deals\CreateDealRequestInterface
Returns: bool - True если метаданные были установлены, false если нет
public setMetadata() : mixed
public setMetadata(\YooKassa\Model\Metadata|array|null $value) : mixed
Summary
Устанавливает метаданные, привязанные к сделке
Details:
- Inherited From: \YooKassa\Request\Deals\CreateDealRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\Metadata OR array OR null |
value | Метаданные сделки, устанавливаемые мерчантом |
Returns: mixed -
Top Namespaces
Reports
This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor
© 2023 YooMoney