keboss/meraproject
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
main
meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Model-Source.md
keboss-m 5c21d25d45 Initial commit: Merakomis portal, Docker stack and user-reader API. 
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-06-24 11:04:05 +03:00

555 lines
17 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# [YooKassa API SDK](../home.md)
# Class: \YooKassa\Model\Source
### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md)
---
**Summary:**
Класс объекта распределения денег в магазин
---
### Constants
* No constants found
---
### Properties
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| public | [$accountId](../classes/YooKassa-Model-Source.md#property_accountId) | | Идентификатор магазина, для которого вы хотите провести возврат |
| public | [$amount](../classes/YooKassa-Model-Source.md#property_amount) | | Сумма возврата |
| public | [$platform_fee_amount](../classes/YooKassa-Model-Source.md#property_platform_fee_amount) | | Комиссия, которую вы удержали при оплате, и хотите вернуть |
---
### Methods
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. |
| 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 | [getAccountId()](../classes/YooKassa-Model-Source.md#method_getAccountId) | | Возвращает id магазина с которого будут списаны средства |
| public | [getAmount()](../classes/YooKassa-Model-Source.md#method_getAmount) | | Возвращает сумму оплаты |
| public | [getPlatformFeeAmount()](../classes/YooKassa-Model-Source.md#method_getPlatformFeeAmount) | | Возвращает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу |
| public | [hasAmount()](../classes/YooKassa-Model-Source.md#method_hasAmount) | | Проверяет, была ли установлена сумма оплаты |
| public | [hasPlatformFeeAmount()](../classes/YooKassa-Model-Source.md#method_hasPlatformFeeAmount) | | Проверяет, была ли установлена комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу |
| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | |
| 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 | [setAccountId()](../classes/YooKassa-Model-Source.md#method_setAccountId) | | Устаналивает id магазина-получателя средств |
| public | [setAmount()](../classes/YooKassa-Model-Source.md#method_setAmount) | | Устанавливает сумму оплаты |
| public | [setPlatformFeeAmount()](../classes/YooKassa-Model-Source.md#method_setPlatformFeeAmount) | | Устанавливает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу |
| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() |
| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта |
---
### Details
* File: [lib/Model/Source.php](../../lib/Model/Source.php)
* Package: YooKassa
* Class Hierarchy:
* [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
* \YooKassa\Model\Source
* Implements:
* [\YooKassa\Model\SourceInterface](../classes/YooKassa-Model-SourceInterface.md)
---
## Properties
<a name="property_accountId"></a>
#### public $accountId : string
---
***Description***
Идентификатор магазина, для которого вы хотите провести возврат
**Type:** <a href="string"><abbr title="string">string</abbr></a>
**Details:**
<a name="property_amount"></a>
#### public $amount : \YooKassa\Model\AmountInterface
---
***Description***
Сумма возврата
**Type:** <a href="classes/YooKassa-Model-AmountInterface.html"><abbr title="\YooKassa\Model\AmountInterface">AmountInterface</abbr></a>
**Details:**
<a name="property_platform_fee_amount"></a>
#### public $platform_fee_amount : \YooKassa\Model\AmountInterface
---
***Description***
Комиссия, которую вы удержали при оплате, и хотите вернуть
**Type:** <a href="classes/YooKassa-Model-AmountInterface.html"><abbr title="\YooKassa\Model\AmountInterface">AmountInterface</abbr></a>
**Details:**
---
## Methods
<a name="method___construct" class="anchor"></a>
#### public __construct() : mixed
```php
public __construct(array $data = array()) : mixed
```
**Summary**
AbstractObject constructor.
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.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() : mixed
```php
public __set(string $propertyName, mixed $value) : mixed
```
**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:** mixed -
<a name="method___unset" class="anchor"></a>
#### public __unset() : mixed
```php
public __unset(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_fromArray" class="anchor"></a>
#### public fromArray() : mixed
```php
public fromArray(array|\Traversable $sourceArray) : mixed
```
**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:** mixed -
<a name="method_getAccountId" class="anchor"></a>
#### public getAccountId() : string|null
```php
public getAccountId() : string|null
```
**Summary**
Возвращает id магазина с которого будут списаны средства
**Details:**
* Inherited From: [\YooKassa\Model\Source](../classes/YooKassa-Model-Source.md)
**Returns:** string|null -
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
<a name="method_getAmount" class="anchor"></a>
#### public getAmount() : \YooKassa\Model\AmountInterface
```php
public getAmount() : \YooKassa\Model\AmountInterface
```
**Summary**
Возвращает сумму оплаты
**Details:**
* Inherited From: [\YooKassa\Model\Source](../classes/YooKassa-Model-Source.md)
**Returns:** \YooKassa\Model\AmountInterface - Сумма оплаты
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
<a name="method_getPlatformFeeAmount" class="anchor"></a>
#### public getPlatformFeeAmount() : \YooKassa\Model\AmountInterface
```php
public getPlatformFeeAmount() : \YooKassa\Model\AmountInterface
```
**Summary**
Возвращает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу
**Details:**
* Inherited From: [\YooKassa\Model\Source](../classes/YooKassa-Model-Source.md)
**Returns:** \YooKassa\Model\AmountInterface - Сумма комиссии
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
<a name="method_hasAmount" class="anchor"></a>
#### public hasAmount() : bool
```php
public hasAmount() : bool
```
**Summary**
Проверяет, была ли установлена сумма оплаты
**Details:**
* Inherited From: [\YooKassa\Model\Source](../classes/YooKassa-Model-Source.md)
**Returns:** bool - True если сумма оплаты была установлена, false если нет
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
<a name="method_hasPlatformFeeAmount" class="anchor"></a>
#### public hasPlatformFeeAmount() : bool
```php
public hasPlatformFeeAmount() : bool
```
**Summary**
Проверяет, была ли установлена комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу
**Details:**
* Inherited From: [\YooKassa\Model\Source](../classes/YooKassa-Model-Source.md)
**Returns:** bool - True если комиссия была установлена, false если нет
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
<a name="method_jsonSerialize" class="anchor"></a>
#### public jsonSerialize() : mixed
```php
public jsonSerialize() : mixed
```
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
**Returns:** mixed -
<a name="method_offsetExists" class="anchor"></a>
#### public offsetExists() : mixed
```php
public offsetExists(mixed $offset) : mixed
```
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">mixed</code> | offset | |
**Returns:** mixed -
<a name="method_offsetGet" class="anchor"></a>
#### public offsetGet() : mixed
```php
public offsetGet(mixed $offset) : mixed
```
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">mixed</code> | offset | |
**Returns:** mixed -
<a name="method_offsetSet" class="anchor"></a>
#### public offsetSet() : mixed
```php
public offsetSet(mixed $offset, mixed $value) : mixed
```
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">mixed</code> | offset | |
| <code lang="php">mixed</code> | value | |
**Returns:** mixed -
<a name="method_offsetUnset" class="anchor"></a>
#### public offsetUnset() : mixed
```php
public offsetUnset(mixed $offset) : mixed
```
**Details:**
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">mixed</code> | offset | |
**Returns:** mixed -
<a name="method_setAccountId" class="anchor"></a>
#### public setAccountId() : void
```php
public setAccountId(mixed $value) : void
```
**Summary**
Устаналивает id магазина-получателя средств
**Details:**
* Inherited From: [\YooKassa\Model\Source](../classes/YooKassa-Model-Source.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">mixed</code> | value | |
**Returns:** void -
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
<a name="method_setAmount" class="anchor"></a>
#### public setAmount() : mixed
```php
public setAmount(mixed $value) : mixed
```
**Summary**
Устанавливает сумму оплаты
**Details:**
* Inherited From: [\YooKassa\Model\Source](../classes/YooKassa-Model-Source.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">mixed</code> | value | Сумма оплаты |
**Returns:** mixed -
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
<a name="method_setPlatformFeeAmount" class="anchor"></a>
#### public setPlatformFeeAmount() : mixed
```php
public setPlatformFeeAmount(mixed $value) : mixed
```
**Summary**
Устанавливает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу
**Details:**
* Inherited From: [\YooKassa\Model\Source](../classes/YooKassa-Model-Source.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">mixed</code> | value | Сумма комиссии |
**Returns:** mixed -
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
<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 - Ассоциативный массив с не существующими у текущего объекта свойствами
---
### Top Namespaces
* [\YooKassa](../namespaces/yookassa.md)
---
### Reports
* [Errors - 0](../reports/errors.md)
* [Markers - 1](../reports/markers.md)
* [Deprecated - 25](../reports/deprecated.md)
---
This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/)
&copy; 2023 YooMoney
Reference in New Issue View Git Blame Copy Permalink