Антон Н. Николаев
9.7 KiB
YooKassa API SDK
Interface: CreateRefundRequestInterface
Namespace: \YooKassa\Request\Refunds
Summary:
Интерфейс объекта запроса на возврат
Constants
- No constants found
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | getAmount() | Возвращает сумму возвращаемых средств | |
| public | getDescription() | Возвращает комментарий к возврату или null, если комментарий не задан | |
| public | getPaymentId() | Возвращает айди платежа для которого создаётся возврат средств | |
| public | getReceipt() | Возвращает инстанс чека или null если чек не задан | |
| public | getSources() | Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести | |
| public | hasDescription() | Проверяет задан ли комментарий к создаваемому возврату | |
| public | hasReceipt() | Проверяет задан ли чек | |
| public | hasSources() | Проверяет наличие информации о распределении денег | |
| public | setDescription() | Устанавливает комментарий к возврату | |
| public | setReceipt() | Устанавливает чек | |
| public | setSources() | Устанавливает информацию о распределении денег — сколько и в какой магазин нужно перевести |
Details
- File: lib/Request/Refunds/CreateRefundRequestInterface.php
- Package: \YooKassa
Tags
| Tag | Version | Description |
|---|---|---|
| property-read | Айди платежа для которого создаётся возврат | |
| property-read | Сумма возврата | |
| property-read | Комментарий к операции возврата, основание для возврата средств покупателю. | |
| property-read | Инстанс чека или null |
Methods
public getPaymentId() : string
public getPaymentId() : string
Summary
Возвращает айди платежа для которого создаётся возврат средств
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: string - Айди платежа для которого создаётся возврат
public getAmount() : \YooKassa\Model\AmountInterface
public getAmount() : \YooKassa\Model\AmountInterface
Summary
Возвращает сумму возвращаемых средств
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: \YooKassa\Model\AmountInterface - Сумма возврата
public setDescription() : mixed
public setDescription(string $value) : mixed
Summary
Устанавливает комментарий к возврату
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Комментарий к операции возврата, основание для возврата средств покупателю |
Returns: mixed -
public getDescription() : string
public getDescription() : string
Summary
Возвращает комментарий к возврату или null, если комментарий не задан
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: string - Комментарий к операции возврата, основание для возврата средств покупателю.
public hasDescription() : bool
public hasDescription() : bool
Summary
Проверяет задан ли комментарий к создаваемому возврату
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: bool - True если комментарий установлен, false если нет
public setReceipt() : mixed
public setReceipt(\YooKassa\Model\ReceiptInterface|null $value) : mixed
Summary
Устанавливает чек
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
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:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: \YooKassa\Model\ReceiptInterface|null - Инстанс чека или 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\SourceInterface[] $value) : mixed
Summary
Устанавливает информацию о распределении денег — сколько и в какой магазин нужно перевести
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\SourceInterface[] |
value | Информация о распределении денег |
Returns: mixed -
public getSources() : \YooKassa\Model\SourceInterface[]
public getSources() : \YooKassa\Model\SourceInterface[]
Summary
Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: \YooKassa\Model\SourceInterface[] - Информация о распределении денег
public hasSources() : bool
public hasSources() : bool
Summary
Проверяет наличие информации о распределении денег
Details:
- Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestInterface
Returns: bool -
Top Namespaces
Reports
This document was automatically generated from source code comments on 2021-09-28 using phpDocumentor
© 2021 YooMoney