yookassa-sdk-php/docs/classes/YooKassa-Request-Payments-CreateCaptureRequestBuilder.md

YooKassa API SDK

Class: \YooKassa\Request\Payments\CreateCaptureRequestBuilder

Namespace: \YooKassa\Request\Payments

---

Summary:

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

Description:

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

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
protected	$amount		Сумма
protected	$currentObject		Собираемый объект запроса.
protected	$receipt		Объект с информацией о чеке

---

Methods

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

---

Details

• File: lib/Request/Payments/CreateCaptureRequestBuilder.php

• Package: YooKassa\Request

• Class Hierarchy:

  • \YooKassa\Common\AbstractRequestBuilder
  • \YooKassa\Request\Payments\AbstractPaymentRequestBuilder
  • \YooKassa\Request\Payments\CreateCaptureRequestBuilder

• See Also:

---

Tags

Tag	Version	Description
category		Class
author		cms@yoomoney.ru

---

Properties

protected $amount : ?\YooKassa\Model\MonetaryAmount

---

Summary

Сумма

Type: MonetaryAmount

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

protected $currentObject : ?\YooKassa\Common\AbstractRequestInterface

---

Summary

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

Type: AbstractRequestInterface

Details:

protected $receipt : ?\YooKassa\Model\Receipt\Receipt

---

Summary

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

Type: Receipt

Details:

• Inherited From: \YooKassa\Request\Payments\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, null|mixed $productCode = null, null|mixed $countryOfOriginCode = null, null|mixed $customsDeclarationNumber = null, null|mixed $excise = null) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\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
null OR mixed	productCode
null OR mixed	countryOfOriginCode
null OR mixed	customsDeclarationNumber
null OR mixed	excise

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\Request\Payments\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 addTransfer() : self

public addTransfer(array|\YooKassa\Request\Payments\TransferDataInterface $value) : self

Summary

Добавляет трансфер.

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
array OR \YooKassa\Request\Payments\TransferDataInterface	value	Трансфер

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

public build() : \YooKassa\Request\Payments\CreateCaptureRequest|\YooKassa\Common\AbstractRequestInterface

public build(null|array $options = null) : \YooKassa\Request\Payments\CreateCaptureRequest|\YooKassa\Common\AbstractRequestInterface

Summary

Осуществляет сборку объекта запроса к API.

Details:

• Inherited From: \YooKassa\Request\Payments\CreateCaptureRequestBuilder

Parameters:

Type	Name	Description
null OR array	options	Массив дополнительных настроек объекта

Returns: \YooKassa\Request\Payments\CreateCaptureRequest|\YooKassa\Common\AbstractRequestInterface - Инстанс объекта запроса к API

public setAirline() : \YooKassa\Request\Payments\CreateCaptureRequestBuilder

public setAirline(\YooKassa\Request\Payments\AirlineInterface|array|null $value) : \YooKassa\Request\Payments\CreateCaptureRequestBuilder

Summary

Устанавливает информацию об авиабилетах

Details:

• Inherited From: \YooKassa\Request\Payments\CreateCaptureRequestBuilder

Parameters:

Type	Name	Description
\YooKassa\Request\Payments\AirlineInterface OR array OR null	value	Объект данных длинной записи или ассоциативный массив с данными

Returns: \YooKassa\Request\Payments\CreateCaptureRequestBuilder -

public setAmount() : self

public setAmount(\YooKassa\Model\AmountInterface|array|\YooKassa\Request\Payments\numeric $value, string|null $currency = null) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
\YooKassa\Model\AmountInterface OR array OR \YooKassa\Request\Payments\numeric	value	Сумма оплаты
string OR null	currency	Валюта

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

public setCurrency() : self

public setCurrency(string $value) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

Parameters:

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

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

public setDeal() : \YooKassa\Request\Payments\CreateCaptureRequestBuilder

public setDeal(null|array|\YooKassa\Model\Deal\CaptureDealData $value) : \YooKassa\Request\Payments\CreateCaptureRequestBuilder

Summary

Устанавливает сделку.

Details:

• Inherited From: \YooKassa\Request\Payments\CreateCaptureRequestBuilder

Parameters:

Type	Name	Description
null OR array OR \YooKassa\Model\Deal\CaptureDealData	value	Данные о сделке, в составе подтверждения оплаты

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

public setOptions() : \YooKassa\Common\AbstractRequestBuilder

public setOptions(iterable|null $options) : \YooKassa\Common\AbstractRequestBuilder

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequestBuilder

Parameters:

Type	Name	Description
iterable OR null	options	Массив свойств запроса

Throws:

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

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

public setReceipt() : self

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

Parameters:

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

Throws:

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

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

public setReceiptEmail() : self

public setReceiptEmail(string|null $value) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

Parameters:

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

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

public setReceiptItems() : self

public setReceiptItems(array $value = []) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

Parameters:

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

Throws:

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

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

public setReceiptPhone() : self

public setReceiptPhone(string|null $value) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

Parameters:

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

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

public setTaxSystemCode() : self

public setTaxSystemCode(int|null $value) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

Parameters:

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

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

public setTransfers() : self

public setTransfers(array|\YooKassa\Request\Payments\TransferDataInterface[]|\YooKassa\Common\ListObjectInterface $value) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\AbstractPaymentRequestBuilder

Parameters:

Type	Name	Description
array OR \YooKassa\Request\Payments\TransferDataInterface[] OR \YooKassa\Common\ListObjectInterface	value	Массив трансферов

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

protected initCurrentObject() : \YooKassa\Common\AbstractRequestInterface|null

protected initCurrentObject() : \YooKassa\Common\AbstractRequestInterface|null

Summary

Инициализирует пустой запрос

Details:

• Inherited From: \YooKassa\Request\Payments\CreateCaptureRequestBuilder

Returns: \YooKassa\Common\AbstractRequestInterface|null -

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 0
• Deprecated - 43

---

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

© 2026 YooMoney