Files
yookassa-sdk-php/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md
T
2023-10-17 12:28:43 +03:00

13 KiB
Raw Blame History

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 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
category Class
author cms@yoomoney.ru
property Айди платежа для которого создаётся возврат
property Сумма возврата
property Комментарий к операции возврата, основание для возврата средств покупателю.
property Инстанс чека или null
property Информация о распределении денег — сколько и в какой магазин нужно перевести
property Информация о сделке

Methods

public getPaymentId() : string|null

public getPaymentId() : string|null

Summary

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

Details:

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

public getAmount() : \YooKassa\Model\AmountInterface|null

public getAmount() : \YooKassa\Model\AmountInterface|null

Summary

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

Details:

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

public hasPaymentId() : bool

public hasPaymentId() : bool

Summary

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

Details:

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

public setDescription() : mixed

public setDescription(string|null $description) : mixed

Summary

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

Details:

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

Returns: mixed -

public getDescription() : string|null

public getDescription() : string|null

Summary

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

Details:

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

public hasDescription() : bool

public hasDescription() : bool

Summary

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

Details:

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

public setReceipt() : mixed

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

Summary

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

Details:

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:

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

public hasReceipt() : bool

public hasReceipt() : bool

Summary

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

Details:

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

public setSources() : mixed

public setSources(\YooKassa\Model\Refund\SourceInterface[]|array|null $sources) : mixed

Summary

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

Details:

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:

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

public hasSources() : bool

public hasSources() : bool

Summary

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

Details:

Returns: bool -

public setDeal() : mixed

public setDeal(\YooKassa\Model\Deal\RefundDealData|null $deal) : mixed

Summary

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

Details:

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:

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

public hasDeal() : bool

public hasDeal() : bool

Summary

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

Details:

Returns: bool -


Top Namespaces


Reports


This document was automatically generated from source code comments on 2023-10-17 using phpDocumentor

© 2023 YooMoney