mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-08-30 12:07:43 +00:00

Files

T

Антон Н. Николаев 07548dff5e Добавлен параметр suspended_until (период охлаждения для «Покупок в кредит» от СберБанка). В запрос на создание выплаты у bank_id добавлена минимально допустимая длина 12 и проверка по регулярному выражению

Добавлен новый способ оплаты — Плати частями
Ошибки вынесены в отдельные объекты
Внесены небольшие изменения в тексты

2025-09-04 14:26:26 +03:00

26 KiB

Raw Blame History

YooKassa API SDK

Class: \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundArticle

Namespace: \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate

Summary:

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

Description:

Товарная позиция в корзине возврата при возврате на электронный сертификат.

Constants

No constants found

Properties

Visibility	Name	Summary
public	$article_number	Порядковый номер товара в корзине возврата. От 1 до 999 включительно.
public	$articleNumber	Порядковый номер товара в корзине возврата. От 1 до 999 включительно.
public	$payment_article_number	Порядковый номер товара в одобренной корзине покупки (article_number в объекте платежа). От 1 до 999 включительно.
public	$paymentArticleNumber	Порядковый номер товара в одобренной корзине покупки (article_number в объекте платежа). От 1 до 999 включительно.
public	$quantity	Количество возвращаемых единиц товара. Формат: целое положительное число.
public	$tru_code	Код ТРУ. 30 символов, две группы цифр, разделенные точкой. Формат: ~`NNNNNNNNN.NNNNNNNNNYYYYMMMMZZZ`, где ~`NNNNNNNNN.NNNNNNNNN` — код вида ТРУ по Перечню ТРУ, ~`YYYY` — код производителя, ~`MMMM` — код модели, ~`ZZZ` — код страны производителя. Пример: ~`329921120.06001010200080001643` Как сформировать код ТРУ
public	$truCode	Код ТРУ. 30 символов, две группы цифр, разделенные точкой. Формат: ~`NNNNNNNNN.NNNNNNNNNYYYYMMMMZZZ`, где ~`NNNNNNNNN.NNNNNNNNN` — код вида ТРУ по Перечню ТРУ, ~`YYYY` — код производителя, ~`MMMM` — код модели, ~`ZZZ` — код страны производителя. Пример: ~`329921120.06001010200080001643` Как сформировать код ТРУ

Methods

Visibility	Name	Summary
public	__construct()	AbstractObject constructor.
public	__get()	Возвращает значение свойства.
public	__isset()	Проверяет наличие свойства.
public	__set()	Устанавливает значение свойства.
public	__unset()	Удаляет свойство.
public	fromArray()	Устанавливает значения свойств текущего объекта из массива.
public	getArticleNumber()	Возвращает article_number.
public	getPaymentArticleNumber()	Возвращает payment_article_number.
public	getQuantity()	Возвращает quantity.
public	getTruCode()	Возвращает tru_code.
public	getValidator()
public	jsonSerialize()	Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public	offsetExists()	Проверяет наличие свойства.
public	offsetGet()	Возвращает значение свойства.
public	offsetSet()	Устанавливает значение свойства.
public	offsetUnset()	Удаляет свойство.
public	setArticleNumber()	Устанавливает article_number.
public	setPaymentArticleNumber()	Устанавливает payment_article_number.
public	setQuantity()	Устанавливает quantity.
public	setTruCode()	Устанавливает tru_code.
public	toArray()	Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
protected	getUnknownProperties()	Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected	validatePropertyValue()

Details

File: lib/Model/Refund/RefundMethod/ElectronicCertificate/ElectronicCertificateRefundArticle.php
Package: YooKassa\Model
Class Hierarchy:
- \YooKassa\Common\AbstractObject
- \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundArticle
See Also:

Tag	Version	Description
category		Class
author		cms@yoomoney.ru

Properties

public $article_number : int

Description

Порядковый номер товара в корзине возврата. От 1 до 999 включительно.

Type: int

Details:

public $articleNumber : int

Description

Порядковый номер товара в корзине возврата. От 1 до 999 включительно.

Type: int

Details:

public $payment_article_number : int

Description

Порядковый номер товара в одобренной корзине покупки (article_number в объекте платежа). От 1 до 999 включительно.

Type: int

Details:

public $paymentArticleNumber : int

Description

Порядковый номер товара в одобренной корзине покупки (article_number в объекте платежа). От 1 до 999 включительно.

Type: int

Details:

public $quantity : int

Description

Количество возвращаемых единиц товара. Формат: целое положительное число.

Type: int

Details:

public $tru_code : string

Description

Код ТРУ. 30 символов, две группы цифр, разделенные точкой. Формат: ~NNNNNNNNN.NNNNNNNNNYYYYMMMMZZZ, где ~NNNNNNNNN.NNNNNNNNN — код вида ТРУ по Перечню ТРУ, ~YYYY — код производителя, ~MMMM — код модели, ~ZZZ — код страны производителя. Пример: ~329921120.06001010200080001643 Как сформировать код ТРУ

Type: string

Details:

public $truCode : string

Description

Type: string

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 getArticleNumber() : int|null

public getArticleNumber() : int|null

Summary

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

Details:

Inherited From: \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundArticle

Returns: int|null - Порядковый номер товара в корзине возврата

public getPaymentArticleNumber() : int|null

public getPaymentArticleNumber() : int|null

Summary

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

Details:

Inherited From: \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundArticle

Returns: int|null - Порядковый номер товара в одобренной корзине покупки

public getQuantity() : int|null

public getQuantity() : int|null

Summary

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

Details:

Inherited From: \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundArticle

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

public getTruCode() : string|null

public getTruCode() : string|null

Summary

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

Details:

Inherited From: \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundArticle

Returns: string|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 setArticleNumber() : self

public setArticleNumber(int|null $article_number = null) : self

Summary

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

Details:

Inherited From: \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundArticle

Parameters:

Type	Name	Description
`int OR null`	article_number	Порядковый номер товара в корзине возврата

Returns: self -

public setPaymentArticleNumber() : self

public setPaymentArticleNumber(int|null $payment_article_number = null) : self

Summary

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

Details:

Inherited From: \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundArticle

Parameters:

Type	Name	Description
`int OR null`	payment_article_number	Порядковый номер товара в одобренной корзине покупки

Returns: self -

public setQuantity() : self

public setQuantity(int|null $quantity = null) : self

Summary

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

Details:

Inherited From: \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundArticle

Parameters:

Type	Name	Description
`int OR null`	quantity	Количество возвращаемых единиц товара. Формат: целое положительное число.

Returns: self -

public setTruCode() : self

public setTruCode(string|null $tru_code = null) : self

Summary

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

Details:

Inherited From: \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundArticle

Parameters:

Type	Name	Description
`string OR null`	tru_code	Код ТРУ. 30 символов, две группы цифр, разделенные точкой. Формат: ~`NNNNNNNNN.NNNNNNNNNYYYYMMMMZZZ`, где ~`NNNNNNNNN.NNNNNNNNN` — код вида ТРУ по Перечню ТРУ, ~`YYYY` — код производителя, ~`MMMM` — код модели, ~`ZZZ` — код страны производителя. Пример: ~`329921120.06001010200080001643` Как сформировать код ТРУ

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

This document was automatically generated from source code comments on 2025-09-04 using phpDocumentor

26 KiB Raw Blame History

YooKassa API SDK

Class: \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate\ElectronicCertificateRefundArticle

Namespace: \YooKassa\Model\Refund\RefundMethod\ElectronicCertificate

Constants

Properties

Methods

Details

Tags

Properties

public $article_number : int

public $articleNumber : int

public $payment_article_number : int

public $paymentArticleNumber : int

public $quantity : int

public $tru_code : string

public $truCode : string

Methods

public __construct() : mixed

Parameters:

public __get() : mixed

Parameters:

public __isset() : bool

Parameters:

public __set() : void

Parameters:

public __unset() : void

Parameters:

public fromArray() : void

Parameters:

public getArticleNumber() : int|null

public getPaymentArticleNumber() : int|null

public getQuantity() : int|null

public getTruCode() : string|null

public getValidator() : \YooKassa\Validator\Validator

public jsonSerialize() : array

public offsetExists() : bool

Parameters:

public offsetGet() : mixed

Parameters:

public offsetSet() : void

Parameters:

public offsetUnset() : void

Parameters:

public setArticleNumber() : self

Parameters:

public setPaymentArticleNumber() : self

Parameters:

public setQuantity() : self

Parameters:

public setTruCode() : self

Parameters:

public toArray() : array

protected getUnknownProperties() : array

protected validatePropertyValue() : mixed

Parameters:

Top Namespaces

Reports

26 KiB

Raw Blame History