meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Model-Transfer.md

YooKassa API SDK

Class: \YooKassa\Model\Transfer

Namespace: \YooKassa\Model

---

Summary:

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

Description:

Данные о распределении денег — сколько и в какой магазин нужно перевести. Присутствует, если вы используете решение ЮKassa для платформ.

---

Constants

Visibility	Name	Flag	Summary
public	MAX_LENGTH_DESCRIPTION		Максимальная длина строки описания транзакции

---

Properties

Visibility	Name	Flag	Summary
public	$accountId		Идентификатор магазина, в пользу которого вы принимаете оплату
public	$amount		Сумма, которую необходимо перечислить магазину
public	$description		Описание транзакции, которое продавец увидит в личном кабинете ЮKassa. (например: «Заказ маркетплейса №72»)
public	$metadata		Любые дополнительные данные, которые нужны вам для работы с платежами (например, ваш внутренний идентификатор заказа)
public	$platform_fee_amount		Комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу
public	$status		Статус распределения денег между магазинами. Возможные значения: pending, waiting_for_capture, succeeded, canceled

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства
public	__isset()		Проверяет наличие свойства
public	__set()		Устанавливает значение свойства
public	__unset()		Удаляет свойство
public	fromArray()		Устанавливает значения свойств текущего объекта из массива
public	getAccountId()		Возвращает идентификатор магазина-получателя средств
public	getAmount()		Возвращает сумму оплаты
public	getDescription()		Возвращает описание транзакции
public	getMetadata()		Возвращает метаданные
public	getPlatformFeeAmount()		Возвращает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу
public	getStatus()		Возвращает статус операции распределения средств конечному получателю
public	hasAmount()		Проверяет, была ли установлена сумма оплаты
public	hasDescription()		Проверяет, было ли установлено описание транзакции
public	hasMetadata()		Проверяет, были ли установлены метаданные
public	hasPlatformFeeAmount()		Проверяет, была ли установлена комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу
public	jsonSerialize()
public	offsetExists()
public	offsetGet()
public	offsetSet()
public	offsetUnset()
public	setAccountId()		Устанавливает идентификатор магазина-получателя средств
public	setAmount()		Устанавливает сумму оплаты
public	setDescription()		Устанавливает описание транзакции
public	setMetadata()		Устанавливает метаданные
public	setPlatformFeeAmount()		Устанавливает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу
public	setStatus()		Устанавливает статус операции распределения средств конечному получателю
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта

---

Details

• File: lib/Model/Transfer.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Model\Transfer
• Implements:
  • \YooKassa\Model\TransferInterface

---

Constants

MAX_LENGTH_DESCRIPTION

Максимальная длина строки описания транзакции

MAX_LENGTH_DESCRIPTION = 128

---

Properties

public $accountId : string

---

Description

Идентификатор магазина, в пользу которого вы принимаете оплату

Type: string

Details:

public $amount : \YooKassa\Model\AmountInterface

---

Description

Сумма, которую необходимо перечислить магазину

Type: AmountInterface

Details:

public $description : string

---

Description

Описание транзакции, которое продавец увидит в личном кабинете ЮKassa. (например: «Заказ маркетплейса №72»)

Type: string

Details:

public $metadata : \YooKassa\Model\Metadata

---

Description

Любые дополнительные данные, которые нужны вам для работы с платежами (например, ваш внутренний идентификатор заказа)

Type: Metadata

Details:

public $platform_fee_amount : \YooKassa\Model\AmountInterface

---

Description

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

Type: AmountInterface

Details:

public $status : string

---

Description

Статус распределения денег между магазинами. Возможные значения: pending, waiting_for_capture, succeeded, canceled

Type: string

Details:

---

Methods

public __construct() : mixed

public __construct(array $data = array()) : mixed

Summary

AbstractObject constructor.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

Возвращает идентификатор магазина-получателя средств

Details:

• Inherited From: \YooKassa\Model\Transfer

Returns: string|null - Идентификатор магазина-получателя средств

Tags

Tag	Version	Description
inheritDoc

public getAmount() : \YooKassa\Model\AmountInterface

public getAmount() : \YooKassa\Model\AmountInterface

Summary

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

Details:

• Inherited From: \YooKassa\Model\Transfer

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

Tags

Tag	Version	Description
inheritDoc

public getDescription() : string|null

public getDescription() : string|null

Summary

Возвращает описание транзакции

Details:

• Inherited From: \YooKassa\Model\Transfer

Returns: string|null - Описание транзакции

Tags

Tag	Version	Description
inheritDoc

public getMetadata() : \YooKassa\Model\Metadata|null

public getMetadata() : \YooKassa\Model\Metadata|null

Summary

Возвращает метаданные

Details:

• Inherited From: \YooKassa\Model\Transfer

Returns: \YooKassa\Model\Metadata|null - Метаданные

Tags

Tag	Version	Description
inheritDoc

public getPlatformFeeAmount() : \YooKassa\Model\AmountInterface

public getPlatformFeeAmount() : \YooKassa\Model\AmountInterface

Summary

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

Details:

• Inherited From: \YooKassa\Model\Transfer

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

Tags

Tag	Version	Description
inheritDoc

public getStatus() : string|null

public getStatus() : string|null

Summary

Возвращает статус операции распределения средств конечному получателю

Details:

• Inherited From: \YooKassa\Model\Transfer

Returns: string|null - Статус операции распределения средств конечному получателю

Tags

Tag	Version	Description
inheritDoc

public hasAmount() : bool

public hasAmount() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Model\Transfer

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

Tags

Tag	Version	Description
inheritDoc

public hasDescription() : bool

public hasDescription() : bool

Summary

Проверяет, было ли установлено описание транзакции

Details:

• Inherited From: \YooKassa\Model\Transfer

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

Tags

Tag	Version	Description
inheritDoc

public hasMetadata() : bool

public hasMetadata() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Model\Transfer

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

Tags

Tag	Version	Description
inheritDoc

public hasPlatformFeeAmount() : bool

public hasPlatformFeeAmount() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Model\Transfer

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

Tags

Tag	Version	Description
inheritDoc

public jsonSerialize() : mixed

public jsonSerialize() : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: mixed -

public offsetExists() : mixed

public offsetExists(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetGet() : mixed

public offsetGet(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetSet() : mixed

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset
mixed	value

Returns: mixed -

public offsetUnset() : mixed

public offsetUnset(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public setAccountId() : void

public setAccountId(mixed $value) : void

Summary

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

Details:

• Inherited From: \YooKassa\Model\Transfer

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\Transfer

Parameters:

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

Returns: mixed -

Tags

Tag	Version	Description
inheritDoc

public setDescription() : mixed

public setDescription(mixed $value) : mixed

Summary

Устанавливает описание транзакции

Details:

• Inherited From: \YooKassa\Model\Transfer

Parameters:

Type	Name	Description
mixed	value	Описание транзакции

Returns: mixed -

Tags

Tag	Version	Description
inheritDoc

public setMetadata() : mixed

public setMetadata(mixed $value) : mixed

Summary

Устанавливает метаданные

Details:

• Inherited From: \YooKassa\Model\Transfer

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\Transfer

Parameters:

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

Returns: mixed -

Tags

Tag	Version	Description
inheritDoc

public setStatus() : mixed

public setStatus(string|null $value) : mixed

Summary

Устанавливает статус операции распределения средств конечному получателю

Details:

• Inherited From: \YooKassa\Model\Transfer

Parameters:

Type	Name	Description
string OR null	value

Returns: mixed -

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 - 1
• Deprecated - 25

---

This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor

© 2023 YooMoney