geckon01/yookassa-sdk-php
1
0
Fork 0
mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-08-17 18:01:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
yookassa-sdk-php/docs/classes/YooKassa-Request-Payments-CreateCaptureRequest.md
T
Евгений Ю. Лозный 260d13f890 Добавлен прием платежей через Alfa Pay. Добавлен новый тип ошибки RuleViolationError 
Добавлены нулевые привязки по СБП
Добавлена причина отмены возвратов `payment_expired`
2026-06-29 17:46:40 +03:00

34 KiB
Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Request\Payments\CreateCaptureRequest

Namespace: \YooKassa\Request\Payments

Summary:

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

Description:

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

Constants

  • No constants found

Properties

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

Details

Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Properties

public $airline : \YooKassa\Request\Payments\AirlineInterface|null

Description

Объект с данными для продажи авиабилетов

Type: AirlineInterface|null

Details:

public $amount : \YooKassa\Model\AmountInterface

Description

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

Type: AmountInterface

Details:

public $amount : \YooKassa\Model\AmountInterface

Description

Сумма

Type: AmountInterface

Details:

public $deal : \YooKassa\Model\Deal\CaptureDealData

Description

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

Type: CaptureDealData

Details:

public $receipt : \YooKassa\Model\Receipt\ReceiptInterface

Description

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

Type: ReceiptInterface

Details:

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

Description

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

Type: ReceiptInterface|null

Details:

public $transfers : \YooKassa\Common\ListObjectInterface|\YooKassa\Request\Payments\TransferDataInterface[]|null

Description

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

Type: TransferDataInterface[]|null

Details:

protected $_airline : ?\YooKassa\Request\Payments\AirlineInterface

Type: AirlineInterface Объект с данными для продажи авиабилетов Details:

protected $_amount : ?\YooKassa\Model\AmountInterface

Type: AmountInterface Сумма оплаты Details:

protected $_receipt : ?\YooKassa\Model\Receipt\ReceiptInterface

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

protected $_transfers : ?\YooKassa\Common\ListObject

Type: ListObject

Details:

Methods

public __construct() : mixed

public __construct(array|null $data = []) : mixed

Summary

AbstractObject constructor.

Details:

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

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

Summary

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

Details:

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

Returns: void -

public __unset() : void

public __unset(string $propertyName) : void

Summary

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

Details:

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

Returns: void -

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

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

Summary

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

Details:

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

public clearValidationError() : void

public clearValidationError() : void

Summary

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

Details:

Returns: void -

public fromArray() : void

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

Summary

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

Details:

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

Returns: void -

public getAirline() : null|\YooKassa\Request\Payments\AirlineInterface

public getAirline() : null|\YooKassa\Request\Payments\AirlineInterface

Summary

Возвращает данные авиабилетов.

Details:

Returns: null|\YooKassa\Request\Payments\AirlineInterface - Данные авиабилетов

public getAmount() : \YooKassa\Model\AmountInterface|null

public getAmount() : \YooKassa\Model\AmountInterface|null

Summary

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

Details:

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

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

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

Summary

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

Details:

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

public getLastValidationError() : string|null

public getLastValidationError() : string|null

Summary

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

Details:

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

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

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

Summary

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

Details:

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

public getTransfers() : \YooKassa\Request\Payments\TransferDataInterface[]|\YooKassa\Common\ListObjectInterface

public getTransfers() : \YooKassa\Request\Payments\TransferDataInterface[]|\YooKassa\Common\ListObjectInterface

Summary

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

Description

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

Details:

Returns: \YooKassa\Request\Payments\TransferDataInterface[]|\YooKassa\Common\ListObjectInterface - Данные о распределении денег

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

public hasAirline() : bool

public hasAirline() : bool

Summary

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

Details:

Returns: bool -

public hasAmount() : bool

public hasAmount() : bool

Summary

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

Details:

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

public hasDeal() : bool

public hasDeal() : bool

Summary

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

Details:

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

public hasReceipt() : bool

public hasReceipt() : bool

Summary

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

Details:

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

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() : void

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

Summary

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

Details:

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

Returns: void -

public offsetUnset() : void

public offsetUnset(string $offset) : void

Summary

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

Details:

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

Returns: void -

public removeReceipt() : self

public removeReceipt() : self

Summary

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

Details:

Returns: self -

public setAirline() : \YooKassa\Common\AbstractRequestInterface

public setAirline(\YooKassa\Request\Payments\AirlineInterface|array|null $airline) : \YooKassa\Common\AbstractRequestInterface

Summary

Устанавливает данные авиабилетов.

Details:

Parameters:
Type Name Description
\YooKassa\Request\Payments\AirlineInterface OR array OR null airline Данные авиабилетов

Returns: \YooKassa\Common\AbstractRequestInterface -

public setAmount() : self

public setAmount(\YooKassa\Model\AmountInterface|array|string $amount = null) : self

Summary

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

Details:

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

Returns: self -

public setDeal() : self

public setDeal(null|array|\YooKassa\Model\Deal\CaptureDealData $deal) : self

Summary

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

Details:

Parameters:
Type Name Description
null OR array OR \YooKassa\Model\Deal\CaptureDealData deal Данные о сделке, в составе которой проходит платеж
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданные данные не удалось интерпретировать как метаданные платежа

Returns: self -

public setReceipt() : self

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

Summary

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

Details:

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

Returns: self -

public setTransfers() : self

public setTransfers(\YooKassa\Common\ListObjectInterface|array|null $transfers = null) : self

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Common\ListObjectInterface OR array OR null transfers Массив распределения денег

Returns: self -

public toArray() : array

public toArray() : array

Summary

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

Details:

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

public validate() : bool

public validate() : bool

Summary

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

Details:

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

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

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

protected setValidationError() : void

protected setValidationError(string $value) : void

Summary

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

Details:

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

Returns: void -

protected validatePropertyValue() : mixed

protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed

Details:

Parameters:
Type Name Description
string propertyName
mixed propertyValue

Returns: mixed -

Top Namespaces

Reports

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

© 2026 YooMoney

Reference in New Issue View Git Blame Copy Permalink