meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Model-RefundStatus.md

158 lines
4.1 KiB
Markdown
Raw Permalink Normal View History

# [YooKassa API SDK](../home.md)
# Class: \YooKassa\Model\RefundStatus
### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md)
---
**Summary:**
RefundStatus - Состояние возврата платежа
**Description:**
Возможные значения:
- `pending` - Ожидает обработки
- `succeeded` - Успешно возвращен
- `canceled` - В проведении возврата отказано
---
### Constants
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| public | [PENDING](../classes/YooKassa-Model-RefundStatus.md#constant_PENDING) | | |
| public | [SUCCEEDED](../classes/YooKassa-Model-RefundStatus.md#constant_SUCCEEDED) | | |
| public | [CANCELED](../classes/YooKassa-Model-RefundStatus.md#constant_CANCELED) | | |
---
### Properties
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| protected | [$validValues](../classes/YooKassa-Model-RefundStatus.md#property_validValues) | | |
---
### Methods
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены |
| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e |
| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e |
---
### Details
* File: [lib/Model/RefundStatus.php](../../lib/Model/RefundStatus.php)
* Package: YooKassa
* Class Hierarchy:
* [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md)
* \YooKassa\Model\RefundStatus
---
## Constants
<a name="constant_PENDING" class="anchor"></a>
###### PENDING
```php
PENDING = 'pending'
```
<a name="constant_SUCCEEDED" class="anchor"></a>
###### SUCCEEDED
```php
SUCCEEDED = 'succeeded'
```
<a name="constant_CANCELED" class="anchor"></a>
###### CANCELED
```php
CANCELED = 'canceled'
```
---
## Properties
<a name="property_validValues"></a>
#### protected $validValues : array
---
**Type:** <a href="array"><abbr title="array">array</abbr></a>
Массив принимаемых enum&#039;ом значений
**Details:**
---
## Methods
<a name="method_getEnabledValues" class="anchor"></a>
#### public getEnabledValues() : string[]
```php
Static public getEnabledValues() : string[]
```
**Summary**
Возвращает значения в enum'е значения которых разрешены
**Details:**
* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md)
**Returns:** string[] - Массив разрешённых значений
<a name="method_getValidValues" class="anchor"></a>
#### public getValidValues() : array
```php
Static public getValidValues() : array
```
**Summary**
Возвращает все значения в enum'e
**Details:**
* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md)
**Returns:** array - Массив значений в перечислении
<a name="method_valueExists" class="anchor"></a>
#### public valueExists() : bool
```php
Static public valueExists(mixed $value) : bool
```
**Summary**
Проверяет наличие значения в enum'e
**Details:**
* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">mixed</code> | value | Проверяемое значение |
**Returns:** bool - True если значение имеется, false если нет
---
### 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/)
&copy; 2023 YooMoney