10 KiB
YooKassa API SDK
Interface: CreateCaptureRequestInterface
Namespace: \YooKassa\Request\Payments\Payment
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/Payment/CreateCaptureRequestInterface.php
- Package: \YooKassa
Tags
| Tag | Version | Description |
|---|---|---|
| property-read | Подтверждаемая сумма оплаты | |
| property-read | Данные фискального чека 54-ФЗ |
Methods
public getAmount() : \YooKassa\Model\AmountInterface
public getAmount() : \YooKassa\Model\AmountInterface
Summary
Возвращает подтверждаемую сумму оплаты
Details:
- Inherited From: \YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface
Returns: \YooKassa\Model\AmountInterface - Подтверждаемая сумма оплаты
public hasAmount() : bool
public hasAmount() : bool
Summary
Проверяет, была ли установлена сумма оплаты
Details:
- Inherited From: \YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface
Returns: bool - True если сумма оплаты была установлена, false если нет
public setAmount() : mixed
public setAmount(\YooKassa\Model\AmountInterface $value) : mixed
Summary
Устанавливает сумму оплаты
Details:
- Inherited From: \YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\AmountInterface |
value | Сумма оплаты |
Returns: mixed -
public getReceipt() : \YooKassa\Model\ReceiptInterface|null
public getReceipt() : \YooKassa\Model\ReceiptInterface|null
Summary
Возвращает чек, если он есть
Details:
- Inherited From: \YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface
Returns: \YooKassa\Model\ReceiptInterface|null - Данные фискального чека 54-ФЗ или null, если чека нет
Tags
| Tag | Version | Description |
|---|---|---|
| since | 1.0.2 |
public hasReceipt() : bool
public hasReceipt() : bool
Summary
Проверяет наличие чека в создаваемом платеже
Details:
- Inherited From: \YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface
Returns: bool - True если чек есть, false если нет
Tags
| Tag | Version | Description |
|---|---|---|
| since | 1.0.2 |
public setReceipt() : mixed
public setReceipt(\YooKassa\Model\ReceiptInterface|null $value) : mixed
Summary
Устанавливает чек
Details:
- Inherited From: \YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\ReceiptInterface OR null |
value | Инстанс чека или null для удаления информации о чеке |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если передан не инстанс класса чека и не null |
Returns: mixed -
public hasTransfers() : bool
public hasTransfers() : bool
Summary
Проверяет наличие данных о распределении денег
Details:
- Inherited From: \YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface
Returns: bool -
public getTransfers() : \YooKassa\Model\TransferInterface[]
public getTransfers() : \YooKassa\Model\TransferInterface[]
Summary
Возвращает данные о распределении денег
Details:
- Inherited From: \YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface
Returns: \YooKassa\Model\TransferInterface[] -
public setTransfers() : mixed
public setTransfers(\YooKassa\Model\TransferInterface[]|array|null $value) : mixed
Summary
Устанавливает transfers (массив распределения денег между магазинами)
Details:
- Inherited From: \YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\TransferInterface[] OR array OR null |
value |
Returns: mixed -
public hasDeal() : bool
public hasDeal() : bool
Summary
Проверяет наличие данных о сделке
Details:
- Inherited From: \YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface
Returns: bool -
public getDeal() : \YooKassa\Model\Deal\PaymentDealInfo
public getDeal() : \YooKassa\Model\Deal\PaymentDealInfo
Summary
Возвращает данные о сделке
Details:
- Inherited From: \YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface
Returns: \YooKassa\Model\Deal\PaymentDealInfo -
public setDeal() : mixed
public setDeal(\YooKassa\Model\Deal\PaymentDealInfo|array|null $value) : mixed
Summary
Устанавливает данные о сделке
Details:
- Inherited From: \YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\Deal\PaymentDealInfo OR array OR null |
value |
Returns: mixed -
Top Namespaces
Reports
This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor
© 2023 YooMoney