meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Model-Payment.md

YooKassa API SDK

Class: \YooKassa\Model\Payment

Namespace: \YooKassa\Model

---

Summary:

Payment - Данные о платеже

---

Constants

Visibility	Name	Flag	Summary
public	MAX_LENGTH_DESCRIPTION		Максимальная длина строки описания платежа
public	MAX_LENGTH_MERCHANT_CUSTOMER_ID		Максимальная длина строки идентификатора покупателя в вашей системе

---

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	$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		Данные о распределении платежа между магазинами

---

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	getMerchantCustomerId()		Возвращает идентификатор покупателя в вашей системе
public	getMetadata()		Возвращает метаданные платежа установленные мерчантом
public	getPaid()		Проверяет, был ли уже оплачен заказ
public	getPaymentMethod()		Возвращает используемый способ проведения платежа
public	getReceiptRegistration()		Возвращает состояние регистрации фискального чека
public	getRecipient()		Возвращает получателя платежа
public	getRefundable()		Проверяет возможность провести возврат по API
public	getRefundedAmount()		Возвращает сумму возвращенных средств
public	getRequestor()	deprecated	Возвращает инициатора платежа
public	getStatus()		Возвращает состояние платежа
public	getTest()		Возвращает признак тестовой операции
public	getTransfers()		Возвращает массив распределения денег между магазинами
public	jsonSerialize()
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	setMerchantCustomerId()		Устанавливает идентификатор покупателя в вашей системе
public	setMetadata()		Устанавливает метаданные платежа
public	setPaid()		Устанавливает флаг оплаты заказа
public	setPaymentMethod()		Устанавливает используемый способ проведения платежа
public	setReceiptRegistration()		Устанавливает состояние регистрации фискального чека
public	setRecipient()		Устанавливает получателя платежа
public	setRefundable()		Устанавливает возможность провести возврат по API
public	setRefundedAmount()		Устанавливает сумму возвращенных средств
public	setRequestor()	deprecated	Устанавливает инициатора платежа
public	setStatus()		Устанавливает статус платежа
public	setTest()		Устанавливает признак тестовой операции
public	setTransfers()		Устанавливает массив распределения денег между магазинами
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта

---

Details

• File: lib/Model/Payment.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Model\Payment
• Implements:
  • \YooKassa\Model\PaymentInterface

---

Constants

MAX_LENGTH_DESCRIPTION

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

MAX_LENGTH_DESCRIPTION = 128

MAX_LENGTH_MERCHANT_CUSTOMER_ID

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

MAX_LENGTH_MERCHANT_CUSTOMER_ID = 200

---

Properties

public $amount : \YooKassa\Model\AmountInterface

---

Description

Сумма заказа

Type: AmountInterface

Details:

public $authorization_details : \YooKassa\Model\AuthorizationDetailsInterface

---

Description

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

Type: AuthorizationDetailsInterface

Details:

public $authorizationDetails : \YooKassa\Model\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\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 $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\PaymentMethod\AbstractPaymentMethod

---

Description

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

Type: AbstractPaymentMethod

Details:

public $paymentMethod : \YooKassa\Model\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\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\Model\TransferInterface[]

---

Description

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

Type: TransferInterface[]

Details:

---

Methods

public __construct() : mixed

public __construct(array $data = array()) : mixed

Summary

AbstractObject constructor.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array	data

Returns: mixed -

public __get() : mixed

public __get(string $propertyName) : mixed

Summary

Возвращает значение свойства

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя свойства

Returns: mixed - Значение свойства

public __isset() : bool

public __isset(string $propertyName) : bool

Summary

Проверяет наличие свойства

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public __set() : mixed

public __set(string $propertyName, mixed $value) : mixed

Summary

Устанавливает значение свойства

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя свойства
mixed	value	Значение свойства

Returns: mixed -

public __unset() : mixed

public __unset(string $propertyName) : mixed

Summary

Удаляет свойство

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя удаляемого свойства

Returns: mixed -

public fromArray() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public getAmount() : \YooKassa\Model\AmountInterface

public getAmount() : \YooKassa\Model\AmountInterface

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

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

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

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

Tags

Tag	Version	Description
since	1.0.18

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

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

Tags

Tag	Version	Description
since	1.0.13

public getCapturedAt() : \DateTime|null

public getCapturedAt() : \DateTime|null

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

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

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

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

public getCreatedAt() : \DateTime

public getCreatedAt() : \DateTime

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

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

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

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

public getDescription() : string

public getDescription() : string

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Returns: string -

public getExpiresAt() : \DateTime|null

public getExpiresAt() : \DateTime|null

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

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

Tags

Tag	Version	Description
since	1.0.2

public getId() : string

public getId() : string

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

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

public getIncomeAmount() : \YooKassa\Model\MonetaryAmount

public getIncomeAmount() : \YooKassa\Model\MonetaryAmount

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Returns: \YooKassa\Model\MonetaryAmount - Сумма платежа, которую получит магазин

public getMerchantCustomerId() : string

public getMerchantCustomerId() : string

Summary

Возвращает идентификатор покупателя в вашей системе

Details:

• Inherited From: \YooKassa\Model\Payment

Returns: string - Идентификатор покупателя в вашей системе

public getMetadata() : \YooKassa\Model\Metadata

public getMetadata() : \YooKassa\Model\Metadata

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

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

public getPaid() : bool

public getPaid() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

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

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

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

public getReceiptRegistration() : string

public getReceiptRegistration() : string

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

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

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

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

public getRefundable() : bool

public getRefundable() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

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

public getRefundedAmount() : \YooKassa\Model\AmountInterface

public getRefundedAmount() : \YooKassa\Model\AmountInterface

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

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

(deprecated) - public getRequestor() : \YooKassa\Model\RequestorInterface

public getRequestor() : \YooKassa\Model\RequestorInterface

Summary

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

Deprecated DeprecatedНе используется. Будет удален в следующих версиях Details:

• Inherited From: \YooKassa\Model\Payment

Returns: \YooKassa\Model\RequestorInterface -

public getStatus() : string

public getStatus() : string

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

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

public getTest() : bool

public getTest() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

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

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Returns: \YooKassa\Model\TransferInterface[] -

public jsonSerialize() : mixed

public jsonSerialize() : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: mixed -

public offsetExists() : mixed

public offsetExists(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetGet() : mixed

public offsetGet(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetSet() : mixed

public offsetSet(mixed $offset, mixed $value) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset
mixed	value

Returns: mixed -

public offsetUnset() : mixed

public offsetUnset(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public setAmount() : mixed

public setAmount(\YooKassa\Model\AmountInterface $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

Type	Name	Description
\YooKassa\Model\AmountInterface	value	Сумма платежа

Returns: mixed -

public setAuthorizationDetails() : mixed

public setAuthorizationDetails(\YooKassa\Model\AuthorizationDetailsInterface $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

Type	Name	Description
\YooKassa\Model\AuthorizationDetailsInterface	value	Данные об авторизации платежа

Returns: mixed -

public setCancellationDetails() : mixed

public setCancellationDetails(\YooKassa\Model\CancellationDetailsInterface $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

Type	Name	Description
\YooKassa\Model\CancellationDetailsInterface	value	Комментарий к статусу canceled

Returns: mixed -

public setCapturedAt() : mixed

public setCapturedAt(\DateTime|string|int|null $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасвается если передали строку, которую не удалось привести к дате
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	\Exception

Returns: mixed -

public setConfirmation() : mixed

public setConfirmation(\YooKassa\Model\Confirmation\AbstractConfirmation $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

Type	Name	Description
\YooKassa\Model\Confirmation\AbstractConfirmation	value	Способ подтверждения платежа

Returns: mixed -

public setCreatedAt() : mixed

public setCreatedAt(\DateTime|string|int $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

Type	Name	Description
\DateTime OR string OR int	value	Время создания заказа

Throws:

Type	Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException	Выбрасывается если в метод была передана пустая дата
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если передали строку, которую не удалось привести к дате
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	\Exception

Returns: mixed -

public setDeal() : mixed

public setDeal(\YooKassa\Model\Deal\PaymentDealInfo|array|null $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданные данные не удалось интерпретировать как данные сделки

Returns: mixed -

public setDescription() : mixed

public setDescription(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

Type	Name	Description
string	value

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если переданное значение превышает допустимую длину
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданное значение не является строкой

Returns: mixed -

public setExpiresAt() : mixed

public setExpiresAt(\DateTime|string|int|null $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если передали строку, которую не удалось привести к дате
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	\Exception

Returns: mixed -

Tags

Tag	Version	Description
since	1.0.2

public setId() : mixed

public setId(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

Type	Name	Description
string	value	Идентификатор платежа

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если длина переданной строки не равна 36
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если в метод была передана не строка

Returns: mixed -

public setIncomeAmount() : mixed

public setIncomeAmount(\YooKassa\Model\MonetaryAmount $amount) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

Type	Name	Description
\YooKassa\Model\MonetaryAmount	amount

Returns: mixed -

public setMerchantCustomerId() : mixed

public setMerchantCustomerId(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданный аргумент не является строкой

Returns: mixed -

public setMetadata() : mixed

public setMetadata(\YooKassa\Model\Metadata $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

Type	Name	Description
\YooKassa\Model\Metadata	value	Метаданные платежа указанные мерчантом

Returns: mixed -

public setPaid() : mixed

public setPaid(bool $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException	Выбрасывается если переданный аргумент пуст
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданный аргумент не кастится в булево значение

Returns: mixed -

public setPaymentMethod() : mixed

public setPaymentMethod(\YooKassa\Model\PaymentMethod\AbstractPaymentMethod $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

Type	Name	Description
\YooKassa\Model\PaymentMethod\AbstractPaymentMethod	value	Способ проведения платежа

Returns: mixed -

public setReceiptRegistration() : mixed

public setReceiptRegistration(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

Type	Name	Description
string	value	Состояние регистрации фискального чека

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если переданное состояние регистрации не существует
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданный аргумент не строка

Returns: mixed -

public setRecipient() : mixed

public setRecipient(\YooKassa\Model\RecipientInterface $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

Type	Name	Description
\YooKassa\Model\RecipientInterface	value	Объект с информацией о получателе платежа

Returns: mixed -

public setRefundable() : mixed

public setRefundable(bool $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException	Выбрасывается если переданный аргумент пуст
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданный аргумент не кастится в булево значение

Returns: mixed -

public setRefundedAmount() : mixed

public setRefundedAmount(\YooKassa\Model\AmountInterface $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

Type	Name	Description
\YooKassa\Model\AmountInterface	value	Сумма возвращенных средств платежа

Returns: mixed -

(deprecated) - public setRequestor() : mixed

public setRequestor(\YooKassa\Model\RequestorInterface|array $value) : mixed

Summary

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

Deprecated DeprecatedНе используется. Будет удален в следующих версиях Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

Type	Name	Description
\YooKassa\Model\RequestorInterface OR array	value

Returns: mixed -

public setStatus() : mixed

public setStatus(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

Type	Name	Description
string	value	Статус платежа

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если переданная строка не является валидным статусом
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если в метод была передана не строка

Returns: mixed -

public setTest() : mixed

public setTest(bool $test) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

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

Returns: mixed -

public setTransfers() : mixed

public setTransfers(\YooKassa\Model\TransferInterface[] $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payment

Parameters:

Type	Name	Description
\YooKassa\Model\TransferInterface[]	value

Returns: mixed -

public toArray() : array

public toArray() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 1
• Deprecated - 25

---

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

© 2023 YooMoney