# [YooKassa API SDK](../home.md) # Class: \YooKassa\Request\Payments\Payment\CreateCaptureRequest ### Namespace: [\YooKassa\Request\Payments\Payment](../namespaces/yookassa-request-payments-payment.md) --- **Summary:** Класс объекта запроса к API на подтверждение оплаты --- ### Constants * No constants found --- ### Properties | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | | public | [$amount](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md#property_amount) | | Подтверждаемая сумма оплаты | | public | [$amount](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_amount) | | Сумма | | public | [$deal](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md#property_deal) | | Данные о сделке, в составе которой проходит платеж | | public | [$receipt](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md#property_receipt) | | Данные фискального чека 54-ФЗ | | public | [$receipt](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_receipt) | | Данные фискального чека 54-ФЗ | | public | [$transfers](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_transfers) | | Данные о распределении платежа между магазинами | --- ### Methods | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | | public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | | public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | | public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | | public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | | public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | | public | [builder()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md#method_builder) | | Возвращает билдер объектов запросов на подтверждение оплаты | | public | [clearValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_clearValidationError) | | Очищает статус валидации текущего запроса | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | | public | [getAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_getAmount) | | Возвращает сумму оплаты | | public | [getDeal()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md#method_getDeal) | | Возвращает данные о сделке, в составе которой проходит платеж | | public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации | | public | [getReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_getReceipt) | | Возвращает чек, если он есть | | public | [getTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_getTransfers) | | Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести. | | public | [hasAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasAmount) | | Проверяет, была ли установлена сумма оплаты | | public | [hasDeal()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md#method_hasDeal) | | Проверяет, были ли установлены данные о сделке | | public | [hasReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasReceipt) | | Проверяет наличие чека | | public | [hasTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasTransfers) | | Проверяет наличие данных о распределении денег | | public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | | | public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | | | public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | | | public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | | | public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | | | public | [removeReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_removeReceipt) | | Удаляет чек из запроса | | public | [setAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setAmount) | | Устанавливает сумму оплаты | | public | [setDeal()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md#method_setDeal) | | Устанавливает данные о сделке, в составе которой проходит платеж. | | public | [setReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setReceipt) | | Устанавливает чек | | public | [setTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setTransfers) | | Устанавливает transfers (массив распределения денег между магазинами) | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | | public | [validate()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md#method_validate) | | Валидирует объект запроса | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | | protected | [setValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_setValidationError) | | Устанавливает ошибку валидации | --- ### Details * File: [lib/Request/Payments/Payment/CreateCaptureRequest.php](../../lib/Request/Payments/Payment/CreateCaptureRequest.php) * Package: YooKassa * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) * [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) * \YooKassa\Request\Payments\Payment\CreateCaptureRequest * Implements: * [\YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md) --- ## Properties #### public $amount : \YooKassa\Model\AmountInterface --- ***Description*** Подтверждаемая сумма оплаты **Type:** AmountInterface **Details:** #### public $amount : \YooKassa\Model\AmountInterface --- ***Description*** Сумма **Type:** AmountInterface **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) #### public $deal : \YooKassa\Model\Deal\CaptureDealData --- ***Description*** Данные о сделке, в составе которой проходит платеж **Type:** CaptureDealData **Details:** #### public $receipt : \YooKassa\Model\ReceiptInterface --- ***Description*** Данные фискального чека 54-ФЗ **Type:** ReceiptInterface **Details:** #### public $receipt : \YooKassa\Model\ReceiptInterface --- ***Description*** Данные фискального чека 54-ФЗ **Type:** ReceiptInterface **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) #### public $transfers : \YooKassa\Model\TransferInterface[] --- ***Description*** Данные о распределении платежа между магазинами **Type:** TransferInterface[] **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) --- ## Methods #### public __construct() : mixed ```php public __construct(array $data = array()) : mixed ``` **Summary** AbstractObject constructor. **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | array | data | | **Returns:** mixed - #### public __get() : mixed ```php public __get(string $propertyName) : mixed ``` **Summary** Возвращает значение свойства **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string | propertyName | Имя свойства | **Returns:** mixed - Значение свойства #### public __isset() : bool ```php public __isset(string $propertyName) : bool ``` **Summary** Проверяет наличие свойства **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string | propertyName | Имя проверяемого свойства | **Returns:** bool - True если свойство имеется, false если нет #### public __set() : mixed ```php public __set(string $propertyName, mixed $value) : mixed ``` **Summary** Устанавливает значение свойства **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string | propertyName | Имя свойства | | mixed | value | Значение свойства | **Returns:** mixed - #### public __unset() : mixed ```php public __unset(string $propertyName) : mixed ``` **Summary** Удаляет свойство **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string | propertyName | Имя удаляемого свойства | **Returns:** mixed - #### public builder() : \YooKassa\Request\Payments\Payment\CreateCaptureRequestBuilder ```php Static public builder() : \YooKassa\Request\Payments\Payment\CreateCaptureRequestBuilder ``` **Summary** Возвращает билдер объектов запросов на подтверждение оплаты **Details:** * Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequest](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md) **Returns:** \YooKassa\Request\Payments\Payment\CreateCaptureRequestBuilder - Инстанс билдера #### public clearValidationError() : mixed ```php public clearValidationError() : mixed ``` **Summary** Очищает статус валидации текущего запроса **Details:** * Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) **Returns:** mixed - #### public fromArray() : mixed ```php public fromArray(array|\Traversable $sourceArray) : mixed ``` **Summary** Устанавливает значения свойств текущего объекта из массива **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | array OR \Traversable | sourceArray | Ассоциативный массив с настройками | **Returns:** mixed - #### public getAmount() : \YooKassa\Model\AmountInterface ```php public getAmount() : \YooKassa\Model\AmountInterface ``` **Summary** Возвращает сумму оплаты **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) **Returns:** \YooKassa\Model\AmountInterface - Сумма оплаты #### public getDeal() : \YooKassa\Model\Deal\CaptureDealData ```php public getDeal() : \YooKassa\Model\Deal\CaptureDealData ``` **Summary** Возвращает данные о сделке, в составе которой проходит платеж **Details:** * Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequest](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md) **Returns:** \YooKassa\Model\Deal\CaptureDealData - Данные о сделке, в составе которой проходит платеж #### public getLastValidationError() : string ```php public getLastValidationError() : string ``` **Summary** Возвращает последнюю ошибку валидации **Details:** * Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) **Returns:** string - Последняя произошедшая ошибка валидации #### public getReceipt() : \YooKassa\Model\ReceiptInterface|null ```php public getReceipt() : \YooKassa\Model\ReceiptInterface|null ``` **Summary** Возвращает чек, если он есть **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) **Returns:** \YooKassa\Model\ReceiptInterface|null - Данные фискального чека 54-ФЗ или null, если чека нет #### public getTransfers() : \YooKassa\Model\TransferInterface[] ```php public getTransfers() : \YooKassa\Model\TransferInterface[] ``` **Summary** Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести. **Description** Присутствует, если вы используете решение ЮKassa для платформ. (https://yookassa.ru/developers/special-solutions/checkout-for-platforms/basics) **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) **Returns:** \YooKassa\Model\TransferInterface[] - Данные о распределении денег #### public hasAmount() : bool ```php public hasAmount() : bool ``` **Summary** Проверяет, была ли установлена сумма оплаты **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) **Returns:** bool - True если сумма оплаты была установлена, false если нет #### public hasDeal() : bool ```php public hasDeal() : bool ``` **Summary** Проверяет, были ли установлены данные о сделке **Details:** * Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequest](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md) **Returns:** bool - True если данные о сделке были установлены, false если нет #### public hasReceipt() : bool ```php public hasReceipt() : bool ``` **Summary** Проверяет наличие чека **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) **Returns:** bool - True если чек есть, false если нет #### public hasTransfers() : bool ```php public hasTransfers() : bool ``` **Summary** Проверяет наличие данных о распределении денег **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) **Returns:** bool - #### public jsonSerialize() : mixed ```php public jsonSerialize() : mixed ``` **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) **Returns:** mixed - #### public offsetExists() : mixed ```php public offsetExists(mixed $offset) : mixed ``` **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | mixed | offset | | **Returns:** mixed - #### public offsetGet() : mixed ```php public offsetGet(mixed $offset) : mixed ``` **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | mixed | offset | | **Returns:** mixed - #### public offsetSet() : mixed ```php public offsetSet(mixed $offset, mixed $value) : mixed ``` **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | mixed | offset | | | mixed | value | | **Returns:** mixed - #### public offsetUnset() : mixed ```php public offsetUnset(mixed $offset) : mixed ``` **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | mixed | offset | | **Returns:** mixed - #### public removeReceipt() : mixed ```php public removeReceipt() : mixed ``` **Summary** Удаляет чек из запроса **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) **Returns:** mixed - #### public setAmount() : mixed ```php public setAmount(\YooKassa\Model\AmountInterface $value) : mixed ``` **Summary** Устанавливает сумму оплаты **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | \YooKassa\Model\AmountInterface | value | Сумма оплаты | **Returns:** mixed - #### public setDeal() : mixed ```php public setDeal(\YooKassa\Model\Deal\CaptureDealData|array|null $value) : mixed ``` **Summary** Устанавливает данные о сделке, в составе которой проходит платеж. **Details:** * Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequest](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | \YooKassa\Model\Deal\CaptureDealData OR array OR null | value | Данные о сделке, в составе которой проходит платеж | ##### Throws: | Type | Description | | ---- | ----------- | | \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданные данные не удалось интерпретировать как метаданные платежа | **Returns:** mixed - #### public setReceipt() : mixed ```php public setReceipt(\YooKassa\Model\ReceiptInterface|null $value) : mixed ``` **Summary** Устанавливает чек **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | \YooKassa\Model\ReceiptInterface OR null | value | Инстанс чека или null для удаления информации о чеке | ##### Throws: | Type | Description | | ---- | ----------- | | \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если передан не инстанс класса чека и не null | **Returns:** mixed - #### public setTransfers() : mixed ```php public setTransfers(\YooKassa\Model\TransferInterface[]|array|null $value) : mixed ``` **Summary** Устанавливает transfers (массив распределения денег между магазинами) **Details:** * Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | \YooKassa\Model\TransferInterface[] OR array OR null | value | | **Returns:** mixed - #### public toArray() : array ```php public toArray() : array ``` **Summary** Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) **Returns:** array - Ассоциативный массив со свойствами текущего объекта #### public validate() : bool ```php public validate() : bool ``` **Summary** Валидирует объект запроса **Details:** * Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequest](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md) **Returns:** bool - True если запрос валиден и его можно отправить в API, false если нет #### protected getUnknownProperties() : array ```php protected getUnknownProperties() : array ``` **Summary** Возвращает массив свойств которые не существуют, но были заданы у объекта **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами #### protected setValidationError() : mixed ```php protected setValidationError(string $value) : mixed ``` **Summary** Устанавливает ошибку валидации **Details:** * Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string | value | Ошибка, произошедшая при валидации объекта | **Returns:** mixed - --- ### Top Namespaces * [\YooKassa](../namespaces/yookassa.md) --- ### Reports * [Errors - 0](../reports/errors.md) * [Markers - 1](../reports/markers.md) * [Deprecated - 25](../reports/deprecated.md) --- This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/) © 2023 YooMoney