mirror of
https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git
synced 2026-09-11 10:26:17 +00:00
Александра Д. Спиридонова
1164 lines
42 KiB
Markdown
1164 lines
42 KiB
Markdown
# [YooKassa API SDK](../home.md)
|
|
|
|
# Class: \YooKassa\Request\Refunds\CreateRefundRequest
|
|
### Namespace: [\YooKassa\Request\Refunds](../namespaces/yookassa-request-refunds.md)
|
|
---
|
|
**Summary:**
|
|
|
|
Класс, представляющий модель CreateRefundRequest.
|
|
|
|
**Description:**
|
|
|
|
Класс объекта запроса для создания возврата.
|
|
|
|
---
|
|
### Examples
|
|
Пример использования билдера
|
|
|
|
```php
|
|
try {
|
|
$refundBuilder = \YooKassa\Request\Refunds\CreateRefundRequest::builder();
|
|
$refundBuilder
|
|
->setPaymentId('24b94598-000f-5000-9000-1b68e7b15f3f')
|
|
->setAmount(3500.00)
|
|
->setCurrency(\YooKassa\Model\CurrencyCode::RUB)
|
|
->setDescription('Не подошел цвет')
|
|
->setReceiptItems([
|
|
(new \YooKassa\Model\Receipt\ReceiptItem)
|
|
->setDescription('Платок Gucci Новый')
|
|
->setQuantity(1)
|
|
->setVatCode(2)
|
|
->setPrice(new \YooKassa\Model\Receipt\ReceiptItemAmount(3500.00))
|
|
->setPaymentSubject(\YooKassa\Model\Receipt\PaymentSubject::COMMODITY)
|
|
->setPaymentMode(\YooKassa\Model\Receipt\PaymentMode::FULL_PAYMENT)
|
|
->setAgentType(\YooKassa\Model\Receipt\AgentType::BANKING_PAYMENT_AGENT)
|
|
->setSupplier([
|
|
'name' => 'ООО Поставщик',
|
|
'phone' => '79000000000',
|
|
'inn' => '6321341814',
|
|
])
|
|
])
|
|
->setReceiptEmail('john.doe@merchant.com')
|
|
->setTaxSystemCode(1)
|
|
;
|
|
|
|
// Создаем объект запроса
|
|
$request = $refundBuilder->build();
|
|
|
|
// Можно изменить данные, если нужно
|
|
$request->setDescription('Не подошел цвет и размер');
|
|
|
|
$idempotenceKey = uniqid('', true);
|
|
$response = $client->createRefund($request, $idempotenceKey);
|
|
} catch (Exception $e) {
|
|
$response = $e;
|
|
}
|
|
|
|
var_dump($response);
|
|
|
|
```
|
|
|
|
---
|
|
### Constants
|
|
* No constants found
|
|
|
|
---
|
|
### Properties
|
|
| Visibility | Name | Flag | Summary |
|
|
| ----------:| ---- | ---- | ------- |
|
|
| public | [$amount](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#property_amount) | | Сумма возврата |
|
|
| public | [$deal](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#property_deal) | | Информация о сделке |
|
|
| public | [$description](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#property_description) | | Комментарий к операции возврата, основание для возврата средств покупателю. |
|
|
| public | [$metadata](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#property_metadata) | | Метаданные возврата указанные мерчантом |
|
|
| public | [$payment_id](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#property_payment_id) | | Идентификатор платежа для которого создаётся возврат |
|
|
| public | [$paymentId](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#property_paymentId) | | Идентификатор платежа для которого создаётся возврат |
|
|
| public | [$receipt](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#property_receipt) | | Инстанс чека или null |
|
|
| public | [$refund_method_data](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#property_refund_method_data) | | Метод возврата |
|
|
| public | [$refundMethodData](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#property_refundMethodData) | | Метод возврата |
|
|
| public | [$sources](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#property_sources) | | Информация о распределении денег — сколько и в какой магазин нужно перевести |
|
|
| protected | [$_metadata](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#property__metadata) | | |
|
|
|
|
---
|
|
### Methods
|
|
| Visibility | Name | Flag | Summary |
|
|
| ----------:| ---- | ---- | ------- |
|
|
| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. |
|
|
| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства. |
|
|
| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства. |
|
|
| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства. |
|
|
| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство. |
|
|
| public | [builder()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_builder) | | Возвращает билдер объектов текущего типа. |
|
|
| public | [clearValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_clearValidationError) | | Очищает статус валидации текущего запроса. |
|
|
| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива. |
|
|
| public | [getAmount()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_getAmount) | | Возвращает сумму возврата. |
|
|
| public | [getDeal()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_getDeal) | | Возвращает данные о сделке, в составе которой проходит возврат |
|
|
| public | [getDescription()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_getDescription) | | Возвращает комментарий к возврату или null, если комментарий не задан. |
|
|
| public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации. |
|
|
| public | [getMetadata()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_getMetadata) | | Возвращает метаданные возврата. |
|
|
| public | [getPaymentId()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_getPaymentId) | | Возвращает идентификатор платежа для которого создаётся возврат средств. |
|
|
| public | [getReceipt()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_getReceipt) | | Возвращает чек, если он есть. |
|
|
| public | [getRefundMethodData()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_getRefundMethodData) | | Возвращает метод возврата. |
|
|
| public | [getSources()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_getSources) | | Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести. |
|
|
| public | [getValidator()](../classes/YooKassa-Common-AbstractObject.md#method_getValidator) | | |
|
|
| public | [hasAmount()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_hasAmount) | | Проверяет, была ли установлена сумма возврата. |
|
|
| public | [hasDeal()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_hasDeal) | | Проверяет, были ли установлены данные о сделке. |
|
|
| public | [hasDescription()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_hasDescription) | | Проверяет задан ли комментарий к создаваемому возврату. |
|
|
| public | [hasMetadata()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_hasMetadata) | | Проверяет, были ли установлены метаданные возврата. |
|
|
| public | [hasPaymentId()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_hasPaymentId) | | Проверяет, был ли установлена идентификатор платежа. |
|
|
| public | [hasReceipt()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_hasReceipt) | | Проверяет наличие чека. |
|
|
| public | [hasRefundMethodData()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_hasRefundMethodData) | | Проверяет установлен ли объект с методом возврата. |
|
|
| public | [hasSources()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_hasSources) | | Проверяет наличие информации о распределении денег. |
|
|
| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации. |
|
|
| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства. |
|
|
| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства. |
|
|
| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства. |
|
|
| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство. |
|
|
| public | [removeReceipt()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_removeReceipt) | | Удаляет чек из запроса. |
|
|
| public | [setAmount()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_setAmount) | | Устанавливает сумму. |
|
|
| public | [setDeal()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_setDeal) | | Устанавливает данные о сделке, в составе которой проходит возврат |
|
|
| public | [setDescription()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_setDescription) | | Устанавливает комментарий к возврату. |
|
|
| public | [setMetadata()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_setMetadata) | | Устанавливает метаданные возврата. |
|
|
| public | [setPaymentId()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_setPaymentId) | | Устанавливает идентификатор платежа для которого создаётся возврат |
|
|
| public | [setReceipt()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_setReceipt) | | Устанавливает чек. |
|
|
| public | [setRefundMethodData()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_setRefundMethodData) | | Устанавливает метод возврата. |
|
|
| public | [setSources()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_setSources) | | Устанавливает sources (массив распределения денег между магазинами). |
|
|
| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize(). |
|
|
| public | [validate()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_validate) | | Валидирует объект запроса. |
|
|
| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта. |
|
|
| protected | [setValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_setValidationError) | | Устанавливает ошибку валидации. |
|
|
| protected | [validatePropertyValue()](../classes/YooKassa-Common-AbstractObject.md#method_validatePropertyValue) | | |
|
|
|
|
---
|
|
### Details
|
|
* File: [lib/Request/Refunds/CreateRefundRequest.php](../../lib/Request/Refunds/CreateRefundRequest.php)
|
|
* Package: YooKassa\Request
|
|
* Class Hierarchy:
|
|
* [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
* [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md)
|
|
* \YooKassa\Request\Refunds\CreateRefundRequest
|
|
* Implements:
|
|
* [\YooKassa\Request\Refunds\CreateRefundRequestInterface](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md)
|
|
|
|
* See Also:
|
|
* [](https://yookassa.ru/developers/api)
|
|
|
|
---
|
|
### Tags
|
|
| Tag | Version | Description |
|
|
| --- | ------- | ----------- |
|
|
| category | | Class |
|
|
| author | | cms@yoomoney.ru |
|
|
|
|
---
|
|
## Properties
|
|
<a name="property_amount"></a>
|
|
#### public $amount : \YooKassa\Model\AmountInterface
|
|
---
|
|
***Description***
|
|
|
|
Сумма возврата
|
|
|
|
**Type:** <a href="../classes/YooKassa-Model-AmountInterface.html"><abbr title="\YooKassa\Model\AmountInterface">AmountInterface</abbr></a>
|
|
|
|
**Details:**
|
|
|
|
|
|
<a name="property_deal"></a>
|
|
#### public $deal : null|\YooKassa\Model\Deal\RefundDealData
|
|
---
|
|
***Description***
|
|
|
|
Информация о сделке
|
|
|
|
**Type:** <a href="../null|\YooKassa\Model\Deal\RefundDealData"><abbr title="null|\YooKassa\Model\Deal\RefundDealData">RefundDealData</abbr></a>
|
|
|
|
**Details:**
|
|
|
|
|
|
<a name="property_description"></a>
|
|
#### public $description : string
|
|
---
|
|
***Description***
|
|
|
|
Комментарий к операции возврата, основание для возврата средств покупателю.
|
|
|
|
**Type:** <a href="../string"><abbr title="string">string</abbr></a>
|
|
|
|
**Details:**
|
|
|
|
|
|
<a name="property_metadata"></a>
|
|
#### public $metadata : \YooKassa\Model\Metadata|null
|
|
---
|
|
***Description***
|
|
|
|
Метаданные возврата указанные мерчантом
|
|
|
|
**Type:** <a href="../\YooKassa\Model\Metadata|null"><abbr title="\YooKassa\Model\Metadata|null">Metadata|null</abbr></a>
|
|
|
|
**Details:**
|
|
|
|
|
|
<a name="property_payment_id"></a>
|
|
#### public $payment_id : string
|
|
---
|
|
***Description***
|
|
|
|
Идентификатор платежа для которого создаётся возврат
|
|
|
|
**Type:** <a href="../string"><abbr title="string">string</abbr></a>
|
|
|
|
**Details:**
|
|
|
|
|
|
<a name="property_paymentId"></a>
|
|
#### public $paymentId : string
|
|
---
|
|
***Description***
|
|
|
|
Идентификатор платежа для которого создаётся возврат
|
|
|
|
**Type:** <a href="../string"><abbr title="string">string</abbr></a>
|
|
|
|
**Details:**
|
|
|
|
|
|
<a name="property_receipt"></a>
|
|
#### public $receipt : null|\YooKassa\Model\Receipt\ReceiptInterface
|
|
---
|
|
***Description***
|
|
|
|
Инстанс чека или null
|
|
|
|
**Type:** <a href="../null|\YooKassa\Model\Receipt\ReceiptInterface"><abbr title="null|\YooKassa\Model\Receipt\ReceiptInterface">ReceiptInterface</abbr></a>
|
|
|
|
**Details:**
|
|
|
|
|
|
<a name="property_refund_method_data"></a>
|
|
#### public $refund_method_data : null|\YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData
|
|
---
|
|
***Description***
|
|
|
|
Метод возврата
|
|
|
|
**Type:** <a href="../null|\YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData"><abbr title="null|\YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData">AbstractRefundMethodData</abbr></a>
|
|
|
|
**Details:**
|
|
|
|
|
|
<a name="property_refundMethodData"></a>
|
|
#### public $refundMethodData : null|\YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData
|
|
---
|
|
***Description***
|
|
|
|
Метод возврата
|
|
|
|
**Type:** <a href="../null|\YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData"><abbr title="null|\YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData">AbstractRefundMethodData</abbr></a>
|
|
|
|
**Details:**
|
|
|
|
|
|
<a name="property_sources"></a>
|
|
#### public $sources : null|\YooKassa\Common\ListObjectInterface|\YooKassa\Model\Refund\SourceInterface[]
|
|
---
|
|
***Description***
|
|
|
|
Информация о распределении денег — сколько и в какой магазин нужно перевести
|
|
|
|
**Type:** <a href="../null|\YooKassa\Common\ListObjectInterface|\YooKassa\Model\Refund\SourceInterface[]"><abbr title="null|\YooKassa\Common\ListObjectInterface|\YooKassa\Model\Refund\SourceInterface[]">SourceInterface[]</abbr></a>
|
|
|
|
**Details:**
|
|
|
|
|
|
<a name="property__metadata"></a>
|
|
#### protected $_metadata : ?\YooKassa\Model\Metadata
|
|
---
|
|
**Type:** <a href="../?\YooKassa\Model\Metadata"><abbr title="?\YooKassa\Model\Metadata">Metadata</abbr></a>
|
|
Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.
|
|
**Details:**
|
|
|
|
|
|
|
|
---
|
|
## Methods
|
|
<a name="method___construct" class="anchor"></a>
|
|
#### public __construct() : mixed
|
|
|
|
```php
|
|
public __construct(array|null $data = []) : mixed
|
|
```
|
|
|
|
**Summary**
|
|
|
|
AbstractObject constructor.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">array OR null</code> | data | |
|
|
|
|
**Returns:** mixed -
|
|
|
|
|
|
<a name="method___get" class="anchor"></a>
|
|
#### public __get() : mixed
|
|
|
|
```php
|
|
public __get(string $propertyName) : mixed
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает значение свойства.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | propertyName | Имя свойства |
|
|
|
|
**Returns:** mixed - Значение свойства
|
|
|
|
|
|
<a name="method___isset" class="anchor"></a>
|
|
#### public __isset() : bool
|
|
|
|
```php
|
|
public __isset(string $propertyName) : bool
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Проверяет наличие свойства.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | propertyName | Имя проверяемого свойства |
|
|
|
|
**Returns:** bool - True если свойство имеется, false если нет
|
|
|
|
|
|
<a name="method___set" class="anchor"></a>
|
|
#### public __set() : void
|
|
|
|
```php
|
|
public __set(string $propertyName, mixed $value) : void
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает значение свойства.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | propertyName | Имя свойства |
|
|
| <code lang="php">mixed</code> | value | Значение свойства |
|
|
|
|
**Returns:** void -
|
|
|
|
|
|
<a name="method___unset" class="anchor"></a>
|
|
#### public __unset() : void
|
|
|
|
```php
|
|
public __unset(string $propertyName) : void
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Удаляет свойство.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | propertyName | Имя удаляемого свойства |
|
|
|
|
**Returns:** void -
|
|
|
|
|
|
<a name="method_builder" class="anchor"></a>
|
|
#### public builder() : \YooKassa\Request\Refunds\CreateRefundRequestBuilder
|
|
|
|
```php
|
|
Static public builder() : \YooKassa\Request\Refunds\CreateRefundRequestBuilder
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает билдер объектов текущего типа.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** \YooKassa\Request\Refunds\CreateRefundRequestBuilder - Инстанс билдера запросов
|
|
|
|
|
|
<a name="method_clearValidationError" class="anchor"></a>
|
|
#### public clearValidationError() : void
|
|
|
|
```php
|
|
public clearValidationError() : void
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Очищает статус валидации текущего запроса.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md)
|
|
|
|
**Returns:** void -
|
|
|
|
|
|
<a name="method_fromArray" class="anchor"></a>
|
|
#### public fromArray() : void
|
|
|
|
```php
|
|
public fromArray(array|\Traversable $sourceArray) : void
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает значения свойств текущего объекта из массива.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">array OR \Traversable</code> | sourceArray | Ассоциативный массив с настройками |
|
|
|
|
**Returns:** void -
|
|
|
|
|
|
<a name="method_getAmount" class="anchor"></a>
|
|
#### public getAmount() : \YooKassa\Model\AmountInterface|null
|
|
|
|
```php
|
|
public getAmount() : \YooKassa\Model\AmountInterface|null
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает сумму возврата.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** \YooKassa\Model\AmountInterface|null - Сумма возврата
|
|
|
|
|
|
<a name="method_getDeal" class="anchor"></a>
|
|
#### public getDeal() : \YooKassa\Model\Deal\RefundDealData|null
|
|
|
|
```php
|
|
public getDeal() : \YooKassa\Model\Deal\RefundDealData|null
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает данные о сделке, в составе которой проходит возврат
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** \YooKassa\Model\Deal\RefundDealData|null - Данные о сделке, в составе которой проходит возврат
|
|
|
|
|
|
<a name="method_getDescription" class="anchor"></a>
|
|
#### public getDescription() : string|null
|
|
|
|
```php
|
|
public getDescription() : string|null
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает комментарий к возврату или null, если комментарий не задан.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** string|null - Комментарий к операции возврата, основание для возврата средств покупателю
|
|
|
|
|
|
<a name="method_getLastValidationError" class="anchor"></a>
|
|
#### public getLastValidationError() : string|null
|
|
|
|
```php
|
|
public getLastValidationError() : string|null
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает последнюю ошибку валидации.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md)
|
|
|
|
**Returns:** string|null - Последняя произошедшая ошибка валидации
|
|
|
|
|
|
<a name="method_getMetadata" class="anchor"></a>
|
|
#### public getMetadata() : \YooKassa\Model\Metadata|null
|
|
|
|
```php
|
|
public getMetadata() : \YooKassa\Model\Metadata|null
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает метаданные возврата.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** \YooKassa\Model\Metadata|null -
|
|
|
|
|
|
<a name="method_getPaymentId" class="anchor"></a>
|
|
#### public getPaymentId() : string|null
|
|
|
|
```php
|
|
public getPaymentId() : string|null
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает идентификатор платежа для которого создаётся возврат средств.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** string|null - Идентификатор платежа для которого создаётся возврат
|
|
|
|
|
|
<a name="method_getReceipt" class="anchor"></a>
|
|
#### public getReceipt() : null|\YooKassa\Model\Receipt\ReceiptInterface
|
|
|
|
```php
|
|
public getReceipt() : null|\YooKassa\Model\Receipt\ReceiptInterface
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает чек, если он есть.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** null|\YooKassa\Model\Receipt\ReceiptInterface - Данные фискального чека 54-ФЗ или null, если чека нет
|
|
|
|
|
|
<a name="method_getRefundMethodData" class="anchor"></a>
|
|
#### public getRefundMethodData() : \YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData|null
|
|
|
|
```php
|
|
public getRefundMethodData() : \YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData|null
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает метод возврата.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** \YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData|null - Метод возврата
|
|
|
|
|
|
<a name="method_getSources" class="anchor"></a>
|
|
#### public getSources() : \YooKassa\Model\Refund\SourceInterface[]|\YooKassa\Common\ListObjectInterface
|
|
|
|
```php
|
|
public getSources() : \YooKassa\Model\Refund\SourceInterface[]|\YooKassa\Common\ListObjectInterface
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** \YooKassa\Model\Refund\SourceInterface[]|\YooKassa\Common\ListObjectInterface - Информация о распределении денег
|
|
|
|
|
|
<a name="method_getValidator" class="anchor"></a>
|
|
#### public getValidator() : \YooKassa\Validator\Validator
|
|
|
|
```php
|
|
public getValidator() : \YooKassa\Validator\Validator
|
|
```
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
**Returns:** \YooKassa\Validator\Validator -
|
|
|
|
|
|
<a name="method_hasAmount" class="anchor"></a>
|
|
#### public hasAmount() : bool
|
|
|
|
```php
|
|
public hasAmount() : bool
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Проверяет, была ли установлена сумма возврата.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** bool - True если сумма возврата была установлена, false если нет
|
|
|
|
|
|
<a name="method_hasDeal" class="anchor"></a>
|
|
#### public hasDeal() : bool
|
|
|
|
```php
|
|
public hasDeal() : bool
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Проверяет, были ли установлены данные о сделке.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** bool - True если данные о сделке были установлены, false если нет
|
|
|
|
|
|
<a name="method_hasDescription" class="anchor"></a>
|
|
#### public hasDescription() : bool
|
|
|
|
```php
|
|
public hasDescription() : bool
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Проверяет задан ли комментарий к создаваемому возврату.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** bool - True если комментарий установлен, false если нет
|
|
|
|
|
|
<a name="method_hasMetadata" class="anchor"></a>
|
|
#### public hasMetadata() : bool
|
|
|
|
```php
|
|
public hasMetadata() : bool
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Проверяет, были ли установлены метаданные возврата.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** bool - True если метаданные были установлены, false если нет
|
|
|
|
|
|
<a name="method_hasPaymentId" class="anchor"></a>
|
|
#### public hasPaymentId() : bool
|
|
|
|
```php
|
|
public hasPaymentId() : bool
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Проверяет, был ли установлена идентификатор платежа.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** bool - True если идентификатор платежа был установлен, false если нет
|
|
|
|
|
|
<a name="method_hasReceipt" class="anchor"></a>
|
|
#### public hasReceipt() : bool
|
|
|
|
```php
|
|
public hasReceipt() : bool
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Проверяет наличие чека.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** bool - True если чек есть, false если нет
|
|
|
|
|
|
<a name="method_hasRefundMethodData" class="anchor"></a>
|
|
#### public hasRefundMethodData() : bool
|
|
|
|
```php
|
|
public hasRefundMethodData() : bool
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Проверяет установлен ли объект с методом возврата.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** bool - True если объект метода возврата установлен, false если нет
|
|
|
|
|
|
<a name="method_hasSources" class="anchor"></a>
|
|
#### public hasSources() : bool
|
|
|
|
```php
|
|
public hasSources() : bool
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Проверяет наличие информации о распределении денег.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** bool -
|
|
|
|
|
|
<a name="method_jsonSerialize" class="anchor"></a>
|
|
#### public jsonSerialize() : array
|
|
|
|
```php
|
|
public jsonSerialize() : array
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
**Returns:** array - Ассоциативный массив со свойствами текущего объекта
|
|
|
|
|
|
<a name="method_offsetExists" class="anchor"></a>
|
|
#### public offsetExists() : bool
|
|
|
|
```php
|
|
public offsetExists(string $offset) : bool
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Проверяет наличие свойства.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | offset | Имя проверяемого свойства |
|
|
|
|
**Returns:** bool - True если свойство имеется, false если нет
|
|
|
|
|
|
<a name="method_offsetGet" class="anchor"></a>
|
|
#### public offsetGet() : mixed
|
|
|
|
```php
|
|
public offsetGet(string $offset) : mixed
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает значение свойства.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | offset | Имя свойства |
|
|
|
|
**Returns:** mixed - Значение свойства
|
|
|
|
|
|
<a name="method_offsetSet" class="anchor"></a>
|
|
#### public offsetSet() : void
|
|
|
|
```php
|
|
public offsetSet(string $offset, mixed $value) : void
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает значение свойства.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | offset | Имя свойства |
|
|
| <code lang="php">mixed</code> | value | Значение свойства |
|
|
|
|
**Returns:** void -
|
|
|
|
|
|
<a name="method_offsetUnset" class="anchor"></a>
|
|
#### public offsetUnset() : void
|
|
|
|
```php
|
|
public offsetUnset(string $offset) : void
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Удаляет свойство.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | offset | Имя удаляемого свойства |
|
|
|
|
**Returns:** void -
|
|
|
|
|
|
<a name="method_removeReceipt" class="anchor"></a>
|
|
#### public removeReceipt() : void
|
|
|
|
```php
|
|
public removeReceipt() : void
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Удаляет чек из запроса.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** void -
|
|
|
|
|
|
<a name="method_setAmount" class="anchor"></a>
|
|
#### public setAmount() : self
|
|
|
|
```php
|
|
public setAmount(\YooKassa\Model\AmountInterface|array|string $amount = null) : self
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает сумму.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">\YooKassa\Model\AmountInterface OR array OR string</code> | amount | Сумма возврата |
|
|
|
|
**Returns:** self -
|
|
|
|
|
|
<a name="method_setDeal" class="anchor"></a>
|
|
#### public setDeal() : self
|
|
|
|
```php
|
|
public setDeal(null|array|\YooKassa\Model\Deal\RefundDealData $deal = null) : self
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает данные о сделке, в составе которой проходит возврат
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">null OR array OR \YooKassa\Model\Deal\RefundDealData</code> | deal | Данные о сделке, в составе которой проходит возврат |
|
|
|
|
**Returns:** self -
|
|
|
|
|
|
<a name="method_setDescription" class="anchor"></a>
|
|
#### public setDescription() : self
|
|
|
|
```php
|
|
public setDescription(string|null $description = null) : self
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает комментарий к возврату.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string OR null</code> | description | Комментарий к операции возврата, основание для возврата средств покупателю |
|
|
|
|
**Returns:** self -
|
|
|
|
|
|
<a name="method_setMetadata" class="anchor"></a>
|
|
#### public setMetadata() : self
|
|
|
|
```php
|
|
public setMetadata(\YooKassa\Model\Metadata|array|null $metadata = null) : self
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает метаданные возврата.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">\YooKassa\Model\Metadata OR array OR null</code> | metadata | Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. |
|
|
|
|
**Returns:** self -
|
|
|
|
|
|
<a name="method_setPaymentId" class="anchor"></a>
|
|
#### public setPaymentId() : self
|
|
|
|
```php
|
|
public setPaymentId(string|null $payment_id = null) : self
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает идентификатор платежа для которого создаётся возврат
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string OR null</code> | payment_id | Идентификатор платежа |
|
|
|
|
**Returns:** self -
|
|
|
|
|
|
<a name="method_setReceipt" class="anchor"></a>
|
|
#### public setReceipt() : self
|
|
|
|
```php
|
|
public setReceipt(null|array|\YooKassa\Model\Receipt\ReceiptInterface $receipt = null) : self
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает чек.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">null OR array OR \YooKassa\Model\Receipt\ReceiptInterface</code> | receipt | Инстанс чека или null для удаления информации о чеке |
|
|
|
|
**Returns:** self -
|
|
|
|
|
|
<a name="method_setRefundMethodData" class="anchor"></a>
|
|
#### public setRefundMethodData() : self
|
|
|
|
```php
|
|
public setRefundMethodData(\YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData|array|null $refund_method_data = null) : self
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает метод возврата.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">\YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData OR array OR null</code> | refund_method_data | Метод возврата |
|
|
|
|
**Returns:** self -
|
|
|
|
|
|
<a name="method_setSources" class="anchor"></a>
|
|
#### public setSources() : self
|
|
|
|
```php
|
|
public setSources(array|\YooKassa\Common\ListObjectInterface|null $sources = null) : self
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает sources (массив распределения денег между магазинами).
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">array OR \YooKassa\Common\ListObjectInterface OR null</code> | sources | Массив распределения денег между магазинами |
|
|
|
|
**Returns:** self -
|
|
|
|
|
|
<a name="method_toArray" class="anchor"></a>
|
|
#### public toArray() : array
|
|
|
|
```php
|
|
public toArray() : array
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации
|
|
Является алиасом метода AbstractObject::jsonSerialize().
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
**Returns:** array - Ассоциативный массив со свойствами текущего объекта
|
|
|
|
|
|
<a name="method_validate" class="anchor"></a>
|
|
#### public validate() : bool
|
|
|
|
```php
|
|
public validate() : bool
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Валидирует объект запроса.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md)
|
|
|
|
**Returns:** bool - True если запрос валиден и его можно отправить в API, false если нет
|
|
|
|
|
|
<a name="method_getUnknownProperties" class="anchor"></a>
|
|
#### protected getUnknownProperties() : array
|
|
|
|
```php
|
|
protected getUnknownProperties() : array
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает массив свойств которые не существуют, но были заданы у объекта.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами
|
|
|
|
|
|
<a name="method_setValidationError" class="anchor"></a>
|
|
#### protected setValidationError() : void
|
|
|
|
```php
|
|
protected setValidationError(string $value) : void
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает ошибку валидации.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | value | Ошибка, произошедшая при валидации объекта |
|
|
|
|
**Returns:** void -
|
|
|
|
|
|
<a name="method_validatePropertyValue" class="anchor"></a>
|
|
#### protected validatePropertyValue() : mixed
|
|
|
|
```php
|
|
protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed
|
|
```
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | propertyName | |
|
|
| <code lang="php">mixed</code> | propertyValue | |
|
|
|
|
**Returns:** mixed -
|
|
|
|
|
|
|
|
---
|
|
|
|
### 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 |