geckon01/yookassa-sdk-php
1
0
Fork 0
mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-08-26 06:58:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f2bfa60cb6d1d00a15a2b10a6970541ce2a88fbf
yookassa-sdk-php/docs/classes/YooKassa-Request-Refunds-CreateRefundRequest.md
T
Aleksandra Spiridonova 14a37812fc Удаление ConfirmationType::DEEPLINK
2021-09-17 15:46:46 +03:00

34 KiB
Raw Blame History

YooKassa API SDK

Class: \YooKassa\Request\Refunds\CreateRefundRequest

Namespace: \YooKassa\Request\Refunds

Summary:

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

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(array(
                    array(
                        'description' => 'Платок Gucci',
                        'quantity' => '1.00',
                        'amount' => array(
                            'value' => '3000.00',
                            'currency' => 'RUB',
                        ),
                        'vat_code' => 2,
                        'payment_mode' => 'full_payment',
                        'payment_subject' => 'commodity',
                    ),
                ))
                ->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;
}

Constants

  • No constants found

Properties

Visibility Name Flag Summary
public $amount Сумма возврата
public $amount Сумма
public $description Комментарий к операции возврата, основание для возврата средств покупателю.
public $paymentId Айди платежа для которого создаётся возврат
public $receipt Инстанс чека или null
public $receipt Данные фискального чека 54-ФЗ
public $sources Информация о распределении денег — сколько и в какой магазин нужно перевести
public $transfers Данные о распределении платежа между магазинами

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 getDescription() Возвращает комментарий к возврату или null, если комментарий не задан
public getLastValidationError() Возвращает последнюю ошибку валидации
public getPaymentId() Возвращает идентификатор платежа для которого создаётся возврат средств
public getReceipt() Возвращает чек, если он есть
public getSources() Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести
public getTransfers() Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести.
public hasAmount() Проверяет была ли установлена сумма оплаты
public hasDescription() Проверяет задан ли комментарий к создаваемому возврату
public hasReceipt() Проверяет наличие чека
public hasSources() Проверяет наличие информации о распределении денег
public hasTransfers() Проверяет наличие данных о распределении денег
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации
public offsetExists() Проверяет наличие свойства
public offsetGet() Возвращает значение свойства
public offsetSet() Устанавливает значение свойства
public offsetUnset() Удаляет свойство
public removeReceipt() Удаляет чек из запроса
public setAmount() Устанавливает сумму оплаты
public setDescription() Устанавливает комментарий к возврату
public setPaymentId() Устанавливает идентификатор платежа для которого создаётся возврат
public setReceipt() Устанавливает чек
public setSources() Устанавливает sources (массив распределения денег между магазинами)
public setTransfers() Устанавливает transfers (массив распределения денег между магазинами)
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
public validate() Валидирует текущий объект запроса
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта
protected setValidationError() Устанавливает ошибку валидации

Details

Properties

public $amount : \YooKassa\Model\AmountInterface

Description

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

Type: AmountInterface

Details:

public $amount : \YooKassa\Model\AmountInterface

Description

Сумма

Type: AmountInterface

Details:

public $description : string

Description

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

Type: string

Details:

public $paymentId : string

Description

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

Type: string

Details:

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

Description

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

Type: ReceiptInterface|null

Details:

public $receipt : \YooKassa\Model\ReceiptInterface

Description

Данные фискального чека 54-ФЗ

Type: ReceiptInterface

Details:

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

Description

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

Type: SourceInterface[]|null

Details:

public $transfers : \YooKassa\Model\TransferInterface[]

Description

Данные о распределении платежа между магазинами

Type: TransferInterface[]

Details:

Methods

public __construct() : mixed

public __construct(array $data = array()) : mixed

Summary

AbstractObject constructor.

Details:

Parameters:
Type Name Description
array 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() : mixed

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

Summary

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

Details:

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

Returns: mixed -

public __unset() : mixed

public __unset(string $propertyName) : mixed

Summary

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

Details:

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

Returns: mixed -

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

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

Summary

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

Details:

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

public clearValidationError() : mixed

public clearValidationError() : mixed

Summary

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

Details:

Returns: mixed -

public fromArray() : mixed

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

Summary

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

Details:

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

Returns: mixed -

public getAmount() : \YooKassa\Model\AmountInterface

public getAmount() : \YooKassa\Model\AmountInterface

Summary

Возвращает сумму оплаты

Details:

Returns: \YooKassa\Model\AmountInterface - Сумма оплаты

public getDescription() : string

public getDescription() : string

Summary

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

Details:

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

public getLastValidationError() : string

public getLastValidationError() : string

Summary

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

Details:

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

public getPaymentId() : string

public getPaymentId() : string

Summary

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

Details:

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

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

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

Summary

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

Details:

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

public getSources() : \YooKassa\Model\SourceInterface[]

public getSources() : \YooKassa\Model\SourceInterface[]

Summary

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

Details:

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

public getTransfers() : \YooKassa\Model\TransferInterface[]

public getTransfers() : \YooKassa\Model\TransferInterface[]

Summary

Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести.

Description

Присутствует, если вы используете решение ЮKassa для платформ. (https://yookassa.ru/developers/special-solutions/checkout-for-platforms/basics)

Details:

Returns: \YooKassa\Model\TransferInterface[] - Данные о распределении денег

public hasAmount() : bool

public hasAmount() : bool

Summary

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

Details:

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

public hasDescription() : bool

public hasDescription() : bool

Summary

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

Details:

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

public hasReceipt() : bool

public hasReceipt() : bool

Summary

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

Details:

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

public hasSources() : bool

public hasSources() : bool

Summary

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

Details:

Returns: bool -

public hasTransfers() : bool

public hasTransfers() : 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() : mixed

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

Summary

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

Details:

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

Returns: mixed -

public offsetUnset() : mixed

public offsetUnset(string $offset) : mixed

Summary

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

Details:

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

Returns: mixed -

public removeReceipt() : mixed

public removeReceipt() : mixed

Summary

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

Details:

Returns: mixed -

public setAmount() : mixed

public setAmount(\YooKassa\Model\AmountInterface $value) : mixed

Summary

Устанавливает сумму оплаты

Details:

Parameters:
Type Name Description
\YooKassa\Model\AmountInterface value Сумма оплаты

Returns: mixed -

public setDescription() : mixed

public setDescription(string $value) : mixed

Summary

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

Details:

Parameters:
Type Name Description
string value Комментарий к операции возврата, основание для возврата средств покупателю
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если была передана не строка

Returns: mixed -

public setPaymentId() : mixed

public setPaymentId(string $value) : mixed

Summary

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

Details:

Parameters:
Type Name Description
string value Идентификатор платежа
Throws:
Type Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException Выбрасывается если передано пустое значение идентификатора платежа
\YooKassa\Common\Exceptions\InvalidPropertyValueException Выбрасывается если переданное значение является строкой, но не является валидным значением идентификатора платежа
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если передано значение не валидного типа

Returns: mixed -

public setReceipt() : mixed

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\ReceiptInterface OR null value Инстанс чека или null для удаления информации о чеке
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если передан не инстанс класса чека и не null

Returns: mixed -

public setSources() : mixed

public setSources(\YooKassa\Model\SourceInterface[]|array $value) : mixed

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\SourceInterface[] OR array value Массив распределения денег между магазинами

Returns: mixed -

public setTransfers() : mixed

public setTransfers(\YooKassa\Model\TransferInterface[]|array|null $value) : mixed

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\TransferInterface[] OR array OR null value

Returns: mixed -

public toArray() : array

public toArray() : array

Summary

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

Details:

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

public validate() : bool

public validate() : bool

Summary

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

Details:

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

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

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

protected setValidationError() : mixed

protected setValidationError(string $value) : mixed

Summary

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

Details:

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

Returns: mixed -

Top Namespaces

Reports

This document was automatically generated from source code comments on 2021-09-17 using phpDocumentor

© 2021 YooMoney

Reference in New Issue View Git Blame Copy Permalink