mirror of
https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git
synced 2026-09-17 13:26:16 +00:00
Александра Д. Спиридонова
289 lines
10 KiB
Markdown
289 lines
10 KiB
Markdown
# [YooKassa API SDK](../home.md)
|
|
|
|
# Class: \YooKassa\Request\Deals\CreateDealRequestBuilder
|
|
### Namespace: [\YooKassa\Request\Deals](../namespaces/yookassa-request-deals.md)
|
|
---
|
|
**Summary:**
|
|
|
|
Класс, представляющий модель CreateDealRequestBuilder.
|
|
|
|
**Description:**
|
|
|
|
Класс билдера объектов запросов к API на создание платежа.
|
|
|
|
---
|
|
### Examples
|
|
Пример использования билдера
|
|
|
|
```php
|
|
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 |
|
|
| ----------:| ---- | ---- | ------- |
|
|
| protected | [$currentObject](../classes/YooKassa-Request-Deals-CreateDealRequestBuilder.md#property_currentObject) | | Собираемый объект запроса. |
|
|
|
|
---
|
|
### Methods
|
|
| Visibility | Name | Flag | Summary |
|
|
| ----------:| ---- | ---- | ------- |
|
|
| public | [__construct()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method___construct) | | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать. |
|
|
| public | [build()](../classes/YooKassa-Request-Deals-CreateDealRequestBuilder.md#method_build) | | Осуществляет сборку объекта запроса к API. |
|
|
| public | [setDescription()](../classes/YooKassa-Request-Deals-CreateDealRequestBuilder.md#method_setDescription) | | Устанавливает описание транзакции. |
|
|
| public | [setFeeMoment()](../classes/YooKassa-Request-Deals-CreateDealRequestBuilder.md#method_setFeeMoment) | | Устанавливает момент перечисления вам вознаграждения платформы. |
|
|
| public | [setMetadata()](../classes/YooKassa-Request-Deals-CreateDealRequestBuilder.md#method_setMetadata) | | Устанавливает метаданные, привязанные к платежу. |
|
|
| public | [setOptions()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_setOptions) | | Устанавливает свойства запроса из массива. |
|
|
| public | [setType()](../classes/YooKassa-Request-Deals-CreateDealRequestBuilder.md#method_setType) | | Устанавливает тип сделки. |
|
|
| protected | [initCurrentObject()](../classes/YooKassa-Request-Deals-CreateDealRequestBuilder.md#method_initCurrentObject) | | Инициализирует объект запроса, который в дальнейшем будет собираться билдером |
|
|
|
|
---
|
|
### Details
|
|
* File: [lib/Request/Deals/CreateDealRequestBuilder.php](../../lib/Request/Deals/CreateDealRequestBuilder.php)
|
|
* Package: YooKassa\Request
|
|
* Class Hierarchy:
|
|
* [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md)
|
|
* \YooKassa\Request\Deals\CreateDealRequestBuilder
|
|
|
|
* See Also:
|
|
* [](https://yookassa.ru/developers/api)
|
|
|
|
---
|
|
### Tags
|
|
| Tag | Version | Description |
|
|
| --- | ------- | ----------- |
|
|
| category | | Class |
|
|
| author | | cms@yoomoney.ru |
|
|
|
|
---
|
|
## Properties
|
|
<a name="property_currentObject"></a>
|
|
#### protected $currentObject : ?\YooKassa\Common\AbstractRequestInterface
|
|
---
|
|
**Summary**
|
|
|
|
Собираемый объект запроса.
|
|
|
|
**Type:** <a href="../?\YooKassa\Common\AbstractRequestInterface"><abbr title="?\YooKassa\Common\AbstractRequestInterface">AbstractRequestInterface</abbr></a>
|
|
|
|
**Details:**
|
|
|
|
|
|
|
|
---
|
|
## Methods
|
|
<a name="method___construct" class="anchor"></a>
|
|
#### public __construct() : mixed
|
|
|
|
```php
|
|
public __construct() : mixed
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Конструктор, инициализирует пустой запрос, который в будущем начнём собирать.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md)
|
|
|
|
**Returns:** mixed -
|
|
|
|
|
|
<a name="method_build" class="anchor"></a>
|
|
#### public build() : \YooKassa\Request\Deals\CreateDealRequestInterface|\YooKassa\Common\AbstractRequestInterface
|
|
|
|
```php
|
|
public build(array|null $options = null) : \YooKassa\Request\Deals\CreateDealRequestInterface|\YooKassa\Common\AbstractRequestInterface
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Осуществляет сборку объекта запроса к API.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Deals\CreateDealRequestBuilder](../classes/YooKassa-Request-Deals-CreateDealRequestBuilder.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">array OR null</code> | options | |
|
|
|
|
**Returns:** \YooKassa\Request\Deals\CreateDealRequestInterface|\YooKassa\Common\AbstractRequestInterface -
|
|
|
|
|
|
<a name="method_setDescription" class="anchor"></a>
|
|
#### public setDescription() : \YooKassa\Request\Deals\CreateDealRequestBuilder
|
|
|
|
```php
|
|
public setDescription(string|null $value) : \YooKassa\Request\Deals\CreateDealRequestBuilder
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает описание транзакции.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Deals\CreateDealRequestBuilder](../classes/YooKassa-Request-Deals-CreateDealRequestBuilder.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string OR null</code> | value | Описание транзакции |
|
|
|
|
**Returns:** \YooKassa\Request\Deals\CreateDealRequestBuilder - Инстанс текущего билдера
|
|
|
|
|
|
<a name="method_setFeeMoment" class="anchor"></a>
|
|
#### public setFeeMoment() : \YooKassa\Request\Deals\CreateDealRequestBuilder
|
|
|
|
```php
|
|
public setFeeMoment(string $value) : \YooKassa\Request\Deals\CreateDealRequestBuilder
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает момент перечисления вам вознаграждения платформы.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Deals\CreateDealRequestBuilder](../classes/YooKassa-Request-Deals-CreateDealRequestBuilder.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | value | Момент перечисления вам вознаграждения платформы |
|
|
|
|
**Returns:** \YooKassa\Request\Deals\CreateDealRequestBuilder - Инстанс текущего билдера
|
|
|
|
|
|
<a name="method_setMetadata" class="anchor"></a>
|
|
#### public setMetadata() : \YooKassa\Request\Deals\CreateDealRequestBuilder
|
|
|
|
```php
|
|
public setMetadata(null|array|\YooKassa\Model\Metadata $value) : \YooKassa\Request\Deals\CreateDealRequestBuilder
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает метаданные, привязанные к платежу.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Deals\CreateDealRequestBuilder](../classes/YooKassa-Request-Deals-CreateDealRequestBuilder.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">null OR array OR \YooKassa\Model\Metadata</code> | value | Метаданные платежа, устанавливаемые мерчантом |
|
|
|
|
**Returns:** \YooKassa\Request\Deals\CreateDealRequestBuilder - Инстанс текущего билдера
|
|
|
|
|
|
<a name="method_setOptions" class="anchor"></a>
|
|
#### public setOptions() : \YooKassa\Common\AbstractRequestBuilder
|
|
|
|
```php
|
|
public setOptions(iterable|null $options) : \YooKassa\Common\AbstractRequestBuilder
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает свойства запроса из массива.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">iterable OR null</code> | options | Массив свойств запроса |
|
|
|
|
##### Throws:
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| \InvalidArgumentException | Выбрасывается если аргумент не массив и не итерируемый объект |
|
|
| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданных в массиве настроек |
|
|
|
|
**Returns:** \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов
|
|
|
|
|
|
<a name="method_setType" class="anchor"></a>
|
|
#### public setType() : \YooKassa\Request\Deals\CreateDealRequestBuilder
|
|
|
|
```php
|
|
public setType(string $value) : \YooKassa\Request\Deals\CreateDealRequestBuilder
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает тип сделки.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Deals\CreateDealRequestBuilder](../classes/YooKassa-Request-Deals-CreateDealRequestBuilder.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | value | Тип сделки |
|
|
|
|
**Returns:** \YooKassa\Request\Deals\CreateDealRequestBuilder - Инстанс текущего билдера
|
|
|
|
|
|
<a name="method_initCurrentObject" class="anchor"></a>
|
|
#### protected initCurrentObject() : \YooKassa\Request\Deals\CreateDealRequest
|
|
|
|
```php
|
|
protected initCurrentObject() : \YooKassa\Request\Deals\CreateDealRequest
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Инициализирует объект запроса, который в дальнейшем будет собираться билдером
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Deals\CreateDealRequestBuilder](../classes/YooKassa-Request-Deals-CreateDealRequestBuilder.md)
|
|
|
|
**Returns:** \YooKassa\Request\Deals\CreateDealRequest - Инстанс собираемого объекта запроса к API
|
|
|
|
|
|
|
|
---
|
|
|
|
### Top Namespaces
|
|
|
|
* [\YooKassa](../namespaces/yookassa.md)
|
|
|
|
---
|
|
|
|
### Reports
|
|
* [Errors - 0](../reports/errors.md)
|
|
* [Markers - 0](../reports/markers.md)
|
|
* [Deprecated - 43](../reports/deprecated.md)
|
|
|
|
---
|
|
|
|
This document was automatically generated from source code comments on 2026-08-13 using [phpDocumentor](http://www.phpdoc.org/)
|
|
|
|
© 2026 YooMoney |