meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md

YooKassa API SDK

Class: \YooKassa\Request\Payments\Payment\CreateCaptureRequest

Namespace: \YooKassa\Request\Payments\Payment

---

Summary:

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

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
public	$amount		Подтверждаемая сумма оплаты
public	$amount		Сумма
public	$deal		Данные о сделке, в составе которой проходит платеж
public	$receipt		Данные фискального чека 54-ФЗ
public	$receipt		Данные фискального чека 54-ФЗ
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	getDeal()		Возвращает данные о сделке, в составе которой проходит платеж
public	getLastValidationError()		Возвращает последнюю ошибку валидации
public	getReceipt()		Возвращает чек, если он есть
public	getTransfers()		Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести.
public	hasAmount()		Проверяет, была ли установлена сумма оплаты
public	hasDeal()		Проверяет, были ли установлены данные о сделке
public	hasReceipt()		Проверяет наличие чека
public	hasTransfers()		Проверяет наличие данных о распределении денег
public	jsonSerialize()
public	offsetExists()
public	offsetGet()
public	offsetSet()
public	offsetUnset()
public	removeReceipt()		Удаляет чек из запроса
public	setAmount()		Устанавливает сумму оплаты
public	setDeal()		Устанавливает данные о сделке, в составе которой проходит платеж.
public	setReceipt()		Устанавливает чек
public	setTransfers()		Устанавливает transfers (массив распределения денег между магазинами)
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
public	validate()		Валидирует объект запроса
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта
protected	setValidationError()		Устанавливает ошибку валидации

---

Details

• File: lib/Request/Payments/Payment/CreateCaptureRequest.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Common\AbstractRequest
  • \YooKassa\Common\AbstractPaymentRequest
  • \YooKassa\Request\Payments\Payment\CreateCaptureRequest
• Implements:
  • \YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface

---

Properties

public $amount : \YooKassa\Model\AmountInterface

---

Description

Подтверждаемая сумма оплаты

Type: AmountInterface

Details:

public $amount : \YooKassa\Model\AmountInterface

---

Description

Сумма

Type: AmountInterface

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

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

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

---

Description

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

Type: TransferInterface[]

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

---

Methods

public __construct() : mixed

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

Summary

AbstractObject constructor.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array	data

Returns: mixed -

public __get() : mixed

public __get(string $propertyName) : mixed

Summary

Возвращает значение свойства

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя свойства

Returns: mixed - Значение свойства

public __isset() : bool

public __isset(string $propertyName) : bool

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public __set() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public __unset() : mixed

public __unset(string $propertyName) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public builder() : \YooKassa\Request\Payments\Payment\CreateCaptureRequestBuilder

Static public builder() : \YooKassa\Request\Payments\Payment\CreateCaptureRequestBuilder

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\Payment\CreateCaptureRequest

Returns: \YooKassa\Request\Payments\Payment\CreateCaptureRequestBuilder - Инстанс билдера

public clearValidationError() : mixed

public clearValidationError() : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Returns: mixed -

public fromArray() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public getAmount() : \YooKassa\Model\AmountInterface

public getAmount() : \YooKassa\Model\AmountInterface

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

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

public getDeal() : \YooKassa\Model\Deal\CaptureDealData

public getDeal() : \YooKassa\Model\Deal\CaptureDealData

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\Payment\CreateCaptureRequest

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

public getLastValidationError() : string

public getLastValidationError() : string

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

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

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

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

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

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

Summary

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

Description

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

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

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

public hasAmount() : bool

public hasAmount() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

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

public hasDeal() : bool

public hasDeal() : bool

Summary

Проверяет, были ли установлены данные о сделке

Details:

• Inherited From: \YooKassa\Request\Payments\Payment\CreateCaptureRequest

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

public hasReceipt() : bool

public hasReceipt() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

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

public hasTransfers() : bool

public hasTransfers() : bool

Summary

Проверяет наличие данных о распределении денег

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

Returns: bool -

public jsonSerialize() : mixed

public jsonSerialize() : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: mixed -

public offsetExists() : mixed

public offsetExists(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetGet() : mixed

public offsetGet(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetSet() : mixed

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset
mixed	value

Returns: mixed -

public offsetUnset() : mixed

public offsetUnset(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public removeReceipt() : mixed

public removeReceipt() : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

Returns: mixed -

public setAmount() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

Parameters:

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

Returns: mixed -

public setDeal() : mixed

public setDeal(\YooKassa\Model\Deal\CaptureDealData|array|null $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\Payment\CreateCaptureRequest

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

Parameters:

Type	Name	Description
\YooKassa\Model\ReceiptInterface OR null	value	Инстанс чека или null для удаления информации о чеке

Throws:

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

Returns: mixed -

public setTransfers() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

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:

• Inherited From: \YooKassa\Common\AbstractObject

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

public validate() : bool

public validate() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\Payment\CreateCaptureRequest

Returns: bool - True если запрос валиден и его можно отправить в API, false если нет

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

protected setValidationError() : mixed

protected setValidationError(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Parameters:

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

Returns: mixed -

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 1
• Deprecated - 25

---

This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor

© 2023 YooMoney