geckon01/yookassa-sdk-php
1
0
Fork 0
mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-08-17 15:31:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
yookassa-sdk-php/docs/classes/YooKassa-Request-Refunds-RefundResponse.md
T
Евгений Ю. Лозный 260d13f890 Добавлен прием платежей через Alfa Pay. Добавлен новый тип ошибки RuleViolationError 
Добавлены нулевые привязки по СБП
Добавлена причина отмены возвратов `payment_expired`
2026-06-29 17:46:40 +03:00

50 KiB
Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Request\Refunds\RefundResponse

Namespace: \YooKassa\Request\Refunds

Summary:

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

Description:

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

Constants

Visibility Name Flag Summary
public MAX_LENGTH_DESCRIPTION Максимальная длина строки описания возврата

Properties

Visibility Name Flag Summary
public $amount Сумма возврата
public $cancellation_details Комментарий к статусу canceled
public $cancellationDetails Комментарий к статусу canceled
public $created_at Время создания возврата
public $createdAt Время создания возврата
public $deal Данные о сделке, в составе которой проходит возврат
public $description Комментарий, основание для возврата средств покупателю
public $id Идентификатор возврата платежа
public $metadata Метаданные возврата указанные мерчантом
public $payment_id Идентификатор платежа
public $paymentId Идентификатор платежа
public $receipt_registration Статус регистрации чека
public $receiptRegistration Статус регистрации чека
public $refund_authorization_details Данные об авторизации возврата. Присутствуют только для возвратов платежей, совершенных этими способами оплаты: банковская карта, Mir Pay
public $refund_method Детали возврата. Зависят от способа оплаты, который использовался при проведении платежа
public $refundAuthorizationDetails Данные об авторизации возврата. Присутствуют только для возвратов платежей, совершенных этими способами оплаты: банковская карта, Mir Pay
public $refundMethod Детали возврата. Зависят от способа оплаты, который использовался при проведении платежа
public $sources Данные о том, с какого магазина и какую сумму нужно удержать для проведения возврата
public $status Статус возврата
protected $_amount
protected $_cancellation_details
protected $_created_at
protected $_deal
protected $_description
protected $_id
protected $_metadata
protected $_payment_id
protected $_receipt_registration
protected $_refund_authorization_details
protected $_refund_method
protected $_sources
protected $_status

Methods

Visibility Name Flag Summary
public __construct() AbstractObject constructor.
public __get() Возвращает значение свойства.
public __isset() Проверяет наличие свойства.
public __set() Устанавливает значение свойства.
public __unset() Удаляет свойство.
public fromArray() Устанавливает значения свойств текущего объекта из массива.
public getAmount() Возвращает сумму возврата.
public getCancellationDetails() Возвращает cancellation_details.
public getCreatedAt() Возвращает дату создания возврата.
public getDeal() Возвращает данные о сделке, в составе которой проходит возврат
public getDescription() Возвращает комментарий к возврату.
public getId() Возвращает идентификатор возврата платежа.
public getMetadata() Возвращает метаданные возврата.
public getPaymentId() Возвращает идентификатор платежа.
public getReceiptRegistration() Возвращает статус регистрации чека.
public getRefundAuthorizationDetails() Возвращает refund_authorization_details.
public getRefundMethod() Возвращает метод возврата.
public getSources() Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести.
public getStatus() Возвращает статус текущего возврата.
public getValidator()
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public setAmount() Устанавливает сумму возврата.
public setCancellationDetails() Устанавливает cancellation_details.
public setCreatedAt() Устанавливает время создания возврата.
public setDeal() Устанавливает данные о сделке, в составе которой проходит возврат.
public setDescription() Устанавливает комментарий к возврату.
public setId() Устанавливает идентификатор возврата.
public setMetadata() Устанавливает метаданные возврата.
public setPaymentId() Устанавливает идентификатор платежа.
public setReceiptRegistration() Устанавливает статус регистрации чека.
public setRefundAuthorizationDetails() Устанавливает refund_authorization_details.
public setRefundMethod() Устанавливает метод возврата.
public setSources() Устанавливает sources (массив распределения денег между магазинами).
public setStatus() Устанавливает статус возврата платежа.
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected validatePropertyValue()

Details

Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Constants

MAX_LENGTH_DESCRIPTION

Inherited from \YooKassa\Model\Refund\Refund

Максимальная длина строки описания возврата

MAX_LENGTH_DESCRIPTION = 250

Properties

public $amount : \YooKassa\Model\AmountInterface

Description

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

Type: AmountInterface

Details:

public $cancellation_details : \YooKassa\Model\Refund\RefundCancellationDetails

Description

Комментарий к статусу canceled

Type: RefundCancellationDetails

Details:

public $cancellationDetails : \YooKassa\Model\Refund\RefundCancellationDetails

Description

Комментарий к статусу canceled

Type: RefundCancellationDetails

Details:

public $created_at : \DateTime

Description

Время создания возврата

Type: \DateTime

Details:

public $createdAt : \DateTime

Description

Время создания возврата

Type: \DateTime

Details:

public $deal : \YooKassa\Model\Deal\RefundDealInfo

Description

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

Type: RefundDealInfo

Details:

public $description : string

Description

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

Type: string

Details:

public $id : 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_registration : string

Description

Статус регистрации чека

Type: string

Details:

public $receiptRegistration : string

Description

Статус регистрации чека

Type: string

Details:

public $refund_authorization_details : \YooKassa\Model\Refund\RefundAuthorizationDetails|null

Description

Данные об авторизации возврата. Присутствуют только для возвратов платежей, совершенных этими способами оплаты: банковская карта, Mir Pay

Type: RefundAuthorizationDetails|null

Details:

public $refund_method : \YooKassa\Model\Refund\RefundMethod\AbstractRefundMethod|null

Description

Детали возврата. Зависят от способа оплаты, который использовался при проведении платежа

Type: AbstractRefundMethod|null

Details:

public $refundAuthorizationDetails : \YooKassa\Model\Refund\RefundAuthorizationDetails|null

Description

Данные об авторизации возврата. Присутствуют только для возвратов платежей, совершенных этими способами оплаты: банковская карта, Mir Pay

Type: RefundAuthorizationDetails|null

Details:

public $refundMethod : \YooKassa\Model\Refund\RefundMethod\AbstractRefundMethod|null

Description

Детали возврата. Зависят от способа оплаты, который использовался при проведении платежа

Type: AbstractRefundMethod|null

Details:

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

Description

Данные о том, с какого магазина и какую сумму нужно удержать для проведения возврата

Type: SourceInterface[]

Details:

public $status : string

Description

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

Type: string

Details:

protected $_amount : ?\YooKassa\Model\AmountInterface

Type: AmountInterface Сумма возврата Details:

protected $_cancellation_details : ?\YooKassa\Model\CancellationDetailsInterface

Type: CancellationDetailsInterface Комментарий к статусу canceled Details:

protected $_created_at : ?\DateTime

Type: DateTime Время создания возврата Details:

protected $_deal : ?\YooKassa\Model\Deal\RefundDealInfo

Type: RefundDealInfo Данные о сделке, в составе которой проходит возврат Details:

protected $_description : ?string

Type: ?string Комментарий, основание для возврата средств покупателю Details:

protected $_id : ?string

Type: ?string Идентификатор возврата платежа Details:

protected $_metadata : ?\YooKassa\Model\Metadata

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

protected $_payment_id : ?string

Type: ?string Идентификатор платежа Details:

protected $_receipt_registration : ?string

Type: ?string Статус регистрации чека Details:

protected $_refund_authorization_details : ?\YooKassa\Model\Refund\RefundAuthorizationDetails

Type: RefundAuthorizationDetails Данные об авторизации возврата Details:

protected $_refund_method : ?\YooKassa\Model\Refund\RefundMethod\AbstractRefundMethod

Type: AbstractRefundMethod Детали возврата. Зависят от способа оплаты, который использовался при проведении платежа. Details:

protected $_sources : ?\YooKassa\Common\ListObject

Type: ListObject Данные о распределении денег — сколько и в какой магазин нужно перевести Details:

protected $_status : ?string

Type: ?string Статус возврата 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 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 getCancellationDetails() : \YooKassa\Model\CancellationDetailsInterface|null

public getCancellationDetails() : \YooKassa\Model\CancellationDetailsInterface|null

Summary

Возвращает cancellation_details.

Details:

Returns: \YooKassa\Model\CancellationDetailsInterface|null -

public getCreatedAt() : \DateTime|null

public getCreatedAt() : \DateTime|null

Summary

Возвращает дату создания возврата.

Details:

Returns: \DateTime|null - Время создания возврата

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

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

Summary

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

Details:

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

public getDescription() : string|null

public getDescription() : string|null

Summary

Возвращает комментарий к возврату.

Details:

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

public getId() : string|null

public getId() : 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 getReceiptRegistration() : string|null

public getReceiptRegistration() : string|null

Summary

Возвращает статус регистрации чека.

Details:

Returns: string|null - Статус регистрации чека

public getRefundAuthorizationDetails() : \YooKassa\Model\Refund\RefundAuthorizationDetails|null

public getRefundAuthorizationDetails() : \YooKassa\Model\Refund\RefundAuthorizationDetails|null

Summary

Возвращает refund_authorization_details.

Details:

Returns: \YooKassa\Model\Refund\RefundAuthorizationDetails|null -

public getRefundMethod() : \YooKassa\Model\Refund\RefundMethod\AbstractRefundMethod|null

public getRefundMethod() : \YooKassa\Model\Refund\RefundMethod\AbstractRefundMethod|null

Summary

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

Details:

Returns: \YooKassa\Model\Refund\RefundMethod\AbstractRefundMethod|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 getStatus() : string|null

public getStatus() : string|null

Summary

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

Details:

Returns: string|null - Статус возврата

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

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 setAmount() : self

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

Summary

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

Details:

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

Returns: self -

public setCancellationDetails() : self

public setCancellationDetails(\YooKassa\Model\CancellationDetailsInterface|array|null $cancellation_details = null) : self

Summary

Устанавливает cancellation_details.

Details:

Parameters:
Type Name Description
\YooKassa\Model\CancellationDetailsInterface OR array OR null cancellation_details

Returns: self -

public setCreatedAt() : self

public setCreatedAt(\DateTime|string|null $created_at = null) : self

Summary

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

Details:

Parameters:
Type Name Description
\DateTime OR string OR null created_at Время создания возврата

Returns: self -

public setDeal() : self

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\Deal\RefundDealInfo OR array OR null 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 setId() : self

public setId(string|null $id = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null id Идентификатор возврата

Returns: self -

public setMetadata() : self

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\Metadata 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 setReceiptRegistration() : self

public setReceiptRegistration(string|null $receipt_registration = null) : self

Summary

Устанавливает статус регистрации чека.

Details:

Parameters:
Type Name Description
string OR null receipt_registration Статус регистрации чека

Returns: self -

public setRefundAuthorizationDetails() : self

public setRefundAuthorizationDetails(\YooKassa\Model\Refund\RefundAuthorizationDetails|array|null $refund_authorization_details = null) : self

Summary

Устанавливает refund_authorization_details.

Details:

Parameters:
Type Name Description
\YooKassa\Model\Refund\RefundAuthorizationDetails OR array OR null refund_authorization_details Данные об авторизации возврата

Returns: self -

public setRefundMethod() : self

public setRefundMethod(\YooKassa\Model\Refund\RefundMethod\AbstractRefundMethod|array|null $refund_method = null) : self

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\Refund\RefundMethod\AbstractRefundMethod OR array OR null refund_method

Returns: self -

public setSources() : self

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Common\ListObjectInterface OR array OR null sources

Returns: self -

public setStatus() : self

public setStatus(string|null $status = null) : self

Summary

Устанавливает статус возврата платежа.

Details:

Parameters:
Type Name Description
string OR null status Статус возврата платежа

Returns: self -

public toArray() : array

public toArray() : array

Summary

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

Details:

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

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

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

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

Reference in New Issue View Git Blame Copy Permalink