keboss/meraproject
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
5c21d25d45
meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Model-PaymentInterface.md
keboss-m 5c21d25d45 Initial commit: Merakomis portal, Docker stack and user-reader API. 
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-06-24 11:04:05 +03:00

16 KiB
Raw Blame History

YooKassa API SDK

Interface: PaymentInterface

Namespace: \YooKassa\Model

Summary:

Interface PaymentInterface

Constants

  • No constants found

Methods

Visibility Name Flag Summary
public getAmount() Возвращает сумму
public getAuthorizationDetails() Возвращает данные об авторизации платежа
public getCancellationDetails() Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине
public getCapturedAt() Возвращает время подтверждения платежа магазином или null, если время не задано
public getConfirmation() Возвращает способ подтверждения платежа
public getCreatedAt() Возвращает время создания заказа
public getDeal() Возвращает сделку, в рамках которой нужно провести платеж.
public getExpiresAt() Возвращает время до которого можно бесплатно отменить или подтвердить платеж, или null, если оно не задано
public getId() Возвращает идентификатор платежа
public getIncomeAmount() Возвращает сумму перечисляемая магазину за вычетом комиссий платежной системы.(только для успешных платежей)
public getMetadata() Возвращает метаданные платежа установленные мерчантом
public getPaid() Проверяет, был ли уже оплачен заказ
public getPaymentMethod() Возвращает используемый способ проведения платежа
public getReceiptRegistration() Возвращает состояние регистрации фискального чека
public getRecipient() Возвращает получателя платежа
public getRefundable() Возможность провести возврат по API
public getRefundedAmount() Возвращает сумму возвращенных средств
public getStatus() Возвращает состояние платежа
public getTransfers() Возвращает данные о распределении платежа между магазинами

Details

Tags

Tag Version Description
property-read Идентификатор платежа
property-read Текущее состояние платежа
property-read Получатель платежа
property-read Сумма заказа
property-read Описание транзакции
property-read Способ проведения платежа
property-read Способ проведения платежа
property-read Время создания заказа
property-read Время создания заказа
property-read Время подтверждения платежа магазином
property-read Время подтверждения платежа магазином
property-read Время, до которого можно бесплатно отменить или подтвердить платеж
property-read Время, до которого можно бесплатно отменить или подтвердить платеж
property-read Способ подтверждения платежа
property-read Сумма возвращенных средств платежа
property-read Сумма возвращенных средств платежа
property-read Признак оплаты заказа
property-read Возможность провести возврат по API
property-read Состояние регистрации фискального чека
property-read Состояние регистрации фискального чека
property-read Метаданные платежа указанные мерчантом
property-read Признак тестовой операции
property-read Комментарий к отмене платежа
property-read Комментарий к отмене платежа
property-read Данные об авторизации платежа
property-read Данные об авторизации платежа
property-read Данные о распределении платежа между магазинами
property-read Сумма платежа, которую получит магазин
property-read Сумма платежа, которую получит магазин

Methods

public getId() : string

public getId() : string

Summary

Возвращает идентификатор платежа

Details:

Returns: string - Идентификатор платежа

public getStatus() : string

public getStatus() : string

Summary

Возвращает состояние платежа

Details:

Returns: string - Текущее состояние платежа

public getRecipient() : \YooKassa\Model\RecipientInterface|null

public getRecipient() : \YooKassa\Model\RecipientInterface|null

Summary

Возвращает получателя платежа

Details:

Returns: \YooKassa\Model\RecipientInterface|null - Получатель платежа или null, если получатель не задан

public getAmount() : \YooKassa\Model\AmountInterface

public getAmount() : \YooKassa\Model\AmountInterface

Summary

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

Details:

Returns: \YooKassa\Model\AmountInterface - Сумма платежа

public getPaymentMethod() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod

public getPaymentMethod() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod

Summary

Возвращает используемый способ проведения платежа

Details:

Returns: \YooKassa\Model\PaymentMethod\AbstractPaymentMethod - Способ проведения платежа

public getCreatedAt() : \DateTime

public getCreatedAt() : \DateTime

Summary

Возвращает время создания заказа

Details:

Returns: \DateTime - Время создания заказа

public getCapturedAt() : \DateTime|null

public getCapturedAt() : \DateTime|null

Summary

Возвращает время подтверждения платежа магазином или null, если время не задано

Details:

Returns: \DateTime|null - Время подтверждения платежа магазином

public getConfirmation() : \YooKassa\Model\Confirmation\AbstractConfirmation

public getConfirmation() : \YooKassa\Model\Confirmation\AbstractConfirmation

Summary

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

Details:

Returns: \YooKassa\Model\Confirmation\AbstractConfirmation - Способ подтверждения платежа

public getRefundedAmount() : \YooKassa\Model\AmountInterface

public getRefundedAmount() : \YooKassa\Model\AmountInterface

Summary

Возвращает сумму возвращенных средств

Details:

Returns: \YooKassa\Model\AmountInterface - Сумма возвращенных средств платежа

public getPaid() : bool

public getPaid() : bool

Summary

Проверяет, был ли уже оплачен заказ

Details:

Returns: bool - Признак оплаты заказа, true если заказ оплачен, false если нет

public getRefundable() : bool

public getRefundable() : bool

Summary

Возможность провести возврат по API

Details:

Returns: bool - Возможность провести возврат по API

public getReceiptRegistration() : string

public getReceiptRegistration() : string

Summary

Возвращает состояние регистрации фискального чека

Details:

Returns: string - Состояние регистрации фискального чека

public getMetadata() : \YooKassa\Model\Metadata

public getMetadata() : \YooKassa\Model\Metadata

Summary

Возвращает метаданные платежа установленные мерчантом

Details:

Returns: \YooKassa\Model\Metadata - Метаданные платежа указанные мерчантом

public getExpiresAt() : \DateTime|null

public getExpiresAt() : \DateTime|null

Summary

Возвращает время до которого можно бесплатно отменить или подтвердить платеж, или null, если оно не задано

Details:

Returns: \DateTime|null - Время, до которого можно бесплатно отменить или подтвердить платеж

Tags
Tag Version Description
since 1.0.2

public getCancellationDetails() : \YooKassa\Model\CancellationDetailsInterface|null

public getCancellationDetails() : \YooKassa\Model\CancellationDetailsInterface|null

Summary

Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине

Details:

Returns: \YooKassa\Model\CancellationDetailsInterface|null - Комментарий к статусу canceled

Tags
Tag Version Description
since 1.0.13

public getAuthorizationDetails() : \YooKassa\Model\AuthorizationDetailsInterface|null

public getAuthorizationDetails() : \YooKassa\Model\AuthorizationDetailsInterface|null

Summary

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

Details:

Returns: \YooKassa\Model\AuthorizationDetailsInterface|null - Данные об авторизации платежа

Tags
Tag Version Description
since 1.0.18

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

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

Summary

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

Details:

Returns: \YooKassa\Model\TransferInterface[] -

public getIncomeAmount() : \YooKassa\Model\MonetaryAmount|null

public getIncomeAmount() : \YooKassa\Model\MonetaryAmount|null

Summary

Возвращает сумму перечисляемая магазину за вычетом комиссий платежной системы.(только для успешных платежей)

Details:

Returns: \YooKassa\Model\MonetaryAmount|null -

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

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

Summary

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

Details:

Returns: \YooKassa\Model\Deal\PaymentDealInfo - Сделка, в рамках которой нужно провести платеж

Top Namespaces

Reports

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

© 2023 YooMoney