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

YooKassa API SDK

Interface: TransferInterface

Namespace: \YooKassa\Model

---

Summary:

Interface TransferInterface

Description:

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

---

Constants

• No constants found

---

Methods

Visibility	Name	Flag	Summary
public	getAccountId()		Возвращает идентификатор магазина-получателя средств
public	getAmount()		Возвращает сумму оплаты
public	getMetadata()		Возвращает метаданные
public	getPlatformFeeAmount()		Возвращает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу
public	getStatus()		Возвращает статус операции распределения средств конечному получателю
public	hasAmount()		Проверяет, была ли установлена сумма оплаты
public	hasMetadata()		Проверяет, были ли установлены метаданные
public	hasPlatformFeeAmount()		Проверяет, была ли установлена комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу
public	setAccountId()		Устанавливает идентификатор магазина-получателя средств
public	setAmount()		Устанавливает сумму оплаты
public	setMetadata()		Устанавливает метаданные
public	setPlatformFeeAmount()		Устанавливает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу
public	setStatus()		Устанавливает статус операции распределения средств конечному получателю

---

Details

• File: lib/Model/TransferInterface.php
• Package: \YooKassa

---

Tags

Tag	Version	Description
property		Сумма, которую необходимо перечислить магазину
property		Комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу
property		Идентификатор магазина, в пользу которого вы принимаете оплату
property		Статус распределения денег между магазинами. Возможные значения: pending, waiting_for_capture, succeeded, canceled
property		Любые дополнительные данные, которые нужны вам для работы с платежами (например, номер заказа)

---

Methods

public setAccountId() : void

public setAccountId(string $value) : void

Summary

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

Details:

• Inherited From: \YooKassa\Model\TransferInterface

Parameters:

Type	Name	Description
string	value	Идентификатор магазина-получателя средств

Returns: void -

public getAccountId() : string|null

public getAccountId() : string|null

Summary

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

Details:

• Inherited From: \YooKassa\Model\TransferInterface

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

public getAmount() : \YooKassa\Model\AmountInterface

public getAmount() : \YooKassa\Model\AmountInterface

Summary

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

Details:

• Inherited From: \YooKassa\Model\TransferInterface

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

public hasAmount() : bool

public hasAmount() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Model\TransferInterface

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

public setAmount() : mixed

public setAmount(\YooKassa\Model\AmountInterface|array $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\TransferInterface

Parameters:

Type	Name	Description
\YooKassa\Model\AmountInterface OR array	value	Сумма оплаты

Returns: mixed -

public getPlatformFeeAmount() : \YooKassa\Model\AmountInterface

public getPlatformFeeAmount() : \YooKassa\Model\AmountInterface

Summary

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

Details:

• Inherited From: \YooKassa\Model\TransferInterface

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

public hasPlatformFeeAmount() : bool

public hasPlatformFeeAmount() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Model\TransferInterface

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

public setPlatformFeeAmount() : mixed

public setPlatformFeeAmount(\YooKassa\Model\AmountInterface|array $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\TransferInterface

Parameters:

Type	Name	Description
\YooKassa\Model\AmountInterface OR array	value	Сумма комиссии

Returns: mixed -

public getStatus() : string|null

public getStatus() : string|null

Summary

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

Details:

• Inherited From: \YooKassa\Model\TransferInterface

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

public setStatus() : mixed

public setStatus(string|null $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\TransferInterface

Parameters:

Type	Name	Description
string OR null	value

Returns: mixed -

public setMetadata() : mixed

public setMetadata(\YooKassa\Model\Metadata|array $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\TransferInterface

Parameters:

Type	Name	Description
\YooKassa\Model\Metadata OR array	value	Метаданные

Returns: mixed -

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Model\TransferInterface

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

public hasMetadata() : bool

public hasMetadata() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Model\TransferInterface

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

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 0
• Deprecated - 13

---

This document was automatically generated from source code comments on 2022-04-22 using phpDocumentor

© 2022 YooMoney