geckon01/yookassa-sdk-php
1
0
Fork 0
mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-08-30 12:07:43 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
yookassa-sdk-php/docs/classes/YooKassa-Model-Payment-PaymentInterface.md
T

20 KiB
Raw Permalink Blame History

YooKassa API SDK

Interface: PaymentInterface

Namespace: \YooKassa\Model\Payment

Summary:

Interface PaymentInterface.

Constants

Visibility Name Flag Summary

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 getInvoiceDetails() Возвращает invoice_details.
public getMetadata() Возвращает метаданные платежа установленные мерчантом
public getPaid() Проверяет, был ли уже оплачен заказ.
public getPaymentMethod() Возвращает используемый способ проведения платежа.
public getReceiptRegistration() Возвращает состояние регистрации фискального чека.
public getRecipient() Возвращает получателя платежа.
public getRefundable() Возможность провести возврат по API.
public getRefundedAmount() Возвращает сумму возвращенных средств.
public getStatus() Возвращает состояние платежа.
public getTransfers() Возвращает данные о распределении платежа между магазинами.

Details

Tags

Tag Version Description
category Class
author cms@yoomoney.ru
property Идентификатор платежа
property Текущее состояние платежа
property Получатель платежа
property Сумма заказа
property Описание транзакции
property Способ проведения платежа
property Способ проведения платежа
property Время создания заказа
property Время создания заказа
property Время подтверждения платежа магазином
property Время подтверждения платежа магазином
property Время, до которого можно бесплатно отменить или подтвердить платеж
property Время, до которого можно бесплатно отменить или подтвердить платеж
property Способ подтверждения платежа
property Сумма возвращенных средств платежа
property Сумма возвращенных средств платежа
property Признак оплаты заказа
property Возможность провести возврат по API
property Состояние регистрации фискального чека
property Состояние регистрации фискального чека
property Метаданные платежа указанные мерчантом
property Признак тестовой операции
property Комментарий к отмене платежа
property Комментарий к отмене платежа
property Данные об авторизации платежа
property Данные об авторизации платежа
property Данные о распределении платежа между магазинами
property Сумма платежа, которую получит магазин
property Сумма платежа, которую получит магазин
property Данные о сделке, в составе которой проходит платеж
property Идентификатор покупателя в вашей системе, например электронная почта или номер телефона
property Идентификатор покупателя в вашей системе, например электронная почта или номер телефона
property Данные о выставленном счете, в рамках которого проведен платеж
property Данные о выставленном счете, в рамках которого проведен платеж

Constants

MIN_LENGTH_ID
MIN_LENGTH_ID = 36 : int

MAX_LENGTH_ID
MAX_LENGTH_ID = 36 : int

MAX_LENGTH_DESCRIPTION

Максимальная длина строки описания платежа

MAX_LENGTH_DESCRIPTION = 128

MAX_LENGTH_MERCHANT_CUSTOMER_ID

Максимальная длина строки идентификатора покупателя в вашей системе

MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200

Methods

public getId() : string|null

public getId() : string|null

Summary

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

Details:

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

public getStatus() : string|null

public getStatus() : string|null

Summary

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

Details:

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

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

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

Summary

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

Details:

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

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

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

Summary

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

Details:

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

public getPaymentMethod() : \YooKassa\Model\Payment\PaymentMethod\AbstractPaymentMethod|null

public getPaymentMethod() : \YooKassa\Model\Payment\PaymentMethod\AbstractPaymentMethod|null

Summary

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

Details:

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

public getCreatedAt() : \DateTime|null

public getCreatedAt() : \DateTime|null

Summary

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

Details:

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

public getCapturedAt() : null|\DateTime

public getCapturedAt() : null|\DateTime

Summary

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

Details:

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

public getConfirmation() : \YooKassa\Model\Payment\Confirmation\AbstractConfirmation|null

public getConfirmation() : \YooKassa\Model\Payment\Confirmation\AbstractConfirmation|null

Summary

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

Details:

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

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

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

Summary

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

Details:

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

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|null

public getReceiptRegistration() : string|null

Summary

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

Details:

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

public getMetadata() : \YooKassa\Model\Metadata|null

public getMetadata() : \YooKassa\Model\Metadata|null

Summary

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

Details:

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

public getExpiresAt() : null|\DateTime

public getExpiresAt() : null|\DateTime

Summary

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

Details:

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

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

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

Summary

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

Details:

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

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

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

Summary

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

Details:

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

public getTransfers() : \YooKassa\Model\Payment\TransferInterface[]|\YooKassa\Common\ListObjectInterface

public getTransfers() : \YooKassa\Model\Payment\TransferInterface[]|\YooKassa\Common\ListObjectInterface

Summary

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

Details:

Returns: \YooKassa\Model\Payment\TransferInterface[]|\YooKassa\Common\ListObjectInterface -

public getIncomeAmount() : ?\YooKassa\Model\AmountInterface

public getIncomeAmount() : ?\YooKassa\Model\AmountInterface

Summary

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

Details:

Returns: ?\YooKassa\Model\AmountInterface -

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

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

Summary

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

Details:

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

public getInvoiceDetails() : \YooKassa\Model\Payment\PaymentInvoiceDetails|null

public getInvoiceDetails() : \YooKassa\Model\Payment\PaymentInvoiceDetails|null

Summary

Возвращает invoice_details.

Details:

Returns: \YooKassa\Model\Payment\PaymentInvoiceDetails|null -

Top Namespaces

Reports

This document was automatically generated from source code comments on 2026-08-13 using phpDocumentor

© 2026 YooMoney

Reference in New Issue View Git Blame Copy Permalink