keboss/meraproject
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
9fa9d5e3ed
meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Model-Transfer.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

799 lines
26 KiB
Markdown
Raw 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\Transfer
### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md)
---
**Summary:**
Класс объекта распределения денег в магазин
**Description:**
Данные о распределении денег — сколько и в какой магазин нужно перевести.
Присутствует, если вы используете решение ЮKassa для платформ.
---
### Constants
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| public | [MAX_LENGTH_DESCRIPTION](../classes/YooKassa-Model-Transfer.md#constant_MAX_LENGTH_DESCRIPTION) | | Максимальная длина строки описания транзакции |
---
### Properties
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| public | [$accountId](../classes/YooKassa-Model-Transfer.md#property_accountId) | | Идентификатор магазина, в пользу которого вы принимаете оплату |
| public | [$amount](../classes/YooKassa-Model-Transfer.md#property_amount) | | Сумма, которую необходимо перечислить магазину |
| public | [$description](../classes/YooKassa-Model-Transfer.md#property_description) | | Описание транзакции, которое продавец увидит в личном кабинете ЮKassa. (например: «Заказ маркетплейса №72») |
| public | [$metadata](../classes/YooKassa-Model-Transfer.md#property_metadata) | | Любые дополнительные данные, которые нужны вам для работы с платежами (например, ваш внутренний идентификатор заказа) |
| public | [$platform_fee_amount](../classes/YooKassa-Model-Transfer.md#property_platform_fee_amount) | | Комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу |
| public | [$status](../classes/YooKassa-Model-Transfer.md#property_status) | | Статус распределения денег между магазинами. Возможные значения: `pending`, `waiting_for_capture`, `succeeded`, `canceled` |
---
### 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-Transfer.md#method_getAccountId) | | Возвращает идентификатор магазина-получателя средств |
| public | [getAmount()](../classes/YooKassa-Model-Transfer.md#method_getAmount) | | Возвращает сумму оплаты |
| public | [getDescription()](../classes/YooKassa-Model-Transfer.md#method_getDescription) | | Возвращает описание транзакции |
| public | [getMetadata()](../classes/YooKassa-Model-Transfer.md#method_getMetadata) | | Возвращает метаданные |
| public | [getPlatformFeeAmount()](../classes/YooKassa-Model-Transfer.md#method_getPlatformFeeAmount) | | Возвращает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу |
| public | [getStatus()](../classes/YooKassa-Model-Transfer.md#method_getStatus) | | Возвращает статус операции распределения средств конечному получателю |
| public | [hasAmount()](../classes/YooKassa-Model-Transfer.md#method_hasAmount) | | Проверяет, была ли установлена сумма оплаты |
| public | [hasDescription()](../classes/YooKassa-Model-Transfer.md#method_hasDescription) | | Проверяет, было ли установлено описание транзакции |
| public | [hasMetadata()](../classes/YooKassa-Model-Transfer.md#method_hasMetadata) | | Проверяет, были ли установлены метаданные |
| public | [hasPlatformFeeAmount()](../classes/YooKassa-Model-Transfer.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-Transfer.md#method_setAccountId) | | Устанавливает идентификатор магазина-получателя средств |
| public | [setAmount()](../classes/YooKassa-Model-Transfer.md#method_setAmount) | | Устанавливает сумму оплаты |
| public | [setDescription()](../classes/YooKassa-Model-Transfer.md#method_setDescription) | | Устанавливает описание транзакции |
| public | [setMetadata()](../classes/YooKassa-Model-Transfer.md#method_setMetadata) | | Устанавливает метаданные |
| public | [setPlatformFeeAmount()](../classes/YooKassa-Model-Transfer.md#method_setPlatformFeeAmount) | | Устанавливает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу |
| public | [setStatus()](../classes/YooKassa-Model-Transfer.md#method_setStatus) | | Устанавливает статус операции распределения средств конечному получателю |
| 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/Transfer.php](../../lib/Model/Transfer.php)
* Package: YooKassa
* Class Hierarchy:
* [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
* \YooKassa\Model\Transfer
* Implements:
* [\YooKassa\Model\TransferInterface](../classes/YooKassa-Model-TransferInterface.md)
---
## Constants
<a name="constant_MAX_LENGTH_DESCRIPTION" class="anchor"></a>
###### MAX_LENGTH_DESCRIPTION
Максимальная длина строки описания транзакции
```php
MAX_LENGTH_DESCRIPTION = 128
```
---
## 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_description"></a>
#### public $description : string
---
***Description***
Описание транзакции, которое продавец увидит в личном кабинете ЮKassa. (например: «Заказ маркетплейса №72»)
**Type:** <a href="string"><abbr title="string">string</abbr></a>
**Details:**
<a name="property_metadata"></a>
#### public $metadata : \YooKassa\Model\Metadata
---
***Description***
Любые дополнительные данные, которые нужны вам для работы с платежами (например, ваш внутренний идентификатор заказа)
**Type:** <a href="classes/YooKassa-Model-Metadata.html"><abbr title="\YooKassa\Model\Metadata">Metadata</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:**
<a name="property_status"></a>
#### public $status : string
---
***Description***
Статус распределения денег между магазинами. Возможные значения: `pending`, `waiting_for_capture`, `succeeded`, `canceled`
**Type:** <a href="string"><abbr title="string">string</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**
Возвращает идентификатор магазина-получателя средств
**Details:**
* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.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\Transfer](../classes/YooKassa-Model-Transfer.md)
**Returns:** \YooKassa\Model\AmountInterface - Сумма оплаты
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
<a name="method_getDescription" class="anchor"></a>
#### public getDescription() : string|null
```php
public getDescription() : string|null
```
**Summary**
Возвращает описание транзакции
**Details:**
* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md)
**Returns:** string|null - Описание транзакции
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
<a name="method_getMetadata" class="anchor"></a>
#### public getMetadata() : \YooKassa\Model\Metadata|null
```php
public getMetadata() : \YooKassa\Model\Metadata|null
```
**Summary**
Возвращает метаданные
**Details:**
* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md)
**Returns:** \YooKassa\Model\Metadata|null - Метаданные
##### 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\Transfer](../classes/YooKassa-Model-Transfer.md)
**Returns:** \YooKassa\Model\AmountInterface - Сумма комиссии
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
<a name="method_getStatus" class="anchor"></a>
#### public getStatus() : string|null
```php
public getStatus() : string|null
```
**Summary**
Возвращает статус операции распределения средств конечному получателю
**Details:**
* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md)
**Returns:** string|null - Статус операции распределения средств конечному получателю
##### 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\Transfer](../classes/YooKassa-Model-Transfer.md)
**Returns:** bool - True если сумма оплаты была установлена, false если нет
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
<a name="method_hasDescription" class="anchor"></a>
#### public hasDescription() : bool
```php
public hasDescription() : bool
```
**Summary**
Проверяет, было ли установлено описание транзакции
**Details:**
* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md)
**Returns:** bool - True если описание транзакции было установлено, false если нет
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
<a name="method_hasMetadata" class="anchor"></a>
#### public hasMetadata() : bool
```php
public hasMetadata() : bool
```
**Summary**
Проверяет, были ли установлены метаданные
**Details:**
* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.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\Transfer](../classes/YooKassa-Model-Transfer.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**
Устанавливает идентификатор магазина-получателя средств
**Details:**
* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.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\Transfer](../classes/YooKassa-Model-Transfer.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">mixed</code> | value | Сумма оплаты |
**Returns:** mixed -
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
<a name="method_setDescription" class="anchor"></a>
#### public setDescription() : mixed
```php
public setDescription(mixed $value) : mixed
```
**Summary**
Устанавливает описание транзакции
**Details:**
* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">mixed</code> | value | Описание транзакции |
**Returns:** mixed -
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
<a name="method_setMetadata" class="anchor"></a>
#### public setMetadata() : mixed
```php
public setMetadata(mixed $value) : mixed
```
**Summary**
Устанавливает метаданные
**Details:**
* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.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\Transfer](../classes/YooKassa-Model-Transfer.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">mixed</code> | value | Сумма комиссии |
**Returns:** mixed -
##### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| inheritDoc | | |
<a name="method_setStatus" class="anchor"></a>
#### public setStatus() : mixed
```php
public setStatus(string|null $value) : mixed
```
**Summary**
Устанавливает статус операции распределения средств конечному получателю
**Details:**
* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">string OR null</code> | value | |
**Returns:** mixed -
<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