meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.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

12 KiB
Raw Blame History

YooKassa API SDK

Interface: CreateRefundRequestInterface

Namespace: \YooKassa\Request\Refunds


Summary:

Интерфейс объекта запроса на возврат


Constants

  • No constants found

Methods

Visibility Name Flag Summary
public getAmount() Возвращает сумму возвращаемых средств
public getDeal() Возвращает информацию о сделке
public getDescription() Возвращает комментарий к возврату или null, если комментарий не задан
public getPaymentId() Возвращает айди платежа для которого создаётся возврат средств
public getReceipt() Возвращает инстанс чека или null, если чек не задан
public getSources() Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести
public hasDeal() Проверяет наличие информации о сделке
public hasDescription() Проверяет задан ли комментарий к создаваемому возврату
public hasPaymentId() Проверяет, был ли установлена идентификатор платежа
public hasReceipt() Проверяет задан ли чек
public hasSources() Проверяет наличие информации о распределении денег
public setDeal() Устанавливает информацию о сделке
public setDescription() Устанавливает комментарий к возврату
public setReceipt() Устанавливает чек
public setSources() Устанавливает информацию о распределении денег — сколько и в какой магазин нужно перевести

Details


Tags

Tag Version Description
property-read Айди платежа для которого создаётся возврат
property-read Сумма возврата
property-read Комментарий к операции возврата, основание для возврата средств покупателю.
property-read Инстанс чека или null

Methods

public getPaymentId() : string

public getPaymentId() : string

Summary

Возвращает айди платежа для которого создаётся возврат средств

Details:

Returns: string - Айди платежа для которого создаётся возврат

public getAmount() : \YooKassa\Model\AmountInterface

public getAmount() : \YooKassa\Model\AmountInterface

Summary

Возвращает сумму возвращаемых средств

Details:

Returns: \YooKassa\Model\AmountInterface - Сумма возврата

public hasPaymentId() : bool

public hasPaymentId() : bool

Summary

Проверяет, был ли установлена идентификатор платежа

Details:

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

public setDescription() : mixed

public setDescription(string $value) : mixed

Summary

Устанавливает комментарий к возврату

Details:

Parameters:
Type Name Description
string value Комментарий к операции возврата, основание для возврата средств покупателю

Returns: mixed -

public getDescription() : string

public getDescription() : string

Summary

Возвращает комментарий к возврату или null, если комментарий не задан

Details:

Returns: string - Комментарий к операции возврата, основание для возврата средств покупателю.

public hasDescription() : bool

public hasDescription() : bool

Summary

Проверяет задан ли комментарий к создаваемому возврату

Details:

Returns: bool - True если комментарий установлен, false если нет

public setReceipt() : mixed

public setReceipt(\YooKassa\Model\ReceiptInterface|null $value) : mixed

Summary

Устанавливает чек

Details:

Parameters:
Type Name Description
\YooKassa\Model\ReceiptInterface OR null value Инстанс чека или null для удаления информации о чеке

Returns: mixed -

public getReceipt() : \YooKassa\Model\ReceiptInterface|null

public getReceipt() : \YooKassa\Model\ReceiptInterface|null

Summary

Возвращает инстанс чека или null, если чек не задан

Details:

Returns: \YooKassa\Model\ReceiptInterface|null - Инстанс чека или null

public hasReceipt() : bool

public hasReceipt() : bool

Summary

Проверяет задан ли чек

Details:

Returns: bool - True если чек есть, false если нет

public setSources() : mixed

public setSources(\YooKassa\Model\SourceInterface[] $value) : mixed

Summary

Устанавливает информацию о распределении денег — сколько и в какой магазин нужно перевести

Details:

Parameters:
Type Name Description
\YooKassa\Model\SourceInterface[] value Информация о распределении денег

Returns: mixed -

public getSources() : \YooKassa\Model\SourceInterface[]

public getSources() : \YooKassa\Model\SourceInterface[]

Summary

Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести

Details:

Returns: \YooKassa\Model\SourceInterface[] - Информация о распределении денег

public hasSources() : bool

public hasSources() : bool

Summary

Проверяет наличие информации о распределении денег

Details:

Returns: bool -

public setDeal() : mixed

public setDeal(\YooKassa\Model\Deal\RefundDealData $value) : mixed

Summary

Устанавливает информацию о сделке

Details:

Parameters:
Type Name Description
\YooKassa\Model\Deal\RefundDealData value Информация о сделке

Returns: mixed -

public getDeal() : \YooKassa\Model\Deal\RefundDealData

public getDeal() : \YooKassa\Model\Deal\RefundDealData

Summary

Возвращает информацию о сделке

Details:

Returns: \YooKassa\Model\Deal\RefundDealData - Информация о сделке

public hasDeal() : bool

public hasDeal() : bool

Summary

Проверяет наличие информации о сделке

Details:

Returns: bool -


Top Namespaces


Reports


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

© 2023 YooMoney