622 lines
20 KiB
Markdown
622 lines
20 KiB
Markdown
# [YooKassa API SDK](../home.md)
|
||
|
||
# Class: \YooKassa\Common\AbstractRefundRequest
|
||
### Namespace: [\YooKassa\Common](../namespaces/yookassa-common.md)
|
||
---
|
||
**Summary:**
|
||
|
||
Класс объекта запроса к API
|
||
|
||
|
||
---
|
||
### Constants
|
||
* No constants found
|
||
|
||
---
|
||
### Properties
|
||
| Visibility | Name | Flag | Summary |
|
||
| ----------:| ---- | ---- | ------- |
|
||
| public | [$amount](../classes/YooKassa-Common-AbstractRefundRequest.md#property_amount) | | Сумма возврата |
|
||
| public | [$paymentId](../classes/YooKassa-Common-AbstractRefundRequest.md#property_paymentId) | | Идентификатор платежа для которого создаётся возврат |
|
||
|
||
---
|
||
### 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 | [clearValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_clearValidationError) | | Очищает статус валидации текущего запроса |
|
||
| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива |
|
||
| public | [getAmount()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_getAmount) | | Возвращает сумму возврата |
|
||
| public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации |
|
||
| public | [getPaymentId()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_getPaymentId) | | Возвращает идентификатор платежа для которого создаётся возврат средств |
|
||
| public | [getReceipt()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_getReceipt) | | Возвращает чек, если он есть |
|
||
| public | [hasAmount()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_hasAmount) | | Проверяет, была ли установлена сумма возврата |
|
||
| public | [hasPaymentId()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_hasPaymentId) | | Проверяет, был ли установлена идентификатор платежа |
|
||
| public | [hasReceipt()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_hasReceipt) | | Проверяет наличие чека |
|
||
| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | |
|
||
| 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 | [setAmount()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_setAmount) | | Устанавливает сумму |
|
||
| public | [setPaymentId()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_setPaymentId) | | Устанавливает идентификатор платежа для которого создаётся возврат |
|
||
| public | [setReceipt()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_setReceipt) | | Устанавливает чек |
|
||
| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() |
|
||
| public | [validate()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_validate) | | Валидирует объект запроса |
|
||
| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта |
|
||
| protected | [setValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_setValidationError) | | Устанавливает ошибку валидации |
|
||
|
||
---
|
||
### Details
|
||
* File: [lib/Common/AbstractRefundRequest.php](../../lib/Common/AbstractRefundRequest.php)
|
||
* Package: YooKassa
|
||
* Class Hierarchy:
|
||
* [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
||
* [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md)
|
||
* \YooKassa\Common\AbstractRefundRequest
|
||
|
||
---
|
||
### Tags
|
||
| Tag | Version | Description |
|
||
| --- | ------- | ----------- |
|
||
| since | 2.1.0 | |
|
||
|
||
---
|
||
## 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_paymentId"></a>
|
||
#### public $paymentId : string
|
||
---
|
||
***Description***
|
||
|
||
Идентификатор платежа для которого создаётся возврат
|
||
|
||
**Type:** <a href="string"><abbr title="string">string</abbr></a>
|
||
|
||
**Details:**
|
||
|
||
|
||
|
||
---
|
||
## Methods
|
||
<a name="method___construct" class="anchor"></a>
|
||
#### public __construct() : mixed
|
||
|
||
```php
|
||
public __construct(array $data = array()) : mixed
|
||
```
|
||
|
||
**Summary**
|
||
|
||
AbstractObject constructor.
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
||
|
||
##### Parameters:
|
||
| Type | Name | Description |
|
||
| ---- | ---- | ----------- |
|
||
| <code lang="php">array</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() : mixed
|
||
|
||
```php
|
||
public __set(string $propertyName, mixed $value) : mixed
|
||
```
|
||
|
||
**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:** mixed -
|
||
|
||
|
||
<a name="method___unset" class="anchor"></a>
|
||
#### public __unset() : mixed
|
||
|
||
```php
|
||
public __unset(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_clearValidationError" class="anchor"></a>
|
||
#### public clearValidationError() : mixed
|
||
|
||
```php
|
||
public clearValidationError() : mixed
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Очищает статус валидации текущего запроса
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md)
|
||
|
||
**Returns:** mixed -
|
||
|
||
|
||
<a name="method_fromArray" class="anchor"></a>
|
||
#### public fromArray() : mixed
|
||
|
||
```php
|
||
public fromArray(array|\Traversable $sourceArray) : mixed
|
||
```
|
||
|
||
**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:** mixed -
|
||
|
||
|
||
<a name="method_getAmount" class="anchor"></a>
|
||
#### public getAmount() : \YooKassa\Model\AmountInterface
|
||
|
||
```php
|
||
public getAmount() : \YooKassa\Model\AmountInterface
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Возвращает сумму возврата
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.md)
|
||
|
||
**Returns:** \YooKassa\Model\AmountInterface - Сумма возврата
|
||
|
||
|
||
<a name="method_getLastValidationError" class="anchor"></a>
|
||
#### public getLastValidationError() : string
|
||
|
||
```php
|
||
public getLastValidationError() : string
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Возвращает последнюю ошибку валидации
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md)
|
||
|
||
**Returns:** string - Последняя произошедшая ошибка валидации
|
||
|
||
|
||
<a name="method_getPaymentId" class="anchor"></a>
|
||
#### public getPaymentId() : string
|
||
|
||
```php
|
||
public getPaymentId() : string
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Возвращает идентификатор платежа для которого создаётся возврат средств
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.md)
|
||
|
||
**Returns:** string - Идентификатор платежа для которого создаётся возврат
|
||
|
||
|
||
<a name="method_getReceipt" class="anchor"></a>
|
||
#### public getReceipt() : \YooKassa\Model\ReceiptInterface|null
|
||
|
||
```php
|
||
public getReceipt() : \YooKassa\Model\ReceiptInterface|null
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Возвращает чек, если он есть
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.md)
|
||
|
||
**Returns:** \YooKassa\Model\ReceiptInterface|null - Данные фискального чека 54-ФЗ или null, если чека нет
|
||
|
||
|
||
<a name="method_hasAmount" class="anchor"></a>
|
||
#### public hasAmount() : bool
|
||
|
||
```php
|
||
public hasAmount() : bool
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Проверяет, была ли установлена сумма возврата
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.md)
|
||
|
||
**Returns:** bool - True если сумма возврата была установлена, false если нет
|
||
|
||
|
||
<a name="method_hasPaymentId" class="anchor"></a>
|
||
#### public hasPaymentId() : bool
|
||
|
||
```php
|
||
public hasPaymentId() : bool
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Проверяет, был ли установлена идентификатор платежа
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.md)
|
||
|
||
**Returns:** bool - True если идентификатор платежа был установлен, false если нет
|
||
|
||
|
||
<a name="method_hasReceipt" class="anchor"></a>
|
||
#### public hasReceipt() : bool
|
||
|
||
```php
|
||
public hasReceipt() : bool
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Проверяет наличие чека
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.md)
|
||
|
||
**Returns:** bool - True если чек есть, false если нет
|
||
|
||
|
||
<a name="method_jsonSerialize" class="anchor"></a>
|
||
#### public jsonSerialize() : mixed
|
||
|
||
```php
|
||
public jsonSerialize() : mixed
|
||
```
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
||
|
||
**Returns:** mixed -
|
||
|
||
|
||
<a name="method_offsetExists" class="anchor"></a>
|
||
#### public offsetExists() : mixed
|
||
|
||
```php
|
||
public offsetExists(mixed $offset) : mixed
|
||
```
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
||
|
||
##### Parameters:
|
||
| Type | Name | Description |
|
||
| ---- | ---- | ----------- |
|
||
| <code lang="php">mixed</code> | offset | |
|
||
|
||
**Returns:** mixed -
|
||
|
||
|
||
<a name="method_offsetGet" class="anchor"></a>
|
||
#### public offsetGet() : mixed
|
||
|
||
```php
|
||
public offsetGet(mixed $offset) : mixed
|
||
```
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
||
|
||
##### Parameters:
|
||
| Type | Name | Description |
|
||
| ---- | ---- | ----------- |
|
||
| <code lang="php">mixed</code> | offset | |
|
||
|
||
**Returns:** mixed -
|
||
|
||
|
||
<a name="method_offsetSet" class="anchor"></a>
|
||
#### public offsetSet() : mixed
|
||
|
||
```php
|
||
public offsetSet(mixed $offset, mixed $value) : mixed
|
||
```
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
||
|
||
##### Parameters:
|
||
| Type | Name | Description |
|
||
| ---- | ---- | ----------- |
|
||
| <code lang="php">mixed</code> | offset | |
|
||
| <code lang="php">mixed</code> | value | |
|
||
|
||
**Returns:** mixed -
|
||
|
||
|
||
<a name="method_offsetUnset" class="anchor"></a>
|
||
#### public offsetUnset() : mixed
|
||
|
||
```php
|
||
public offsetUnset(mixed $offset) : mixed
|
||
```
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
||
|
||
##### Parameters:
|
||
| Type | Name | Description |
|
||
| ---- | ---- | ----------- |
|
||
| <code lang="php">mixed</code> | offset | |
|
||
|
||
**Returns:** mixed -
|
||
|
||
|
||
<a name="method_setAmount" class="anchor"></a>
|
||
#### public setAmount() : self
|
||
|
||
```php
|
||
public setAmount(\YooKassa\Model\AmountInterface|array|string $value) : self
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Устанавливает сумму
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.md)
|
||
|
||
##### Parameters:
|
||
| Type | Name | Description |
|
||
| ---- | ---- | ----------- |
|
||
| <code lang="php">\YooKassa\Model\AmountInterface OR array OR string</code> | value | Сумма возврата |
|
||
|
||
**Returns:** self - Инстанс билдера запросов
|
||
|
||
|
||
<a name="method_setPaymentId" class="anchor"></a>
|
||
#### public setPaymentId() : mixed
|
||
|
||
```php
|
||
public setPaymentId(string $value) : mixed
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Устанавливает идентификатор платежа для которого создаётся возврат
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.md)
|
||
|
||
##### Parameters:
|
||
| Type | Name | Description |
|
||
| ---- | ---- | ----------- |
|
||
| <code lang="php">string</code> | value | Идентификатор платежа |
|
||
|
||
##### Throws:
|
||
| Type | Description |
|
||
| ---- | ----------- |
|
||
| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если передано пустое значение идентификатора платежа |
|
||
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение является строкой, но не является валидным значением идентификатора платежа |
|
||
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если передано значение не валидного типа |
|
||
|
||
**Returns:** mixed -
|
||
|
||
|
||
<a name="method_setReceipt" class="anchor"></a>
|
||
#### public setReceipt() : mixed
|
||
|
||
```php
|
||
public setReceipt(\YooKassa\Model\ReceiptInterface|array|null $value) : mixed
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Устанавливает чек
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.md)
|
||
|
||
##### Parameters:
|
||
| Type | Name | Description |
|
||
| ---- | ---- | ----------- |
|
||
| <code lang="php">\YooKassa\Model\ReceiptInterface OR array OR null</code> | value | Инстанс чека или null для удаления информации о чеке |
|
||
|
||
##### Throws:
|
||
| Type | Description |
|
||
| ---- | ----------- |
|
||
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если передан не инстанс класса чека и не null |
|
||
|
||
**Returns:** mixed -
|
||
|
||
|
||
<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\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.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() : mixed
|
||
|
||
```php
|
||
protected setValidationError(string $value) : mixed
|
||
```
|
||
|
||
**Summary**
|
||
|
||
Устанавливает ошибку валидации
|
||
|
||
**Details:**
|
||
* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md)
|
||
|
||
##### Parameters:
|
||
| Type | Name | Description |
|
||
| ---- | ---- | ----------- |
|
||
| <code lang="php">string</code> | value | Ошибка, произошедшая при валидации объекта |
|
||
|
||
**Returns:** mixed -
|
||
|
||
|
||
|
||
---
|
||
|
||
### Top Namespaces
|
||
|
||
* [\YooKassa](../namespaces/yookassa.md)
|
||
|
||
---
|
||
|
||
### Reports
|
||
* [Errors - 0](../reports/errors.md)
|
||
* [Markers - 1](../reports/markers.md)
|
||
* [Deprecated - 25](../reports/deprecated.md)
|
||
|
||
---
|
||
|
||
This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/)
|
||
|
||
© 2023 YooMoney |