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

78 KiB
Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Request\Payments\PaymentResponse

Namespace: \YooKassa\Request\Payments

Summary:

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

Description:

Объект ответа, возвращаемого API при запросе конкретного платежа.

Constants

  • No constants found

Properties

Visibility Name Flag Summary
public $amount Сумма заказа
public $authorization_details Данные об авторизации платежа
public $authorizationDetails Данные об авторизации платежа
public $cancellation_details Комментарий к отмене платежа
public $cancellationDetails Комментарий к отмене платежа
public $captured_at Время подтверждения платежа магазином
public $capturedAt Время подтверждения платежа магазином
public $confirmation Способ подтверждения платежа
public $created_at Время создания заказа
public $createdAt Время создания заказа
public $deal Данные о сделке, в составе которой проходит платеж
public $description Описание транзакции
public $expires_at Время, до которого можно бесплатно отменить или подтвердить платеж
public $expiresAt Время, до которого можно бесплатно отменить или подтвердить платеж
public $id Идентификатор платежа
public $income_amount Сумма платежа, которую получит магазин
public $incomeAmount Сумма платежа, которую получит магазин
public $invoice_details Данные о выставленном счете, в рамках которого проведен платеж
public $invoiceDetails Данные о выставленном счете, в рамках которого проведен платеж
public $merchant_customer_id Идентификатор покупателя в вашей системе, например электронная почта или номер телефона
public $merchantCustomerId Идентификатор покупателя в вашей системе, например электронная почта или номер телефона
public $metadata Метаданные платежа указанные мерчантом
public $paid Признак оплаты заказа
public $payment_method Способ проведения платежа
public $paymentMethod Способ проведения платежа
public $receipt_registration Состояние регистрации фискального чека
public $receiptRegistration Состояние регистрации фискального чека
public $recipient Получатель платежа
public $refundable Возможность провести возврат по API
public $refunded_amount Сумма возвращенных средств платежа
public $refundedAmount Сумма возвращенных средств платежа
public $status Текущее состояние платежа
public $test Признак тестовой операции
public $transfers Данные о распределении платежа между магазинами
protected $_amount
protected $_authorization_details Данные об авторизации платежа
protected $_cancellation_details Комментарий к статусу canceled: кто отменил платеж и по какой причине
protected $_captured_at
protected $_confirmation
protected $_created_at
protected $_deal
protected $_description
protected $_expires_at Время, до которого можно бесплатно отменить или подтвердить платеж. В указанное время платеж в статусе waiting_for_capture будет автоматически отменен.
protected $_id
protected $_income_amount
protected $_invoice_details
protected $_merchant_customer_id
protected $_metadata
protected $_paid
protected $_payment_method
protected $_receipt_registration
protected $_recipient
protected $_refundable
protected $_refunded_amount
protected $_status
protected $_test Признак тестовой операции.
protected $_transfers

Methods

Visibility Name Flag Summary
public __construct() AbstractObject constructor.
public __get() Возвращает значение свойства.
public __isset() Проверяет наличие свойства.
public __set() Устанавливает значение свойства.
public __unset() Удаляет свойство.
public fromArray() Устанавливает значения свойств текущего объекта из массива.
public getAmount() Возвращает сумму.
public getAuthorizationDetails() Возвращает данные об авторизации платежа.
public getCancellationDetails() Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине.
public getCapturedAt() Возвращает время подтверждения платежа магазином или null, если время не задано.
public getConfirmation() Возвращает способ подтверждения платежа.
public getCreatedAt() Возвращает время создания заказа.
public getDeal() Возвращает данные о сделке, в составе которой проходит платеж.
public getDescription() Возвращает описание транзакции
public getExpiresAt() Возвращает время до которого можно бесплатно отменить или подтвердить платеж, или null, если оно не задано.
public getId() Возвращает идентификатор платежа.
public getIncomeAmount() Возвращает сумму платежа, которую получит магазин, значение amount за вычетом комиссии ЮKassa.
public getInvoiceDetails() Возвращает invoice_details.
public getMerchantCustomerId() Возвращает идентификатор покупателя в вашей системе.
public getMetadata() Возвращает метаданные платежа установленные мерчантом
public getPaid() Проверяет, был ли уже оплачен заказ.
public getPaymentMethod() Возвращает используемый способ проведения платежа.
public getReceiptRegistration() Возвращает состояние регистрации фискального чека.
public getRecipient() Возвращает получателя платежа.
public getRefundable() Проверяет возможность провести возврат по API.
public getRefundedAmount() Возвращает сумму возвращенных средств.
public getStatus() Возвращает состояние платежа.
public getTest() Возвращает признак тестовой операции.
public getTransfers() Возвращает массив распределения денег между магазинами.
public getValidator()
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public setAmount() Устанавливает сумму платежа.
public setAuthorizationDetails() Устанавливает данные об авторизации платежа.
public setCancellationDetails() Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине.
public setCapturedAt() Устанавливает время подтверждения платежа магазином
public setConfirmation() Устанавливает способ подтверждения платежа.
public setCreatedAt() Устанавливает время создания заказа.
public setDeal() Устанавливает данные о сделке, в составе которой проходит платеж.
public setDescription() Устанавливает описание транзакции
public setExpiresAt() Устанавливает время до которого можно бесплатно отменить или подтвердить платеж.
public setId() Устанавливает идентификатор платежа.
public setIncomeAmount() Устанавливает сумму платежа, которую получит магазин, значение amount за вычетом комиссии ЮKassa
public setInvoiceDetails() Устанавливает invoice_details.
public setMerchantCustomerId() Устанавливает идентификатор покупателя в вашей системе.
public setMetadata() Устанавливает метаданные платежа.
public setPaid() Устанавливает флаг оплаты заказа.
public setPaymentMethod() Устанавливает используемый способ проведения платежа.
public setReceiptRegistration() Устанавливает состояние регистрации фискального чека
public setRecipient() Устанавливает получателя платежа.
public setRefundable() Устанавливает возможность провести возврат по API.
public setRefundedAmount() Устанавливает сумму возвращенных средств.
public setStatus() Устанавливает статус платежа
public setTest() Устанавливает признак тестовой операции.
public setTransfers() Устанавливает массив распределения денег между магазинами.
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected validatePropertyValue()

Details

Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Properties

public $amount : \YooKassa\Model\AmountInterface

Description

Сумма заказа

Type: AmountInterface

Details:

public $authorization_details : \YooKassa\Model\Payment\AuthorizationDetailsInterface

Description

Данные об авторизации платежа

Type: AuthorizationDetailsInterface

Details:

public $authorizationDetails : \YooKassa\Model\Payment\AuthorizationDetailsInterface

Description

Данные об авторизации платежа

Type: AuthorizationDetailsInterface

Details:

public $cancellation_details : \YooKassa\Model\CancellationDetailsInterface

Description

Комментарий к отмене платежа

Type: CancellationDetailsInterface

Details:

public $cancellationDetails : \YooKassa\Model\CancellationDetailsInterface

Description

Комментарий к отмене платежа

Type: CancellationDetailsInterface

Details:

public $captured_at : \DateTime

Description

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

Type: \DateTime

Details:

public $capturedAt : \DateTime

Description

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

Type: \DateTime

Details:

public $confirmation : \YooKassa\Model\Payment\Confirmation\AbstractConfirmation

Description

Способ подтверждения платежа

Type: AbstractConfirmation

Details:

public $created_at : \DateTime

Description

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

Type: \DateTime

Details:

public $createdAt : \DateTime

Description

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

Type: \DateTime

Details:

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

Description

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

Type: PaymentDealInfo

Details:

public $description : string

Description

Описание транзакции

Type: string

Details:

public $expires_at : \DateTime

Description

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

Type: \DateTime

Details:

public $expiresAt : \DateTime

Description

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

Type: \DateTime

Details:

public $id : string

Description

Идентификатор платежа

Type: string

Details:

public $income_amount : \YooKassa\Model\AmountInterface

Description

Сумма платежа, которую получит магазин

Type: AmountInterface

Details:

public $incomeAmount : \YooKassa\Model\AmountInterface

Description

Сумма платежа, которую получит магазин

Type: AmountInterface

Details:

public $invoice_details : \YooKassa\Model\Payment\PaymentInvoiceDetails

Description

Данные о выставленном счете, в рамках которого проведен платеж

Type: PaymentInvoiceDetails

Details:

public $invoiceDetails : \YooKassa\Model\Payment\PaymentInvoiceDetails

Description

Данные о выставленном счете, в рамках которого проведен платеж

Type: PaymentInvoiceDetails

Details:

public $merchant_customer_id : string

Description

Идентификатор покупателя в вашей системе, например электронная почта или номер телефона

Type: string

Details:

public $merchantCustomerId : string

Description

Идентификатор покупателя в вашей системе, например электронная почта или номер телефона

Type: string

Details:

public $metadata : \YooKassa\Model\Metadata

Description

Метаданные платежа указанные мерчантом

Type: Metadata

Details:

public $paid : bool

Description

Признак оплаты заказа

Type: bool

Details:

public $payment_method : \YooKassa\Model\Payment\PaymentMethod\AbstractPaymentMethod

Description

Способ проведения платежа

Type: AbstractPaymentMethod

Details:

public $paymentMethod : \YooKassa\Model\Payment\PaymentMethod\AbstractPaymentMethod

Description

Способ проведения платежа

Type: AbstractPaymentMethod

Details:

public $receipt_registration : string

Description

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

Type: string

Details:

public $receiptRegistration : string

Description

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

Type: string

Details:

public $recipient : \YooKassa\Model\Payment\RecipientInterface

Description

Получатель платежа

Type: RecipientInterface

Details:

public $refundable : bool

Description

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

Type: bool

Details:

public $refunded_amount : \YooKassa\Model\AmountInterface

Description

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

Type: AmountInterface

Details:

public $refundedAmount : \YooKassa\Model\AmountInterface

Description

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

Type: AmountInterface

Details:

public $status : string

Description

Текущее состояние платежа

Type: string

Details:

public $test : bool

Description

Признак тестовой операции

Type: bool

Details:

public $transfers : \YooKassa\Common\ListObjectInterface|\YooKassa\Model\Payment\TransferInterface[]

Description

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

Type: TransferInterface[]

Details:

protected $_amount : ?\YooKassa\Model\AmountInterface

Type: AmountInterface

Details:

protected $_authorization_details : ?\YooKassa\Model\Payment\AuthorizationDetailsInterface

Summary

Данные об авторизации платежа

Type: AuthorizationDetailsInterface

Details:

protected $_cancellation_details : ?\YooKassa\Model\CancellationDetailsInterface

Summary

Комментарий к статусу canceled: кто отменил платеж и по какой причине

Type: CancellationDetailsInterface

Details:

protected $_captured_at : ?\DateTime

Type: DateTime Время подтверждения платежа магазином Details:

protected $_confirmation : ?\YooKassa\Model\Payment\Confirmation\AbstractConfirmation

Type: AbstractConfirmation Способ подтверждения платежа Details:

protected $_created_at : ?\DateTime

Type: DateTime Время создания заказа Details:

protected $_deal : ?\YooKassa\Model\Deal\PaymentDealInfo

Type: PaymentDealInfo Данные о сделке, в составе которой проходит платеж. Необходимо передавать, если вы проводите Безопасную сделку Details:

protected $_description : ?string

Type: ?string Описание платежа Details:

protected $_expires_at : ?\DateTime

Summary

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

Type: DateTime Время, до которого можно бесплатно отменить или подтвердить платеж Details:

protected $_id : ?string

Type: ?string Идентификатор платежа Details:

protected $_income_amount : ?\YooKassa\Model\AmountInterface

Type: AmountInterface

Details:

protected $_invoice_details : ?\YooKassa\Model\Payment\PaymentInvoiceDetails

Type: PaymentInvoiceDetails

Details:

protected $_merchant_customer_id : ?string

Type: ?string Идентификатор покупателя в вашей системе, например электронная почта или номер телефона. Не более 200 символов. Присутствует, если вы хотите запомнить банковскую карту и отобразить ее при повторном платеже в виджете ЮKassa Details:

protected $_metadata : ?\YooKassa\Model\Metadata

Type: Metadata Метаданные платежа указанные мерчантом Details:

protected $_paid : bool

Type: bool Признак оплаты заказа Details:

protected $_payment_method : ?\YooKassa\Model\Payment\PaymentMethod\AbstractPaymentMethod

Type: AbstractPaymentMethod Способ проведения платежа Details:

protected $_receipt_registration : ?string

Type: ?string Состояние регистрации фискального чека Details:

protected $_recipient : ?\YooKassa\Model\Payment\RecipientInterface

Type: RecipientInterface Получатель платежа Details:

protected $_refundable : bool

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

protected $_refunded_amount : ?\YooKassa\Model\AmountInterface

Type: AmountInterface Сумма возвращенных средств платежа Details:

protected $_status : ?string

Type: ?string Текущее состояние платежа Details:

protected $_test : bool

Summary

Признак тестовой операции.

Type: bool

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

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

Summary

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

Details:

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

Returns: void -

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

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

Summary

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

Details:

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

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

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

Summary

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

Details:

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

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

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

Summary

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

Details:

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

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 getCreatedAt() : \DateTime|null

public getCreatedAt() : \DateTime|null

Summary

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

Details:

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

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

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

Summary

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

Details:

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

public getDescription() : string|null

public getDescription() : string|null

Summary

Возвращает описание транзакции

Details:

Returns: string|null -

public getExpiresAt() : null|\DateTime

public getExpiresAt() : null|\DateTime

Summary

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

Details:

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

public getId() : string|null

public getId() : string|null

Summary

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

Details:

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

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

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

Summary

Возвращает сумму платежа, которую получит магазин, значение amount за вычетом комиссии ЮKassa.

Details:

Returns: \YooKassa\Model\AmountInterface|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 -

public getMerchantCustomerId() : string|null

public getMerchantCustomerId() : 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 getPaid() : bool

public getPaid() : bool

Summary

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

Details:

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

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 getReceiptRegistration() : string|null

public getReceiptRegistration() : 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 getRefundable() : bool

public getRefundable() : bool

Summary

Проверяет возможность провести возврат по API.

Details:

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

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

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

Summary

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

Details:

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

public getStatus() : string|null

public getStatus() : string|null

Summary

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

Details:

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

public getTest() : bool

public getTest() : bool

Summary

Возвращает признак тестовой операции.

Details:

Returns: bool - Признак тестовой операции

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 getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

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 setAmount() : self

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\AmountInterface OR array OR null amount Сумма платежа

Returns: self -

public setAuthorizationDetails() : self

public setAuthorizationDetails(\YooKassa\Model\Payment\AuthorizationDetailsInterface|array|null $authorization_details = null) : self

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\Payment\AuthorizationDetailsInterface OR array OR null authorization_details Данные об авторизации платежа

Returns: self -

public setCancellationDetails() : self

public setCancellationDetails(\YooKassa\Model\CancellationDetailsInterface|array|null $cancellation_details = null) : self

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\CancellationDetailsInterface OR array OR null cancellation_details Комментарий к статусу canceled

Returns: self -

public setCapturedAt() : self

public setCapturedAt(\DateTime|string|null $captured_at = null) : self

Summary

Устанавливает время подтверждения платежа магазином

Details:

Parameters:
Type Name Description
\DateTime OR string OR null captured_at Время подтверждения платежа магазином

Returns: self -

public setConfirmation() : self

public setConfirmation(\YooKassa\Model\Payment\Confirmation\AbstractConfirmation|array|null $confirmation = null) : self

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\Payment\Confirmation\AbstractConfirmation OR array OR null confirmation Способ подтверждения платежа

Returns: self -

public setCreatedAt() : self

public setCreatedAt(\DateTime|string|null $created_at = null) : self

Summary

Устанавливает время создания заказа.

Details:

Parameters:
Type Name Description
\DateTime OR string OR null created_at Время создания заказа

Returns: self -

public setDeal() : self

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

Summary

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

Details:

Parameters:
Type Name Description
null OR array OR \YooKassa\Model\Deal\PaymentDealInfo deal Данные о сделке, в составе которой проходит платеж

Returns: self -

public setDescription() : self

public setDescription(string|null $description = null) : self

Summary

Устанавливает описание транзакции

Details:

Parameters:
Type Name Description
string OR null description

Returns: self -

public setExpiresAt() : self

public setExpiresAt(\DateTime|string|null $expires_at = null) : self

Summary

Устанавливает время до которого можно бесплатно отменить или подтвердить платеж.

Details:

Parameters:
Type Name Description
\DateTime OR string OR null expires_at Время, до которого можно бесплатно отменить или подтвердить платеж

Returns: self -

public setId() : self

public setId(string|null $id = null) : self

Summary

Устанавливает идентификатор платежа.

Details:

Parameters:
Type Name Description
string OR null id Идентификатор платежа

Returns: self -

public setIncomeAmount() : self

public setIncomeAmount(\YooKassa\Model\AmountInterface|array|null $income_amount = null) : self

Summary

Устанавливает сумму платежа, которую получит магазин, значение amount за вычетом комиссии ЮKassa

Details:

Parameters:
Type Name Description
\YooKassa\Model\AmountInterface OR array OR null income_amount

Returns: self -

public setInvoiceDetails() : self

public setInvoiceDetails(\YooKassa\Model\Payment\PaymentInvoiceDetails|array|null $invoice_details = null) : self

Summary

Устанавливает invoice_details.

Details:

Parameters:
Type Name Description
\YooKassa\Model\Payment\PaymentInvoiceDetails OR array OR null invoice_details

Returns: self -

public setMerchantCustomerId() : self

public setMerchantCustomerId(string|null $merchant_customer_id = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null merchant_customer_id Идентификатор покупателя в вашей системе, например электронная почта или номер телефона. Не более 200 символов

Returns: self -

public setMetadata() : self

public setMetadata(\YooKassa\Model\Metadata|array|null $metadata = null) : self

Summary

Устанавливает метаданные платежа.

Details:

Parameters:
Type Name Description
\YooKassa\Model\Metadata OR array OR null metadata Метаданные платежа указанные мерчантом

Returns: self -

public setPaid() : self

public setPaid(bool $paid) : self

Summary

Устанавливает флаг оплаты заказа.

Details:

Parameters:
Type Name Description
bool paid Признак оплаты заказа

Returns: self -

public setPaymentMethod() : self

public setPaymentMethod(\YooKassa\Model\Payment\PaymentMethod\AbstractPaymentMethod|array|null $payment_method) : self

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\Payment\PaymentMethod\AbstractPaymentMethod OR array OR null payment_method Способ проведения платежа

Returns: self -

public setReceiptRegistration() : self

public setReceiptRegistration(string|null $receipt_registration = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null receipt_registration Состояние регистрации фискального чека

Returns: self -

public setRecipient() : self

public setRecipient(\YooKassa\Model\Payment\RecipientInterface|array|null $recipient = null) : self

Summary

Устанавливает получателя платежа.

Details:

Parameters:
Type Name Description
\YooKassa\Model\Payment\RecipientInterface OR array OR null recipient Объект с информацией о получателе платежа

Returns: self -

public setRefundable() : self

public setRefundable(bool $refundable) : self

Summary

Устанавливает возможность провести возврат по API.

Details:

Parameters:
Type Name Description
bool refundable Возможность провести возврат по API

Returns: self -

public setRefundedAmount() : self

public setRefundedAmount(\YooKassa\Model\AmountInterface|array|null $refunded_amount = null) : self

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\AmountInterface OR array OR null refunded_amount Сумма возвращенных средств платежа

Returns: self -

public setStatus() : self

public setStatus(string|null $status = null) : self

Summary

Устанавливает статус платежа

Details:

Parameters:
Type Name Description
string OR null status Статус платежа

Returns: self -

public setTest() : self

public setTest(bool $test = null) : self

Summary

Устанавливает признак тестовой операции.

Details:

Parameters:
Type Name Description
bool test Признак тестовой операции

Returns: self -

public setTransfers() : self

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

Summary

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

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 - Ассоциативный массив со свойствами текущего объекта

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

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

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