Files
yookassa-sdk-php/docs/classes/YooKassa-Request-Refunds-CreateRefundRequest.md
Евгений Ю. Лозный 260d13f890 Добавлен прием платежей через Alfa Pay. Добавлен новый тип ошибки RuleViolationError
Добавлены нулевые привязки по СБП
Добавлена причина отмены возвратов `payment_expired`
2026-06-29 17:46:40 +03:00

42 KiB
Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Request\Refunds\CreateRefundRequest

Namespace: \YooKassa\Request\Refunds


Summary:

Класс, представляющий модель CreateRefundRequest.

Description:

Класс объекта запроса для создания возврата.


Examples

Пример использования билдера

try {
    $refundBuilder = \YooKassa\Request\Refunds\CreateRefundRequest::builder();
    $refundBuilder
        ->setPaymentId('24b94598-000f-5000-9000-1b68e7b15f3f')
        ->setAmount(3500.00)
        ->setCurrency(\YooKassa\Model\CurrencyCode::RUB)
        ->setDescription('Не подошел цвет')
        ->setReceiptItems([
            (new \YooKassa\Model\Receipt\ReceiptItem)
                ->setDescription('Платок Gucci Новый')
                ->setQuantity(1)
                ->setVatCode(2)
                ->setPrice(new \YooKassa\Model\Receipt\ReceiptItemAmount(3500.00))
                ->setPaymentSubject(\YooKassa\Model\Receipt\PaymentSubject::COMMODITY)
                ->setPaymentMode(\YooKassa\Model\Receipt\PaymentMode::FULL_PAYMENT)
        ])
        ->setReceiptEmail('john.doe@merchant.com')
        ->setTaxSystemCode(1)
    ;

    // Создаем объект запроса
    $request = $refundBuilder->build();

    // Можно изменить данные, если нужно
    $request->setDescription('Не подошел цвет и размер');

    $idempotenceKey = uniqid('', true);
    $response = $client->createRefund($request, $idempotenceKey);
} catch (Exception $e) {
    $response = $e;
}

var_dump($response);


Constants

  • No constants found

Properties

Visibility Name Flag Summary
public $amount Сумма возврата
public $deal Информация о сделке
public $description Комментарий к операции возврата, основание для возврата средств покупателю.
public $metadata Метаданные возврата указанные мерчантом
public $payment_id Идентификатор платежа для которого создаётся возврат
public $paymentId Идентификатор платежа для которого создаётся возврат
public $receipt Инстанс чека или null
public $refund_method_data Метод возврата
public $refundMethodData Метод возврата
public $sources Информация о распределении денег — сколько и в какой магазин нужно перевести
protected $_metadata

Methods

Visibility Name Flag Summary
public __construct() AbstractObject constructor.
public __get() Возвращает значение свойства.
public __isset() Проверяет наличие свойства.
public __set() Устанавливает значение свойства.
public __unset() Удаляет свойство.
public builder() Возвращает билдер объектов текущего типа.
public clearValidationError() Очищает статус валидации текущего запроса.
public fromArray() Устанавливает значения свойств текущего объекта из массива.
public getAmount() Возвращает сумму возврата.
public getDeal() Возвращает данные о сделке, в составе которой проходит возврат
public getDescription() Возвращает комментарий к возврату или null, если комментарий не задан.
public getLastValidationError() Возвращает последнюю ошибку валидации.
public getMetadata() Возвращает метаданные возврата.
public getPaymentId() Возвращает идентификатор платежа для которого создаётся возврат средств.
public getReceipt() Возвращает чек, если он есть.
public getRefundMethodData() Возвращает метод возврата.
public getSources() Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести.
public getValidator()
public hasAmount() Проверяет, была ли установлена сумма возврата.
public hasDeal() Проверяет, были ли установлены данные о сделке.
public hasDescription() Проверяет задан ли комментарий к создаваемому возврату.
public hasMetadata() Проверяет, были ли установлены метаданные возврата.
public hasPaymentId() Проверяет, был ли установлена идентификатор платежа.
public hasReceipt() Проверяет наличие чека.
public hasRefundMethodData() Проверяет установлен ли объект с методом возврата.
public hasSources() Проверяет наличие информации о распределении денег.
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public removeReceipt() Удаляет чек из запроса.
public setAmount() Устанавливает сумму.
public setDeal() Устанавливает данные о сделке, в составе которой проходит возврат
public setDescription() Устанавливает комментарий к возврату.
public setMetadata() Устанавливает метаданные возврата.
public setPaymentId() Устанавливает идентификатор платежа для которого создаётся возврат
public setReceipt() Устанавливает чек.
public setRefundMethodData() Устанавливает метод возврата.
public setSources() Устанавливает sources (массив распределения денег между магазинами).
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
public validate() Валидирует объект запроса.
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected setValidationError() Устанавливает ошибку валидации.
protected validatePropertyValue()

Details


Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Properties

public $amount : \YooKassa\Model\AmountInterface


Description

Сумма возврата

Type: AmountInterface

Details:

public $deal : null|\YooKassa\Model\Deal\RefundDealData


Description

Информация о сделке

Type: RefundDealData

Details:

public $description : string


Description

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

Type: string

Details:

public $metadata : \YooKassa\Model\Metadata|null


Description

Метаданные возврата указанные мерчантом

Type: Metadata|null

Details:

public $payment_id : string


Description

Идентификатор платежа для которого создаётся возврат

Type: string

Details:

public $paymentId : string


Description

Идентификатор платежа для которого создаётся возврат

Type: string

Details:

public $receipt : null|\YooKassa\Model\Receipt\ReceiptInterface


Description

Инстанс чека или null

Type: ReceiptInterface

Details:

public $refund_method_data : null|\YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData


Description

Метод возврата

Type: AbstractRefundMethodData

Details:

public $refundMethodData : null|\YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData


Description

Метод возврата

Type: AbstractRefundMethodData

Details:

public $sources : null|\YooKassa\Common\ListObjectInterface|\YooKassa\Model\Refund\SourceInterface[]


Description

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

Type: SourceInterface[]

Details:

protected $_metadata : ?\YooKassa\Model\Metadata


Type: Metadata Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. Details:


Methods

public __construct() : mixed

public __construct(array|null $data = []) : mixed

Summary

AbstractObject constructor.

Details:

Parameters:
Type Name Description
array OR null data

Returns: mixed -

public __get() : mixed

public __get(string $propertyName) : mixed

Summary

Возвращает значение свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя свойства

Returns: mixed - Значение свойства

public __isset() : bool

public __isset(string $propertyName) : bool

Summary

Проверяет наличие свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public __set() : void

public __set(string $propertyName, mixed $value) : void

Summary

Устанавливает значение свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя свойства
mixed value Значение свойства

Returns: void -

public __unset() : void

public __unset(string $propertyName) : void

Summary

Удаляет свойство.

Details:

Parameters:
Type Name Description
string propertyName Имя удаляемого свойства

Returns: void -

public builder() : \YooKassa\Request\Refunds\CreateRefundRequestBuilder

Static public builder() : \YooKassa\Request\Refunds\CreateRefundRequestBuilder

Summary

Возвращает билдер объектов текущего типа.

Details:

Returns: \YooKassa\Request\Refunds\CreateRefundRequestBuilder - Инстанс билдера запросов

public clearValidationError() : void

public clearValidationError() : void

Summary

Очищает статус валидации текущего запроса.

Details:

Returns: void -

public fromArray() : void

public fromArray(array|\Traversable $sourceArray) : void

Summary

Устанавливает значения свойств текущего объекта из массива.

Details:

Parameters:
Type Name Description
array OR \Traversable sourceArray Ассоциативный массив с настройками

Returns: void -

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

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

Summary

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

Details:

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

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

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

Summary

Возвращает данные о сделке, в составе которой проходит возврат

Details:

Returns: \YooKassa\Model\Deal\RefundDealData|null - Данные о сделке, в составе которой проходит возврат

public getDescription() : string|null

public getDescription() : string|null

Summary

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

Details:

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

public getLastValidationError() : string|null

public getLastValidationError() : string|null

Summary

Возвращает последнюю ошибку валидации.

Details:

Returns: string|null - Последняя произошедшая ошибка валидации

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

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

Summary

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

Details:

Returns: \YooKassa\Model\Metadata|null -

public getPaymentId() : string|null

public getPaymentId() : string|null

Summary

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

Details:

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

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

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

Summary

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

Details:

Returns: null|\YooKassa\Model\Receipt\ReceiptInterface - Данные фискального чека 54-ФЗ или null, если чека нет

public getRefundMethodData() : \YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData|null

public getRefundMethodData() : \YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData|null

Summary

Возвращает метод возврата.

Details:

Returns: \YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData|null - Метод возврата

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 getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

public hasAmount() : bool

public hasAmount() : bool

Summary

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

Details:

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

public hasDeal() : bool

public hasDeal() : bool

Summary

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

Details:

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

public hasDescription() : bool

public hasDescription() : bool

Summary

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

Details:

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

public hasMetadata() : bool

public hasMetadata() : bool

Summary

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

Details:

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

public hasPaymentId() : bool

public hasPaymentId() : bool

Summary

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

Details:

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

public hasReceipt() : bool

public hasReceipt() : bool

Summary

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

Details:

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

public hasRefundMethodData() : bool

public hasRefundMethodData() : bool

Summary

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

Details:

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

public hasSources() : bool

public hasSources() : bool

Summary

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

Details:

Returns: bool -

public jsonSerialize() : array

public jsonSerialize() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.

Details:

Returns: array - Ассоциативный массив со свойствами текущего объекта

public offsetExists() : bool

public offsetExists(string $offset) : bool

Summary

Проверяет наличие свойства.

Details:

Parameters:
Type Name Description
string offset Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public offsetGet() : mixed

public offsetGet(string $offset) : mixed

Summary

Возвращает значение свойства.

Details:

Parameters:
Type Name Description
string offset Имя свойства

Returns: mixed - Значение свойства

public offsetSet() : void

public offsetSet(string $offset, mixed $value) : void

Summary

Устанавливает значение свойства.

Details:

Parameters:
Type Name Description
string offset Имя свойства
mixed value Значение свойства

Returns: void -

public offsetUnset() : void

public offsetUnset(string $offset) : void

Summary

Удаляет свойство.

Details:

Parameters:
Type Name Description
string offset Имя удаляемого свойства

Returns: void -

public removeReceipt() : void

public removeReceipt() : void

Summary

Удаляет чек из запроса.

Details:

Returns: void -

public setAmount() : self

public setAmount(\YooKassa\Model\AmountInterface|array|string $amount = null) : self

Summary

Устанавливает сумму.

Details:

Parameters:
Type Name Description
\YooKassa\Model\AmountInterface OR array OR string amount Сумма возврата

Returns: self -

public setDeal() : self

public setDeal(null|array|\YooKassa\Model\Deal\RefundDealData $deal = null) : self

Summary

Устанавливает данные о сделке, в составе которой проходит возврат

Details:

Parameters:
Type Name Description
null OR array OR \YooKassa\Model\Deal\RefundDealData deal Данные о сделке, в составе которой проходит возврат

Returns: self -

public setDescription() : self

public setDescription(string|null $description = null) : self

Summary

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

Details:

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

Returns: self -

public setMetadata() : self

public setMetadata(\YooKassa\Model\Metadata|array|null $metadata = null) : self

Summary

Устанавливает метаданные возврата.

Details:

Parameters:
Type Name Description
\YooKassa\Model\Metadata OR array OR null metadata Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.

Returns: self -

public setPaymentId() : self

public setPaymentId(string|null $payment_id = null) : self

Summary

Устанавливает идентификатор платежа для которого создаётся возврат

Details:

Parameters:
Type Name Description
string OR null payment_id Идентификатор платежа

Returns: self -

public setReceipt() : self

public setReceipt(null|array|\YooKassa\Model\Receipt\ReceiptInterface $receipt = null) : self

Summary

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

Details:

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

Returns: self -

public setRefundMethodData() : self

public setRefundMethodData(\YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData|array|null $refund_method_data = null) : self

Summary

Устанавливает метод возврата.

Details:

Parameters:
Type Name Description
\YooKassa\Request\Refunds\RefundMethodData\AbstractRefundMethodData OR array OR null refund_method_data Метод возврата

Returns: self -

public setSources() : self

public setSources(array|\YooKassa\Common\ListObjectInterface|null $sources = null) : self

Summary

Устанавливает sources (массив распределения денег между магазинами).

Details:

Parameters:
Type Name Description
array OR \YooKassa\Common\ListObjectInterface OR null sources Массив распределения денег между магазинами

Returns: self -

public toArray() : array

public toArray() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().

Details:

Returns: array - Ассоциативный массив со свойствами текущего объекта

public validate() : bool

public validate() : bool

Summary

Валидирует объект запроса.

Details:

Returns: bool - True если запрос валиден и его можно отправить в API, false если нет

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

Возвращает массив свойств которые не существуют, но были заданы у объекта.

Details:

Returns: array - Ассоциативный массив с не существующими у текущего объекта свойствами

protected setValidationError() : void

protected setValidationError(string $value) : void

Summary

Устанавливает ошибку валидации.

Details:

Parameters:
Type Name Description
string value Ошибка, произошедшая при валидации объекта

Returns: void -

protected validatePropertyValue() : mixed

protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed

Details:

Parameters:
Type Name Description
string propertyName
mixed propertyValue

Returns: mixed -


Top Namespaces


Reports


This document was automatically generated from source code comments on 2026-06-29 using phpDocumentor

© 2026 YooMoney