Антон Н. Николаев
10 KiB
YooKassa API SDK
Interface: CreateCaptureRequestInterface
Namespace: \YooKassa\Request\Payments
Summary:
Interface CreateCaptureRequestInterface.
Constants
- No constants found
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | getAmount() | Возвращает подтверждаемую сумму оплаты. | |
| public | getDeal() | Возвращает данные о сделке. | |
| public | getReceipt() | Возвращает чек, если он есть. | |
| public | getTransfers() | Возвращает данные о распределении денег. | |
| public | hasAmount() | Проверяет, была ли установлена сумма оплаты. | |
| public | hasDeal() | Проверяет наличие данных о сделке. | |
| public | hasReceipt() | Проверяет наличие чека в создаваемом платеже. | |
| public | hasTransfers() | Проверяет наличие данных о распределении денег. | |
| public | setAmount() | Устанавливает сумму оплаты. | |
| public | setDeal() | Устанавливает данные о сделке. | |
| public | setReceipt() | Устанавливает чек. | |
| public | setTransfers() | Устанавливает transfers (массив распределения денег между магазинами). |
Details
- File: lib/Request/Payments/CreateCaptureRequestInterface.php
- Package: \YooKassa\Request
- See Also:
Tags
| Tag | Version | Description |
|---|---|---|
| category | Class | |
| author | cms@yoomoney.ru | |
| property | Подтверждаемая сумма оплаты | |
| property | Данные фискального чека 54-ФЗ | |
| property | Данные о сделке, в составе которой проходит платеж |
Methods
public getAmount() : \YooKassa\Model\AmountInterface|null
public getAmount() : \YooKassa\Model\AmountInterface|null
Summary
Возвращает подтверждаемую сумму оплаты.
Details:
- Inherited From: \YooKassa\Request\Payments\CreateCaptureRequestInterface
Returns: \YooKassa\Model\AmountInterface|null - Подтверждаемая сумма оплаты
public hasAmount() : bool
public hasAmount() : bool
Summary
Проверяет, была ли установлена сумма оплаты.
Details:
- Inherited From: \YooKassa\Request\Payments\CreateCaptureRequestInterface
Returns: bool - True если сумма оплаты была установлена, false если нет
public setAmount() : mixed
public setAmount(\YooKassa\Model\AmountInterface|array|string $amount) : mixed
Summary
Устанавливает сумму оплаты.
Details:
- Inherited From: \YooKassa\Request\Payments\CreateCaptureRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\AmountInterface OR array OR string |
amount | Сумма оплаты |
Returns: mixed -
public getReceipt() : null|\YooKassa\Model\Receipt\ReceiptInterface
public getReceipt() : null|\YooKassa\Model\Receipt\ReceiptInterface
Summary
Возвращает чек, если он есть.
Details:
- Inherited From: \YooKassa\Request\Payments\CreateCaptureRequestInterface
Returns: null|\YooKassa\Model\Receipt\ReceiptInterface - Данные фискального чека 54-ФЗ или null, если чека нет
public hasReceipt() : bool
public hasReceipt() : bool
Summary
Проверяет наличие чека в создаваемом платеже.
Details:
- Inherited From: \YooKassa\Request\Payments\CreateCaptureRequestInterface
Returns: bool - True если чек есть, false если нет
public setReceipt() : \YooKassa\Common\AbstractRequestInterface
public setReceipt(null|\YooKassa\Model\Receipt\ReceiptInterface $value) : \YooKassa\Common\AbstractRequestInterface
Summary
Устанавливает чек.
Details:
- Inherited From: \YooKassa\Request\Payments\CreateCaptureRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
null OR \YooKassa\Model\Receipt\ReceiptInterface |
value | Инстанс чека или null для удаления информации о чеке |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если передан не инстанс класса чека и не null |
Returns: \YooKassa\Common\AbstractRequestInterface -
public hasTransfers() : bool
public hasTransfers() : bool
Summary
Проверяет наличие данных о распределении денег.
Details:
- Inherited From: \YooKassa\Request\Payments\CreateCaptureRequestInterface
Returns: bool -
public getTransfers() : \YooKassa\Request\Payments\TransferDataInterface[]|\YooKassa\Common\ListObjectInterface|null
public getTransfers() : \YooKassa\Request\Payments\TransferDataInterface[]|\YooKassa\Common\ListObjectInterface|null
Summary
Возвращает данные о распределении денег.
Details:
- Inherited From: \YooKassa\Request\Payments\CreateCaptureRequestInterface
Returns: \YooKassa\Request\Payments\TransferDataInterface[]|\YooKassa\Common\ListObjectInterface|null -
public setTransfers() : self
public setTransfers(null|array|\YooKassa\Request\Payments\TransferDataInterface[] $transfers = null) : self
Summary
Устанавливает transfers (массив распределения денег между магазинами).
Details:
- Inherited From: \YooKassa\Request\Payments\CreateCaptureRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
null OR array OR \YooKassa\Request\Payments\TransferDataInterface[] |
transfers |
Returns: self -
public hasDeal() : bool
public hasDeal() : bool
Summary
Проверяет наличие данных о сделке.
Details:
- Inherited From: \YooKassa\Request\Payments\CreateCaptureRequestInterface
Returns: bool -
public getDeal() : ?\YooKassa\Model\Deal\CaptureDealData
public getDeal() : ?\YooKassa\Model\Deal\CaptureDealData
Summary
Возвращает данные о сделке.
Details:
- Inherited From: \YooKassa\Request\Payments\CreateCaptureRequestInterface
Returns: ?\YooKassa\Model\Deal\CaptureDealData -
public setDeal() : \YooKassa\Common\AbstractRequestInterface
public setDeal(null|array|\YooKassa\Model\Deal\CaptureDealData $deal) : \YooKassa\Common\AbstractRequestInterface
Summary
Устанавливает данные о сделке.
Details:
- Inherited From: \YooKassa\Request\Payments\CreateCaptureRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
null OR array OR \YooKassa\Model\Deal\CaptureDealData |
deal |
Returns: \YooKassa\Common\AbstractRequestInterface -
Top Namespaces
Reports
This document was automatically generated from source code comments on 2025-07-01 using phpDocumentor
© 2025 YooMoney