yookassa-sdk-php/docs/classes/YooKassa-Model-Payment-PaymentMethod-ElectronicCertificate-ElectronicCertificate.md

YooKassa API SDK

Class: \YooKassa\Model\Payment\PaymentMethod\ElectronicCertificate\ElectronicCertificate

Namespace: \YooKassa\Model\Payment\PaymentMethod\ElectronicCertificate

---

Summary:

Класс, представляющий модель ElectronicCertificate.

Description:

Описание используемого электронного сертификата.

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
public	$applied_compensation		Сумма, которую одобрили для оплаты по сертификату за одну единицу товара. Пример: из 1000 рублей одобрили 500 рублей для оплаты по сертификату.
public	$appliedCompensation		Сумма, которую одобрили для оплаты по сертификату за одну единицу товара. Пример: из 1000 рублей одобрили 500 рублей для оплаты по сертификату.
public	$available_compensation		Максимально допустимая сумма, которую может покрыть электронный сертификат для оплаты одной единицы товара. Пример: сертификат может компенсировать максимум 1000 рублей для оплаты этого товара.
public	$availableCompensation		Максимально допустимая сумма, которую может покрыть электронный сертификат для оплаты одной единицы товара. Пример: сертификат может компенсировать максимум 1000 рублей для оплаты этого товара.
public	$certificate_id		Идентификатор сертификата. От 20 до 30 символов.
public	$certificateId		Идентификатор сертификата. От 20 до 30 символов.
public	$tru_quantity		Количество единиц товара, которое одобрили для оплаты по этому электронному сертификату.
public	$truQuantity		Количество единиц товара, которое одобрили для оплаты по этому электронному сертификату.

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства.
public	__isset()		Проверяет наличие свойства.
public	__set()		Устанавливает значение свойства.
public	__unset()		Удаляет свойство.
public	fromArray()		Устанавливает значения свойств текущего объекта из массива.
public	getAppliedCompensation()		Возвращает applied_compensation.
public	getAvailableCompensation()		Возвращает available_compensation.
public	getCertificateId()		Возвращает certificate_id.
public	getTruQuantity()		Возвращает tru_quantity.
public	getValidator()
public	jsonSerialize()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public	offsetExists()		Проверяет наличие свойства.
public	offsetGet()		Возвращает значение свойства.
public	offsetSet()		Устанавливает значение свойства.
public	offsetUnset()		Удаляет свойство.
public	setAppliedCompensation()		Устанавливает applied_compensation.
public	setAvailableCompensation()		Устанавливает available_compensation.
public	setCertificateId()		Устанавливает certificate_id.
public	setTruQuantity()		Устанавливает tru_quantity.
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected	validatePropertyValue()

---

Details

• File: lib/Model/Payment/PaymentMethod/ElectronicCertificate/ElectronicCertificate.php

• Package: YooKassa\Model

• Class Hierarchy:

  • \YooKassa\Common\AbstractObject
  • \YooKassa\Model\Payment\PaymentMethod\ElectronicCertificate\ElectronicCertificate

• See Also:

---

Tags

Tag	Version	Description
category		Class
author		cms@yoomoney.ru

---

Properties

public $applied_compensation : \YooKassa\Model\AmountInterface

---

Description

Сумма, которую одобрили для оплаты по сертификату за одну единицу товара. Пример: из 1000 рублей одобрили 500 рублей для оплаты по сертификату.

Type: AmountInterface

Details:

public $appliedCompensation : \YooKassa\Model\AmountInterface

---

Description

Сумма, которую одобрили для оплаты по сертификату за одну единицу товара. Пример: из 1000 рублей одобрили 500 рублей для оплаты по сертификату.

Type: AmountInterface

Details:

public $available_compensation : \YooKassa\Model\AmountInterface

---

Description

Максимально допустимая сумма, которую может покрыть электронный сертификат для оплаты одной единицы товара. Пример: сертификат может компенсировать максимум 1000 рублей для оплаты этого товара.

Type: AmountInterface

Details:

public $availableCompensation : \YooKassa\Model\AmountInterface

---

Description

Максимально допустимая сумма, которую может покрыть электронный сертификат для оплаты одной единицы товара. Пример: сертификат может компенсировать максимум 1000 рублей для оплаты этого товара.

Type: AmountInterface

Details:

public $certificate_id : string

---

Description

Идентификатор сертификата. От 20 до 30 символов.

Type: string

Details:

public $certificateId : string

---

Description

Идентификатор сертификата. От 20 до 30 символов.

Type: string

Details:

public $tru_quantity : int

---

Description

Количество единиц товара, которое одобрили для оплаты по этому электронному сертификату.

Type: int

Details:

public $truQuantity : int

---

Description

Количество единиц товара, которое одобрили для оплаты по этому электронному сертификату.

Type: int

Details:

---

Methods

public __construct() : mixed

public __construct(array|null $data = []) : mixed

Summary

AbstractObject constructor.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array OR null	data

Returns: mixed -

public __get() : mixed

public __get(string $propertyName) : mixed

Summary

Возвращает значение свойства.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя свойства

Returns: mixed - Значение свойства

public __isset() : bool

public __isset(string $propertyName) : bool

Summary

Проверяет наличие свойства.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public __set() : void

public __set(string $propertyName, mixed $value) : void

Summary

Устанавливает значение свойства.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя свойства
mixed	value	Значение свойства

Returns: void -

public __unset() : void

public __unset(string $propertyName) : void

Summary

Удаляет свойство.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя удаляемого свойства

Returns: void -

public fromArray() : void

public fromArray(array|\Traversable $sourceArray) : void

Summary

Устанавливает значения свойств текущего объекта из массива.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array OR \Traversable	sourceArray	Ассоциативный массив с настройками

Returns: void -

public getAppliedCompensation() : \YooKassa\Model\AmountInterface|null

public getAppliedCompensation() : \YooKassa\Model\AmountInterface|null

Summary

Возвращает applied_compensation.

Details:

• Inherited From: \YooKassa\Model\Payment\PaymentMethod\ElectronicCertificate\ElectronicCertificate

Returns: \YooKassa\Model\AmountInterface|null - Сумма, которую одобрили для оплаты по сертификату

public getAvailableCompensation() : \YooKassa\Model\AmountInterface|null

public getAvailableCompensation() : \YooKassa\Model\AmountInterface|null

Summary

Возвращает available_compensation.

Details:

• Inherited From: \YooKassa\Model\Payment\PaymentMethod\ElectronicCertificate\ElectronicCertificate

Returns: \YooKassa\Model\AmountInterface|null - Максимально допустимая сумма

public getCertificateId() : string|null

public getCertificateId() : string|null

Summary

Возвращает certificate_id.

Details:

• Inherited From: \YooKassa\Model\Payment\PaymentMethod\ElectronicCertificate\ElectronicCertificate

Returns: string|null - Идентификатор сертификата

public getTruQuantity() : int|null

public getTruQuantity() : int|null

Summary

Возвращает tru_quantity.

Details:

• Inherited From: \YooKassa\Model\Payment\PaymentMethod\ElectronicCertificate\ElectronicCertificate

Returns: int|null - Количество единиц товара

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: \YooKassa\Validator\Validator -

public jsonSerialize() : array

public jsonSerialize() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: array - Ассоциативный массив со свойствами текущего объекта

public offsetExists() : bool

public offsetExists(string $offset) : bool

Summary

Проверяет наличие свойства.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	offset	Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public offsetGet() : mixed

public offsetGet(string $offset) : mixed

Summary

Возвращает значение свойства.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	offset	Имя свойства

Returns: mixed - Значение свойства

public offsetSet() : void

public offsetSet(string $offset, mixed $value) : void

Summary

Устанавливает значение свойства.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	offset	Имя свойства
mixed	value	Значение свойства

Returns: void -

public offsetUnset() : void

public offsetUnset(string $offset) : void

Summary

Удаляет свойство.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	offset	Имя удаляемого свойства

Returns: void -

public setAppliedCompensation() : self

public setAppliedCompensation(\YooKassa\Model\AmountInterface|array|null $applied_compensation = null) : self

Summary

Устанавливает applied_compensation.

Details:

• Inherited From: \YooKassa\Model\Payment\PaymentMethod\ElectronicCertificate\ElectronicCertificate

Parameters:

Type	Name	Description
\YooKassa\Model\AmountInterface OR array OR null	applied_compensation	Сумма, которую одобрили для оплаты по сертификату

Returns: self -

public setAvailableCompensation() : self

public setAvailableCompensation(\YooKassa\Model\AmountInterface|array|null $available_compensation = null) : self

Summary

Устанавливает available_compensation.

Details:

• Inherited From: \YooKassa\Model\Payment\PaymentMethod\ElectronicCertificate\ElectronicCertificate

Parameters:

Type	Name	Description
\YooKassa\Model\AmountInterface OR array OR null	available_compensation	Максимально допустимая сумма

Returns: self -

public setCertificateId() : self

public setCertificateId(string|null $certificate_id = null) : self

Summary

Устанавливает certificate_id.

Details:

• Inherited From: \YooKassa\Model\Payment\PaymentMethod\ElectronicCertificate\ElectronicCertificate

Parameters:

Type	Name	Description
string OR null	certificate_id	Идентификатор сертификата. От 20 до 30 символов.

Returns: self -

public setTruQuantity() : self

public setTruQuantity(int|null $tru_quantity = null) : self

Summary

Устанавливает tru_quantity.

Details:

• Inherited From: \YooKassa\Model\Payment\PaymentMethod\ElectronicCertificate\ElectronicCertificate

Parameters:

Type	Name	Description
int OR null	tru_quantity	Количество единиц товара, которое одобрили для оплаты по этому электронному сертификату.

Returns: self -

public toArray() : array

public toArray() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: array - Ассоциативный массив со свойствами текущего объекта

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

Возвращает массив свойств которые не существуют, но были заданы у объекта.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: array - Ассоциативный массив с не существующими у текущего объекта свойствами

protected validatePropertyValue() : mixed

protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName
mixed	propertyValue

Returns: mixed -

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 0
• Deprecated - 32

---

This document was automatically generated from source code comments on 2024-12-05 using phpDocumentor

© 2024 YooMoney