Добавлены нулевые привязки по СБП Добавлена причина отмены возвратов `payment_expired`
21 KiB
YooKassa API SDK
Class: \YooKassa\Model\Refund\Source
Namespace: \YooKassa\Model\Refund
Summary:
Класс, представляющий модель RefundSourcesData.
Description:
Данные о том, с какого магазина и какую сумму нужно удержать для проведения возврата. Сейчас в этом параметре можно передать данные только одного магазина.
Constants
- No constants found
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | $account_id | Идентификатор магазина, для которого вы хотите провести возврат | |
| public | $accountId | Идентификатор магазина, для которого вы хотите провести возврат | |
| public | $amount | Сумма возврата | |
| public | $platform_fee_amount | Комиссия, которую вы удержали при оплате, и хотите вернуть | |
| public | $platformFeeAmount | Комиссия, которую вы удержали при оплате, и хотите вернуть |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | AbstractObject constructor. | |
| public | __get() | Возвращает значение свойства. | |
| public | __isset() | Проверяет наличие свойства. | |
| public | __set() | Устанавливает значение свойства. | |
| public | __unset() | Удаляет свойство. | |
| public | fromArray() | Устанавливает значения свойств текущего объекта из массива. | |
| public | getAccountId() | Возвращает id магазина с которого будут списаны средства. | |
| public | getAmount() | Возвращает сумму оплаты. | |
| public | getPlatformFeeAmount() | Возвращает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу. | |
| public | getValidator() | ||
| public | hasAmount() | Проверяет, была ли установлена сумма оплаты. | |
| public | hasPlatformFeeAmount() | Проверяет, была ли установлена комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу. | |
| public | jsonSerialize() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации. | |
| public | offsetExists() | Проверяет наличие свойства. | |
| public | offsetGet() | Возвращает значение свойства. | |
| public | offsetSet() | Устанавливает значение свойства. | |
| public | offsetUnset() | Удаляет свойство. | |
| public | setAccountId() | Устанавливает id магазина-получателя средств. | |
| public | setAmount() | Устанавливает сумму оплаты. | |
| public | setPlatformFeeAmount() | Устанавливает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу. | |
| public | toArray() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize(). | |
| protected | getUnknownProperties() | Возвращает массив свойств которые не существуют, но были заданы у объекта. | |
| protected | validatePropertyValue() |
Details
-
Package: YooKassa\Model
-
Class Hierarchy:
- \YooKassa\Common\AbstractObject
- \YooKassa\Model\Refund\Source
-
Implements:
-
See Also:
Tags
| Tag | Version | Description |
|---|---|---|
| category | Class | |
| author | cms@yoomoney.ru |
Properties
public $account_id : string
Description
Идентификатор магазина, для которого вы хотите провести возврат
Type: string
Details:
public $accountId : string
Description
Идентификатор магазина, для которого вы хотите провести возврат
Type: string
Details:
public $amount : \YooKassa\Model\AmountInterface
Description
Сумма возврата
Type: AmountInterface
Details:
public $platform_fee_amount : \YooKassa\Model\AmountInterface
Description
Комиссия, которую вы удержали при оплате, и хотите вернуть
Type: AmountInterface
Details:
public $platformFeeAmount : \YooKassa\Model\AmountInterface
Description
Комиссия, которую вы удержали при оплате, и хотите вернуть
Type: AmountInterface
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 getAccountId() : string|null
public getAccountId() : string|null
Summary
Возвращает id магазина с которого будут списаны средства.
Details:
- Inherited From: \YooKassa\Model\Refund\Source
Returns: string|null - Id магазина с которого будут списаны средства
public getAmount() : \YooKassa\Model\AmountInterface|null
public getAmount() : \YooKassa\Model\AmountInterface|null
Summary
Возвращает сумму оплаты.
Details:
- Inherited From: \YooKassa\Model\Refund\Source
Returns: \YooKassa\Model\AmountInterface|null - Сумма оплаты
public getPlatformFeeAmount() : \YooKassa\Model\AmountInterface|null
public getPlatformFeeAmount() : \YooKassa\Model\AmountInterface|null
Summary
Возвращает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу.
Details:
- Inherited From: \YooKassa\Model\Refund\Source
Returns: \YooKassa\Model\AmountInterface|null - Сумма комиссии
public getValidator() : \YooKassa\Validator\Validator
public getValidator() : \YooKassa\Validator\Validator
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: \YooKassa\Validator\Validator -
public hasAmount() : bool
public hasAmount() : bool
Summary
Проверяет, была ли установлена сумма оплаты.
Details:
- Inherited From: \YooKassa\Model\Refund\Source
Returns: bool - True если сумма оплаты была установлена, false если нет
public hasPlatformFeeAmount() : bool
public hasPlatformFeeAmount() : bool
Summary
Проверяет, была ли установлена комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу.
Details:
- Inherited From: \YooKassa\Model\Refund\Source
Returns: bool - True если комиссия была установлена, false если нет
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 setAccountId() : self
public setAccountId(string|null $account_id = null) : self
Summary
Устанавливает id магазина-получателя средств.
Details:
- Inherited From: \YooKassa\Model\Refund\Source
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
account_id | Id магазина с которого будут списаны средства |
Returns: self -
public setAmount() : self
public setAmount(\YooKassa\Model\AmountInterface|array|null $amount = null) : self
Summary
Устанавливает сумму оплаты.
Details:
- Inherited From: \YooKassa\Model\Refund\Source
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\AmountInterface OR array OR null |
amount | Сумма оплаты |
Returns: self -
public setPlatformFeeAmount() : self
public setPlatformFeeAmount(\YooKassa\Model\AmountInterface|array|null $platform_fee_amount = null) : self
Summary
Устанавливает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу.
Details:
- Inherited From: \YooKassa\Model\Refund\Source
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\AmountInterface OR array OR null |
platform_fee_amount | Сумма комиссии |
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
Reports
This document was automatically generated from source code comments on 2026-06-29 using phpDocumentor
© 2026 YooMoney