yookassa-sdk-php/docs/classes/YooKassa-Model-Source.md

YooKassa API SDK

Class: \YooKassa\Model\Source

Namespace: \YooKassa\Model

---

Summary:

Класс объекта распределения денег в магазин

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
public	$accountId		Идентификатор магазина, для которого вы хотите провести возврат
public	$amount		Сумма возврата
public	$platform_fee_amount		Комиссия, которую вы удержали при оплате, и хотите вернуть

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		Transfer constructor.
public	__get()		Возвращает значение свойства
public	__isset()		Проверяет наличие свойства
public	__set()		Устанавливает значение свойства
public	__unset()		Удаляет свойство
public	fromArray()		Устанавливает значения свойств текущего объекта из массива
public	getAccountId()		Возвращает id магазина с которого будут списаны средства
public	getAmount()		Возвращает сумму оплаты
public	getPlatformFeeAmount()		Возвращает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу
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()		Возвращает массив свойств которые не существуют, но были заданы у объекта

---

Details

• File: lib/Model/Source.php
• Package: Default
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Model\Source
• Implements:
  • \YooKassa\Model\SourceInterface

---

Properties

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:

---

Methods

public __construct() : mixed

public __construct(array $data = null) : mixed

Summary

Transfer constructor.

Details:

• Inherited From: \YooKassa\Model\Source

Parameters:

Type	Name	Description
array	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() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public __unset() : mixed

public __unset(string $propertyName) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public fromArray() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public getAccountId() : string|null

public getAccountId() : string|null

Summary

Возвращает id магазина с которого будут списаны средства

Details:

• Inherited From: \YooKassa\Model\Source

Returns: string|null -

Tags

Tag	Version	Description
inheritDoc

public getAmount() : \YooKassa\Model\AmountInterface

public getAmount() : \YooKassa\Model\AmountInterface

Summary

Возвращает сумму оплаты

Details:

• Inherited From: \YooKassa\Model\Source

Returns: \YooKassa\Model\AmountInterface - Сумма оплаты

Tags

Tag	Version	Description
inheritDoc

public getPlatformFeeAmount() : \YooKassa\Model\AmountInterface

public getPlatformFeeAmount() : \YooKassa\Model\AmountInterface

Summary

Возвращает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу

Details:

• Inherited From: \YooKassa\Model\Source

Returns: \YooKassa\Model\AmountInterface - Сумма комиссии

Tags

Tag	Version	Description
inheritDoc

public hasAmount() : bool

public hasAmount() : bool

Summary

Проверяет была ли установлена сумма оплаты

Details:

• Inherited From: \YooKassa\Model\Source

Returns: bool - True если сумма оплаты была установлена, false если нет

Tags

Tag	Version	Description
inheritDoc

public hasPlatformFeeAmount() : bool

public hasPlatformFeeAmount() : bool

Summary

Проверяет была ли установлена комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу

Details:

• Inherited From: \YooKassa\Model\Source

Returns: bool - True если комиссия была установлена, false если нет

Tags

Tag	Version	Description
inheritDoc

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() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public offsetUnset() : mixed

public offsetUnset(string $offset) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public setAccountId() : void

public setAccountId(mixed $value) : void

Summary

Устаналивает id магазина-получателя средств

Details:

• Inherited From: \YooKassa\Model\Source

Parameters:

Type	Name	Description
mixed	value

Returns: void -

Tags

Tag	Version	Description
inheritDoc

public setAmount() : mixed

public setAmount(mixed $value) : mixed

Summary

Устанавливает сумму оплаты

Details:

• Inherited From: \YooKassa\Model\Source

Parameters:

Type	Name	Description
mixed	value	Сумма оплаты

Returns: mixed -

Tags

Tag	Version	Description
inheritDoc

public setPlatformFeeAmount() : mixed

public setPlatformFeeAmount(mixed $value) : mixed

Summary

Устанавливает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу

Details:

• Inherited From: \YooKassa\Model\Source

Parameters:

Type	Name	Description
mixed	value	Сумма комиссии

Returns: mixed -

Tags

Tag	Version	Description
inheritDoc

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 - Ассоциативный массив с не существующими у текущего объекта свойствами

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 0
• Deprecated - 7

---

This document was automatically generated from source code comments on 2021-09-10 using phpDocumentor

© 2021 YooMoney