yookassa-sdk-php/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md

YooKassa API SDK

Class: \YooKassa\Request\Refunds\CreateRefundRequestBuilder

Namespace: \YooKassa\Request\Refunds

---

Summary:

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

---

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
protected	$amount		Сумма
protected	$currentObject		Собираемый объет запроса к API
protected	$receipt		Объект с информацией о чеке
protected	$transfers		Массив платежей в пользу разных мерчантов

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		Конструктор, инициализирует пустой запрос, который в будущем начнём собирать
public	addReceiptItem()		Добавляет в чек товар
public	addReceiptShipping()		Добавляет в чек доставку товара
public	build()		Строит объект запроса к API
public	setAmount()		Устанавливает сумму
public	setCurrency()		Устанавливает валюту в которой будет происходить подтверждение оплаты заказа
public	setDescription()		Устанавливает комментарий к возврату
public	setOptions()		Устанавливает свойства запроса из массива
public	setPaymentId()		Устанавливает айди платежа для которого создаётся возврат
public	setReceipt()		Устанавливает чек
public	setReceiptEmail()		Устанавливает адрес электронной почты получателя чека
public	setReceiptItems()		Устанавлвиает список товаров для создания чека
public	setReceiptPhone()		Устанавливает телефон получателя чека
public	setSources()		Устанавливает источники возврата
public	setTaxSystemCode()		Устанавливает код системы налогообложения.
public	setTransfers()		Устанавливает трансферы
protected	initCurrentObject()		Возвращает новый объект для сборки

---

Details

• File: lib/Request/Refunds/CreateRefundRequestBuilder.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractRequestBuilder
  • \YooKassa\Common\AbstractPaymentRequestBuilder
  • \YooKassa\Request\Refunds\CreateRefundRequestBuilder

---

Properties

protected $amount : \YooKassa\Model\MonetaryAmount

---

Summary

Сумма

Type: MonetaryAmount

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequestBuilder

protected $currentObject : \YooKassa\Request\Refunds\CreateRefundRequest

---

Summary

Собираемый объет запроса к API

Type: CreateRefundRequest

Details:

protected $receipt : \YooKassa\Model\Receipt

---

Summary

Объект с информацией о чеке

Type: Receipt

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequestBuilder

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

---

Summary

Массив платежей в пользу разных мерчантов

Type: TransferInterface[]

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequestBuilder

---

Methods

public __construct() : mixed

public __construct() : mixed

Summary

Конструктор, инициализирует пустой запрос, который в будущем начнём собирать

Details:

• Inherited From: \YooKassa\Common\AbstractRequestBuilder

Returns: mixed -

public addReceiptItem() : self

public addReceiptItem(string $title, string $price, float $quantity, int $vatCode, null|string $paymentMode = null, null|string $paymentSubject = null) : self

Summary

Добавляет в чек товар

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequestBuilder
• See Also:

Parameters:

Type	Name	Description
string	title	Название или описание товара
string	price	Цена товара в валюте, заданной в заказе
float	quantity	Количество товара
int	vatCode	Ставка НДС
null OR string	paymentMode	значение перечисления PaymentMode
null OR string	paymentSubject	значение перечисления PaymentSubject

Returns: self - Инстанс билдера запросов

public addReceiptShipping() : self

public addReceiptShipping(string $title, string $price, int $vatCode, null|string $paymentMode = null, null|string $paymentSubject = null) : self

Summary

Добавляет в чек доставку товара

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequestBuilder
• See Also:

Parameters:

Type	Name	Description
string	title	Название доставки в чеке
string	price	Стоимость доставки
int	vatCode	Ставка НДС
null OR string	paymentMode	значение перечисления PaymentMode
null OR string	paymentSubject	значение перечисления PaymentSubject

Returns: self - Инстанс билдера запросов

public build() : \YooKassa\Request\Refunds\CreateRefundRequestInterface|\YooKassa\Common\AbstractRequest

public build(array|null $options = null) : \YooKassa\Request\Refunds\CreateRefundRequestInterface|\YooKassa\Common\AbstractRequest

Summary

Строит объект запроса к API

Details:

• Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestBuilder

Parameters:

Type	Name	Description
array OR null	options	Устаналвиваемые параметры запроса

Returns: \YooKassa\Request\Refunds\CreateRefundRequestInterface|\YooKassa\Common\AbstractRequest - Инстанс сгенерированного объекта запроса к API

public setAmount() : self

public setAmount(\YooKassa\Model\AmountInterface|array|string $value) : self

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
\YooKassa\Model\AmountInterface OR array OR string	value	Сумма оплаты

Returns: self - Инстанс билдера запросов

public setCurrency() : self

public setCurrency(string $value) : self

Summary

Устанавливает валюту в которой будет происходить подтверждение оплаты заказа

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
string	value	Валюта в которой подтверждается оплата

Returns: self - Инстанс билдера запросов

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

public setDescription(string $value) : \YooKassa\Request\Refunds\CreateRefundRequestBuilder

Summary

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

Details:

• Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestBuilder

Parameters:

Type	Name	Description
string	value	Комментарий к возврату

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если была передана не строка

Returns: \YooKassa\Request\Refunds\CreateRefundRequestBuilder - Инстанс текущего билдера

public setOptions() : \YooKassa\Common\AbstractRequestBuilder

public setOptions(array|\Traversable $options) : \YooKassa\Common\AbstractRequestBuilder

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequestBuilder

Parameters:

Type	Name	Description
array OR \Traversable	options	Массив свойств запроса

Throws:

Type	Description
\InvalidArgumentException	Выбрасывается если аргумент не массив и не итерируемый объект
\YooKassa\Common\Exceptions\InvalidPropertyException	Выбрасывается если не удалось установить один из параметров, переданныч в массиве настроек

Returns: \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов

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

public setPaymentId(string $value) : \YooKassa\Request\Refunds\CreateRefundRequestBuilder

Summary

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

Details:

• Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestBuilder

Parameters:

Type	Name	Description
string	value	Айди платежа

Throws:

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

Returns: \YooKassa\Request\Refunds\CreateRefundRequestBuilder - Инстанс текущего билдера

public setReceipt() : self

public setReceipt(\YooKassa\Model\ReceiptInterface|array $value) : self

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
\YooKassa\Model\ReceiptInterface OR array	value	Инстанс чека или ассоциативный массив с данными чека

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Генерируется если было передано значение невалидного типа

Returns: self -

public setReceiptEmail() : self

public setReceiptEmail(string $value) : self

Summary

Устанавливает адрес электронной почты получателя чека

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
string	value	Email получателя чека

Returns: self - Инстанс билдера запросов

public setReceiptItems() : self

public setReceiptItems(array $value) : self

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
array	value	Массив товаров в заказе

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если хотя бы один из товаров имеет неверную структуру

Returns: self - Инстанс билдера запросов

public setReceiptPhone() : self

public setReceiptPhone(string $value) : self

Summary

Устанавливает телефон получателя чека

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
string	value	Телефон получателя чека

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если в качестве значения была передана не строка

Returns: self - Инстанс билдера запросов

public setSources() : self

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestBuilder

Parameters:

Type	Name	Description
\YooKassa\Model\SourceInterface[] OR array	value	Массив трансферов

Returns: self - Инстанс билдера запросов

public setTaxSystemCode() : self

public setTaxSystemCode(int $value) : self

Summary

Устанавливает код системы налогообложения.

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
int	value	Код системы налогообложения. Число 1-6.

Returns: self - Инстанс билдера запросов

public setTransfers() : self

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

Summary

Устанавливает трансферы

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
\YooKassa\Model\TransferInterface[] OR array OR null	value	Массив трансферов

Returns: self - Инстанс билдера запросов

protected initCurrentObject() : \YooKassa\Request\Refunds\CreateRefundRequest

protected initCurrentObject() : \YooKassa\Request\Refunds\CreateRefundRequest

Summary

Возвращает новый объект для сборки

Details:

• Inherited From: \YooKassa\Request\Refunds\CreateRefundRequestBuilder

Returns: \YooKassa\Request\Refunds\CreateRefundRequest - Собираемый объет запроса к API

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 0
• Deprecated - 7

---

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

© 2021 YooMoney