Files
yookassa-sdk-php/docs/classes/YooKassa-Request-Refunds-RefundMethodData-RefundMethodDataElectronicCertificate.md

590 lines
25 KiB
Markdown

# [YooKassa API SDK](../home.md)
# Class: \YooKassa\Request\Refunds\RefundMethodData\RefundMethodDataElectronicCertificate
### Namespace: [\YooKassa\Request\Refunds\RefundMethodData](../namespaces/yookassa-request-refunds-refundmethoddata.md)
---
**Summary:**
Класс, представляющий модель ElectronicCertificateRefundMethod.
**Description:**
Возврат платежа по электронному сертификату.
---
### Constants
* No constants found
---
### Properties
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| public | [$articles](../classes/YooKassa-Request-Refunds-RefundMethodData-RefundMethodDataElectronicCertificate.md#property_articles) | | Корзина возврата (в терминах НСПК) — список возвращаемых товаров, для оплаты которых использовался электронный сертификат. Данные должны соответствовать товарам из одобренной корзины покупки (`articles` в [объекте платежа](#payment_object)). Необходимо передавать только при [оплате на готовой странице ЮKassa](/developers/payment-acceptance/integration-scenarios/manual-integration/other/electronic-certificate/ready-made-payment-form). |
| public | [$electronic_certificate](../classes/YooKassa-Request-Refunds-RefundMethodData-RefundMethodDataElectronicCertificate.md#property_electronic_certificate) | | Данные от ФЭС НСПК для возврата на электронный сертификат. Необходимо передавать только при [оплате со сбором данных на вашей стороне](https://yookassa.ru/developers/payment-acceptance/integration-scenarios/manual-integration/other/electronic-certificate/merchant-payment-form). |
| public | [$electronicCertificate](../classes/YooKassa-Request-Refunds-RefundMethodData-RefundMethodDataElectronicCertificate.md#property_electronicCertificate) | | Данные от ФЭС НСПК для возврата на электронный сертификат. Необходимо передавать только при [оплате со сбором данных на вашей стороне](https://yookassa.ru/developers/payment-acceptance/integration-scenarios/manual-integration/other/electronic-certificate/merchant-payment-form). |
| public | [$type](../classes/YooKassa-Request-Refunds-RefundMethodData-RefundMethodDataElectronicCertificate.md#property_type) | | Код способа оплаты. |
| public | [$type](../classes/YooKassa-Request-Refunds-RefundMethodData-AbstractRefundMethodData.md#property_type) | | Код метода возврата |
| protected | [$_type](../classes/YooKassa-Request-Refunds-RefundMethodData-AbstractRefundMethodData.md#property__type) | | Код метода возврата. |
---
### Methods
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| public | [__construct()](../classes/YooKassa-Request-Refunds-RefundMethodData-RefundMethodDataElectronicCertificate.md#method___construct) | | |
| 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 | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива. |
| public | [getArticles()](../classes/YooKassa-Request-Refunds-RefundMethodData-RefundMethodDataElectronicCertificate.md#method_getArticles) | | Возвращает articles. |
| public | [getElectronicCertificate()](../classes/YooKassa-Request-Refunds-RefundMethodData-RefundMethodDataElectronicCertificate.md#method_getElectronicCertificate) | | Возвращает electronic_certificate. |
| public | [getType()](../classes/YooKassa-Request-Refunds-RefundMethodData-AbstractRefundMethodData.md#method_getType) | | Возвращает тип метода возврата. |
| public | [getValidator()](../classes/YooKassa-Common-AbstractObject.md#method_getValidator) | | |
| 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 | [setArticles()](../classes/YooKassa-Request-Refunds-RefundMethodData-RefundMethodDataElectronicCertificate.md#method_setArticles) | | Устанавливает articles. |
| public | [setElectronicCertificate()](../classes/YooKassa-Request-Refunds-RefundMethodData-RefundMethodDataElectronicCertificate.md#method_setElectronicCertificate) | | Устанавливает electronic_certificate. |
| public | [setType()](../classes/YooKassa-Request-Refunds-RefundMethodData-AbstractRefundMethodData.md#method_setType) | | Устанавливает тип метода возврата. |
| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize(). |
| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта. |
| protected | [validatePropertyValue()](../classes/YooKassa-Common-AbstractObject.md#method_validatePropertyValue) | | |
---
### Details
* File: [lib/Request/Refunds/RefundMethodData/RefundMethodDataElectronicCertificate.php](../../lib/Request/Refunds/RefundMethodData/RefundMethodDataElectronicCertificate.php)
* Package: YooKassa\Modela
* Class Hierarchy:
* [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
* [\YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData](../classes/YooKassa-Request-Refunds-RefundMethodData-AbstractRefundMethodData.md)
* \YooKassa\Request\Refunds\RefundMethodData\RefundMethodDataElectronicCertificate
* See Also:
* [](https://yookassa.ru/developers/api)
---
### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| category | | Class |
| author | | cms@yoomoney.ru |
---
## Properties
<a name="property_articles"></a>
#### public $articles : \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundArticle[]|\YooKassa\Common\ListObjectInterface
---
***Description***
Корзина возврата (в терминах НСПК) — список возвращаемых товаров, для оплаты которых использовался электронный сертификат. Данные должны соответствовать товарам из одобренной корзины покупки (`articles` в [объекте платежа](#payment_object)). Необходимо передавать только при [оплате на готовой странице ЮKassa](/developers/payment-acceptance/integration-scenarios/manual-integration/other/electronic-certificate/ready-made-payment-form).
**Type:** <a href="../\YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundArticle[]|\YooKassa\Common\ListObjectInterface"><abbr title="\YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundArticle[]|\YooKassa\Common\ListObjectInterface">ListObjectInterface</abbr></a>
**Details:**
<a name="property_electronic_certificate"></a>
#### public $electronic_certificate : \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundData
---
***Description***
Данные от ФЭС НСПК для возврата на электронный сертификат. Необходимо передавать только при [оплате со сбором данных на вашей стороне](https://yookassa.ru/developers/payment-acceptance/integration-scenarios/manual-integration/other/electronic-certificate/merchant-payment-form).
**Type:** <a href="../classes/YooKassa-Model-Refund-RefundMethod-ElectronicCertificate-ElectronicCertificateRefundData.html"><abbr title="\YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundData">ElectronicCertificateRefundData</abbr></a>
**Details:**
<a name="property_electronicCertificate"></a>
#### public $electronicCertificate : \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundData
---
***Description***
Данные от ФЭС НСПК для возврата на электронный сертификат. Необходимо передавать только при [оплате со сбором данных на вашей стороне](https://yookassa.ru/developers/payment-acceptance/integration-scenarios/manual-integration/other/electronic-certificate/merchant-payment-form).
**Type:** <a href="../classes/YooKassa-Model-Refund-RefundMethod-ElectronicCertificate-ElectronicCertificateRefundData.html"><abbr title="\YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundData">ElectronicCertificateRefundData</abbr></a>
**Details:**
<a name="property_type"></a>
#### public $type : string
---
***Description***
Код способа оплаты.
**Type:** <a href="../string"><abbr title="string">string</abbr></a>
**Details:**
<a name="property_type"></a>
#### public $type : string
---
***Description***
Код метода возврата
**Type:** <a href="../string"><abbr title="string">string</abbr></a>
**Details:**
* Inherited From: [\YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData](../classes/YooKassa-Request-Refunds-RefundMethodData-AbstractRefundMethodData.md)
<a name="property__type"></a>
#### protected $_type : ?string
---
**Summary**
Код метода возврата.
**Type:** <a href="../?string"><abbr title="?string">?string</abbr></a>
**Details:**
* Inherited From: [\YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData](../classes/YooKassa-Request-Refunds-RefundMethodData-AbstractRefundMethodData.md)
---
## Methods
<a name="method___construct" class="anchor"></a>
#### public __construct() : mixed
```php
public __construct(?array $data = []) : mixed
```
**Details:**
* Inherited From: [\YooKassa\Request\Refunds\RefundMethodData\RefundMethodDataElectronicCertificate](../classes/YooKassa-Request-Refunds-RefundMethodData-RefundMethodDataElectronicCertificate.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() : 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_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_getArticles" class="anchor"></a>
#### public getArticles() : \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundArticle[]|\YooKassa\Common\ListObjectInterface|null
```php
public getArticles() : \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundArticle[]|\YooKassa\Common\ListObjectInterface|null
```
**Summary**
Возвращает articles.
**Details:**
* Inherited From: [\YooKassa\Request\Refunds\RefundMethodData\RefundMethodDataElectronicCertificate](../classes/YooKassa-Request-Refunds-RefundMethodData-RefundMethodDataElectronicCertificate.md)
**Returns:** \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundArticle[]|\YooKassa\Common\ListObjectInterface|null - Корзина возврата (в терминах НСПК) — список возвращаемых товаров
<a name="method_getElectronicCertificate" class="anchor"></a>
#### public getElectronicCertificate() : \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundData|null
```php
public getElectronicCertificate() : \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundData|null
```
**Summary**
Возвращает electronic_certificate.
**Details:**
* Inherited From: [\YooKassa\Request\Refunds\RefundMethodData\RefundMethodDataElectronicCertificate](../classes/YooKassa-Request-Refunds-RefundMethodData-RefundMethodDataElectronicCertificate.md)
**Returns:** \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundData|null - Данные от ФЭС НСПК для возврата на электронный сертификат.
<a name="method_getType" class="anchor"></a>
#### public getType() : string|null
```php
public getType() : string|null
```
**Summary**
Возвращает тип метода возврата.
**Details:**
* Inherited From: [\YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData](../classes/YooKassa-Request-Refunds-RefundMethodData-AbstractRefundMethodData.md)
**Returns:** string|null - Тип метода возврата
<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_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_setArticles" class="anchor"></a>
#### public setArticles() : self
```php
public setArticles(\YooKassa\Common\ListObjectInterface|array|null $articles = null) : self
```
**Summary**
Устанавливает articles.
**Details:**
* Inherited From: [\YooKassa\Request\Refunds\RefundMethodData\RefundMethodDataElectronicCertificate](../classes/YooKassa-Request-Refunds-RefundMethodData-RefundMethodDataElectronicCertificate.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">\YooKassa\Common\ListObjectInterface OR array OR null</code> | articles | Корзина возврата (в терминах НСПК) — список возвращаемых товаров, для оплаты которых использовался электронный сертификат. Данные должны соответствовать товарам из одобренной корзины покупки (`articles` в [объекте платежа](#payment_object)). Необходимо передавать только при [оплате на готовой странице ЮKassa](/developers/payment-acceptance/integration-scenarios/manual-integration/other/electronic-certificate/ready-made-payment-form). |
**Returns:** self -
<a name="method_setElectronicCertificate" class="anchor"></a>
#### public setElectronicCertificate() : self
```php
public setElectronicCertificate(\YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundData|array|null $electronic_certificate = null) : self
```
**Summary**
Устанавливает electronic_certificate.
**Details:**
* Inherited From: [\YooKassa\Request\Refunds\RefundMethodData\RefundMethodDataElectronicCertificate](../classes/YooKassa-Request-Refunds-RefundMethodData-RefundMethodDataElectronicCertificate.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">\YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundData OR array OR null</code> | electronic_certificate | Данные от ФЭС НСПК для возврата на электронный сертификат. |
**Returns:** self -
<a name="method_setType" class="anchor"></a>
#### public setType() : self
```php
public setType(string|null $type = null) : self
```
**Summary**
Устанавливает тип метода возврата.
**Details:**
* Inherited From: [\YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData](../classes/YooKassa-Request-Refunds-RefundMethodData-AbstractRefundMethodData.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">string OR null</code> | type | Тип метода возврата |
**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_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_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/)
&copy; 2026 YooMoney