Евгений Ю. Лозный
260d13f890
Добавлены нулевые привязки по СБП Добавлена причина отмены возвратов `payment_expired`
16 KiB
YooKassa API SDK
Interface: CreateRefundRequestInterface
Namespace: \YooKassa\Request\Refunds
Summary:
Interface CreateRefundRequestInterface
Constants
- No constants found
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | getAmount() | Возвращает сумму возвращаемых средств. | |
| public | getDeal() | Возвращает информацию о сделке. | |
| public | getDescription() | Возвращает комментарий к возврату или null, если комментарий не задан | |
| public | getMetadata() | Возвращает метаданные возврата. | |
| public | getPaymentId() | Возвращает айди платежа для которого создаётся возврат средств. | |
| public | getReceipt() | Возвращает инстанс чека или null, если чек не задан. | |
| public | getSources() | Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести. | |
| public | hasDeal() | Проверяет наличие информации о сделке. | |
| public | hasDescription() | Проверяет задан ли комментарий к создаваемому возврату. | |
| public | hasMetadata() | Проверяет, были ли установлены метаданные возврата. | |
| public | hasPaymentId() | Проверяет, был ли установлена идентификатор платежа. | |
| public | hasReceipt() | Проверяет задан ли чек. | |
| public | hasSources() | Проверяет наличие информации о распределении денег. | |
| public | setDeal() | Устанавливает информацию о сделке. | |
| public | setDescription() | Устанавливает комментарий к возврату. | |
| public | setMetadata() | Устанавливает метаданные возврата. | |
| public | setReceipt() | Устанавливает чек. | |
| public | setSources() | Устанавливает информацию о распределении денег — сколько и в какой магазин нужно перевести. |
Details
- File: lib/Request/Refunds/CreateRefundRequestInterface.php
- Package: \YooKassa\Request
- See Also:
Tags
| Tag | Version | Description |
|---|---|---|
| category | Class | |
| author | cms@yoomoney.ru | |
| property | Айди платежа для которого создаётся возврат | |
| property | Сумма возврата | |
| property | Комментарий к операции возврата, основание для возврата средств покупателю. | |
| property | Инстанс чека или null | |
| property | Информация о распределении денег — сколько и в какой магазин нужно перевести | |
| property | Информация о сделке |
Methods
public getPaymentId() : string|null
public getPaymentId() : string|null
Summary
Возвращает айди платежа для которого создаётся возврат средств.
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: string|null - Айди платежа для которого создаётся возврат
public getAmount() : \YooKassa\Model\AmountInterface|null
public getAmount() : \YooKassa\Model\AmountInterface|null
Summary
Возвращает сумму возвращаемых средств.
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: \YooKassa\Model\AmountInterface|null - Сумма возврата
public hasPaymentId() : bool
public hasPaymentId() : bool
Summary
Проверяет, был ли установлена идентификатор платежа.
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: bool - True если идентификатор платежа был установлен, false если нет
public setDescription() : mixed
public setDescription(string|null $description) : mixed
Summary
Устанавливает комментарий к возврату.
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
description | Комментарий к операции возврата, основание для возврата средств покупателю |
Returns: mixed -
public getDescription() : string|null
public getDescription() : string|null
Summary
Возвращает комментарий к возврату или null, если комментарий не задан
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: string|null - Комментарий к операции возврата, основание для возврата средств покупателю.
public hasDescription() : bool
public hasDescription() : bool
Summary
Проверяет задан ли комментарий к создаваемому возврату.
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: bool - True если комментарий установлен, false если нет
public setReceipt() : mixed
public setReceipt(null|\YooKassa\Model\Receipt\ReceiptInterface $receipt) : mixed
Summary
Устанавливает чек.
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
null OR \YooKassa\Model\Receipt\ReceiptInterface |
receipt | Инстанс чека или null для удаления информации о чеке |
Returns: mixed -
public getReceipt() : null|\YooKassa\Model\Receipt\ReceiptInterface
public getReceipt() : null|\YooKassa\Model\Receipt\ReceiptInterface
Summary
Возвращает инстанс чека или null, если чек не задан.
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: null|\YooKassa\Model\Receipt\ReceiptInterface - Инстанс чека или null
public hasReceipt() : bool
public hasReceipt() : bool
Summary
Проверяет задан ли чек.
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: bool - True если чек есть, false если нет
public setSources() : mixed
public setSources(\YooKassa\Model\Refund\SourceInterface[]|array|null $sources) : mixed
Summary
Устанавливает информацию о распределении денег — сколько и в какой магазин нужно перевести.
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\Refund\SourceInterface[] OR array OR null |
sources | Информация о распределении денег |
Returns: mixed -
public getSources() : \YooKassa\Model\Refund\SourceInterface[]|\YooKassa\Common\ListObjectInterface
public getSources() : \YooKassa\Model\Refund\SourceInterface[]|\YooKassa\Common\ListObjectInterface
Summary
Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести.
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: \YooKassa\Model\Refund\SourceInterface[]|\YooKassa\Common\ListObjectInterface - Информация о распределении денег
public hasSources() : bool
public hasSources() : bool
Summary
Проверяет наличие информации о распределении денег.
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: bool -
public setDeal() : mixed
public setDeal(\YooKassa\Model\Deal\RefundDealData|null $deal) : mixed
Summary
Устанавливает информацию о сделке.
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\Deal\RefundDealData OR null |
deal | Информация о сделке |
Returns: mixed -
public getDeal() : \YooKassa\Model\Deal\RefundDealData|null
public getDeal() : \YooKassa\Model\Deal\RefundDealData|null
Summary
Возвращает информацию о сделке.
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: \YooKassa\Model\Deal\RefundDealData|null - Информация о сделке
public hasDeal() : bool
public hasDeal() : bool
Summary
Проверяет наличие информации о сделке.
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: bool -
public getMetadata() : \YooKassa\Model\Metadata|null
public getMetadata() : \YooKassa\Model\Metadata|null
Summary
Возвращает метаданные возврата.
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: \YooKassa\Model\Metadata|null -
public hasMetadata() : bool
public hasMetadata() : bool
Summary
Проверяет, были ли установлены метаданные возврата.
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: bool - True если метаданные были установлены, false если нет
public setMetadata() : self
public setMetadata(\YooKassa\Model\Metadata|array|null $metadata = null) : self
Summary
Устанавливает метаданные возврата.
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\Metadata OR array OR null |
metadata | Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. |
Returns: self -
Top Namespaces
Reports
This document was automatically generated from source code comments on 2026-06-29 using phpDocumentor
© 2026 YooMoney