# [YooKassa API SDK](../home.md) # Class: \YooKassa\Request\Invoices\PaymentData ### Namespace: [\YooKassa\Request\Invoices](../namespaces/yookassa-request-invoices.md) --- **Summary:** Класс, представляющий модель PaymentData. **Description:** Данные для проведения платежа по выставленному счету. --- ### Constants * No constants found --- ### Properties | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | | public | [$amount](../classes/YooKassa-Request-Invoices-PaymentData.md#property_amount) | | Сумма платежа. Должна укладываться в [лимиты](https://yookassa.ru/docs/support/payments/limits). | | public | [$capture](../classes/YooKassa-Request-Invoices-PaymentData.md#property_capture) | | [Автоматический прием](https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-true) поступившего платежа. | | public | [$client_ip](../classes/YooKassa-Request-Invoices-PaymentData.md#property_client_ip) | | IPv4 или IPv6-адрес пользователя. Если не указан, используется IP-адрес TCP-подключения. | | public | [$clientIp](../classes/YooKassa-Request-Invoices-PaymentData.md#property_clientIp) | | IPv4 или IPv6-адрес пользователя. Если не указан, используется IP-адрес TCP-подключения. | | public | [$description](../classes/YooKassa-Request-Invoices-PaymentData.md#property_description) | | Описание транзакции (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь — при оплате. Например: «Оплата заказа № 72 для user@yoomoney.ru». | | public | [$metadata](../classes/YooKassa-Request-Invoices-PaymentData.md#property_metadata) | | Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. | | public | [$receipt](../classes/YooKassa-Request-Invoices-PaymentData.md#property_receipt) | | Данные для формирования чека. | | public | [$recipient](../classes/YooKassa-Request-Invoices-PaymentData.md#property_recipient) | | Получатель платежа. Нужен, если вы разделяете потоки платежей в рамках одного аккаунта или создаете платеж в адрес другого аккаунта. | | public | [$save_payment_method](../classes/YooKassa-Request-Invoices-PaymentData.md#property_save_payment_method) | | Сохранение платежных данных для проведения [автоплатежей](https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments). | | public | [$savePaymentMethod](../classes/YooKassa-Request-Invoices-PaymentData.md#property_savePaymentMethod) | | Сохранение платежных данных для проведения [автоплатежей](https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments). | --- ### Methods | Visibility | Name | Flag | Summary | | ----------:| ---- | ---- | ------- | | public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | | public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства. | | public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства. | | public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства. | | public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство. | | public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива. | | public | [getAmount()](../classes/YooKassa-Request-Invoices-PaymentData.md#method_getAmount) | | Возвращает amount. | | public | [getCapture()](../classes/YooKassa-Request-Invoices-PaymentData.md#method_getCapture) | | Возвращает capture. | | public | [getClientIp()](../classes/YooKassa-Request-Invoices-PaymentData.md#method_getClientIp) | | Возвращает client_ip. | | public | [getDescription()](../classes/YooKassa-Request-Invoices-PaymentData.md#method_getDescription) | | Возвращает description. | | public | [getMetadata()](../classes/YooKassa-Request-Invoices-PaymentData.md#method_getMetadata) | | Возвращает metadata. | | public | [getReceipt()](../classes/YooKassa-Request-Invoices-PaymentData.md#method_getReceipt) | | Возвращает receipt. | | public | [getRecipient()](../classes/YooKassa-Request-Invoices-PaymentData.md#method_getRecipient) | | Возвращает recipient. | | public | [getSavePaymentMethod()](../classes/YooKassa-Request-Invoices-PaymentData.md#method_getSavePaymentMethod) | | Возвращает save_payment_method. | | public | [getValidator()](../classes/YooKassa-Common-AbstractObject.md#method_getValidator) | | | | public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации. | | public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства. | | public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства. | | public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства. | | public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство. | | public | [setAmount()](../classes/YooKassa-Request-Invoices-PaymentData.md#method_setAmount) | | Устанавливает amount. | | public | [setCapture()](../classes/YooKassa-Request-Invoices-PaymentData.md#method_setCapture) | | Устанавливает capture. | | public | [setClientIp()](../classes/YooKassa-Request-Invoices-PaymentData.md#method_setClientIp) | | Устанавливает client_ip. | | public | [setDescription()](../classes/YooKassa-Request-Invoices-PaymentData.md#method_setDescription) | | Устанавливает description. | | public | [setMetadata()](../classes/YooKassa-Request-Invoices-PaymentData.md#method_setMetadata) | | Устанавливает metadata. | | public | [setReceipt()](../classes/YooKassa-Request-Invoices-PaymentData.md#method_setReceipt) | | Устанавливает receipt. | | public | [setRecipient()](../classes/YooKassa-Request-Invoices-PaymentData.md#method_setRecipient) | | Устанавливает recipient. | | public | [setSavePaymentMethod()](../classes/YooKassa-Request-Invoices-PaymentData.md#method_setSavePaymentMethod) | | Устанавливает save_payment_method. | | public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize(). | | protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта. | | protected | [validatePropertyValue()](../classes/YooKassa-Common-AbstractObject.md#method_validatePropertyValue) | | | --- ### Details * File: [lib/Request/Invoices/PaymentData.php](../../lib/Request/Invoices/PaymentData.php) * Package: YooKassa\Model * Class Hierarchy: * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) * \YooKassa\Request\Invoices\PaymentData * See Also: * [](https://yookassa.ru/developers/api) --- ### Tags | Tag | Version | Description | | --- | ------- | ----------- | | category | | Class | | author | | cms@yoomoney.ru | --- ## Properties #### public $amount : \YooKassa\Model\AmountInterface --- ***Description*** Сумма платежа. Должна укладываться в [лимиты](https://yookassa.ru/docs/support/payments/limits). **Type:** AmountInterface **Details:** #### public $capture : bool --- ***Description*** [Автоматический прием](https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-true) поступившего платежа. **Type:** bool **Details:** #### public $client_ip : string --- ***Description*** IPv4 или IPv6-адрес пользователя. Если не указан, используется IP-адрес TCP-подключения. **Type:** string **Details:** #### public $clientIp : string --- ***Description*** IPv4 или IPv6-адрес пользователя. Если не указан, используется IP-адрес TCP-подключения. **Type:** string **Details:** #### public $description : string --- ***Description*** Описание транзакции (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь — при оплате. Например: «Оплата заказа № 72 для user@yoomoney.ru». **Type:** string **Details:** #### public $metadata : array --- ***Description*** Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. **Type:** array **Details:** #### public $receipt : \YooKassa\Model\Receipt\ReceiptInterface --- ***Description*** Данные для формирования чека. **Type:** ReceiptInterface **Details:** #### public $recipient : \YooKassa\Model\Payment\RecipientInterface --- ***Description*** Получатель платежа. Нужен, если вы разделяете потоки платежей в рамках одного аккаунта или создаете платеж в адрес другого аккаунта. **Type:** RecipientInterface **Details:** #### public $save_payment_method : bool --- ***Description*** Сохранение платежных данных для проведения [автоплатежей](https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments). **Type:** bool **Details:** #### public $savePaymentMethod : bool --- ***Description*** Сохранение платежных данных для проведения [автоплатежей](https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments). **Type:** bool **Details:** --- ## Methods #### public __construct() : mixed ```php public __construct(array|null $data = []) : mixed ``` **Summary** AbstractObject constructor. **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | array OR null | data | | **Returns:** mixed - #### public __get() : mixed ```php public __get(string $propertyName) : mixed ``` **Summary** Возвращает значение свойства. **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string | propertyName | Имя свойства | **Returns:** mixed - Значение свойства #### public __isset() : bool ```php public __isset(string $propertyName) : bool ``` **Summary** Проверяет наличие свойства. **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string | propertyName | Имя проверяемого свойства | **Returns:** bool - True если свойство имеется, false если нет #### public __set() : void ```php public __set(string $propertyName, mixed $value) : void ``` **Summary** Устанавливает значение свойства. **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string | propertyName | Имя свойства | | mixed | value | Значение свойства | **Returns:** void - #### public __unset() : void ```php public __unset(string $propertyName) : void ``` **Summary** Удаляет свойство. **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string | propertyName | Имя удаляемого свойства | **Returns:** void - #### public fromArray() : void ```php public fromArray(array|\Traversable $sourceArray) : void ``` **Summary** Устанавливает значения свойств текущего объекта из массива. **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | array OR \Traversable | sourceArray | Ассоциативный массив с настройками | **Returns:** void - #### public getAmount() : \YooKassa\Model\AmountInterface|null ```php public getAmount() : \YooKassa\Model\AmountInterface|null ``` **Summary** Возвращает amount. **Details:** * Inherited From: [\YooKassa\Request\Invoices\PaymentData](../classes/YooKassa-Request-Invoices-PaymentData.md) **Returns:** \YooKassa\Model\AmountInterface|null - Сумма платежа #### public getCapture() : bool|null ```php public getCapture() : bool|null ``` **Summary** Возвращает capture. **Details:** * Inherited From: [\YooKassa\Request\Invoices\PaymentData](../classes/YooKassa-Request-Invoices-PaymentData.md) **Returns:** bool|null - Автоматический прием поступившего платежа #### public getClientIp() : string|null ```php public getClientIp() : string|null ``` **Summary** Возвращает client_ip. **Details:** * Inherited From: [\YooKassa\Request\Invoices\PaymentData](../classes/YooKassa-Request-Invoices-PaymentData.md) **Returns:** string|null - IPv4 или IPv6-адрес пользователя #### public getDescription() : string|null ```php public getDescription() : string|null ``` **Summary** Возвращает description. **Details:** * Inherited From: [\YooKassa\Request\Invoices\PaymentData](../classes/YooKassa-Request-Invoices-PaymentData.md) **Returns:** string|null - Описание транзакции #### public getMetadata() : \YooKassa\Model\Metadata|null ```php public getMetadata() : \YooKassa\Model\Metadata|null ``` **Summary** Возвращает metadata. **Details:** * Inherited From: [\YooKassa\Request\Invoices\PaymentData](../classes/YooKassa-Request-Invoices-PaymentData.md) **Returns:** \YooKassa\Model\Metadata|null - Любые дополнительные данные #### public getReceipt() : \YooKassa\Model\Receipt\ReceiptInterface|null ```php public getReceipt() : \YooKassa\Model\Receipt\ReceiptInterface|null ``` **Summary** Возвращает receipt. **Details:** * Inherited From: [\YooKassa\Request\Invoices\PaymentData](../classes/YooKassa-Request-Invoices-PaymentData.md) **Returns:** \YooKassa\Model\Receipt\ReceiptInterface|null - Данные для формирования чека #### public getRecipient() : \YooKassa\Model\Payment\Recipient|null ```php public getRecipient() : \YooKassa\Model\Payment\Recipient|null ``` **Summary** Возвращает recipient. **Details:** * Inherited From: [\YooKassa\Request\Invoices\PaymentData](../classes/YooKassa-Request-Invoices-PaymentData.md) **Returns:** \YooKassa\Model\Payment\Recipient|null - Получатель платежа #### public getSavePaymentMethod() : bool|null ```php public getSavePaymentMethod() : bool|null ``` **Summary** Возвращает save_payment_method. **Details:** * Inherited From: [\YooKassa\Request\Invoices\PaymentData](../classes/YooKassa-Request-Invoices-PaymentData.md) **Returns:** bool|null - Сохранение платежных данных для проведения автоплатежей #### public getValidator() : \YooKassa\Validator\Validator ```php public getValidator() : \YooKassa\Validator\Validator ``` **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) **Returns:** \YooKassa\Validator\Validator - #### public jsonSerialize() : array ```php public jsonSerialize() : array ``` **Summary** Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации. **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) **Returns:** array - Ассоциативный массив со свойствами текущего объекта #### public offsetExists() : bool ```php public offsetExists(string $offset) : bool ``` **Summary** Проверяет наличие свойства. **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string | offset | Имя проверяемого свойства | **Returns:** bool - True если свойство имеется, false если нет #### public offsetGet() : mixed ```php public offsetGet(string $offset) : mixed ``` **Summary** Возвращает значение свойства. **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string | offset | Имя свойства | **Returns:** mixed - Значение свойства #### public offsetSet() : void ```php public offsetSet(string $offset, mixed $value) : void ``` **Summary** Устанавливает значение свойства. **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string | offset | Имя свойства | | mixed | value | Значение свойства | **Returns:** void - #### public offsetUnset() : void ```php public offsetUnset(string $offset) : void ``` **Summary** Удаляет свойство. **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string | offset | Имя удаляемого свойства | **Returns:** void - #### public setAmount() : self ```php public setAmount(\YooKassa\Model\AmountInterface|array|null $amount = null) : self ``` **Summary** Устанавливает amount. **Details:** * Inherited From: [\YooKassa\Request\Invoices\PaymentData](../classes/YooKassa-Request-Invoices-PaymentData.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | \YooKassa\Model\AmountInterface OR array OR null | amount | Сумма платежа | **Returns:** self - #### public setCapture() : self ```php public setCapture(bool|array|null $capture = null) : self ``` **Summary** Устанавливает capture. **Details:** * Inherited From: [\YooKassa\Request\Invoices\PaymentData](../classes/YooKassa-Request-Invoices-PaymentData.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | bool OR array OR null | capture | Автоматический прием поступившего платежа | **Returns:** self - #### public setClientIp() : self ```php public setClientIp(string|null $client_ip = null) : self ``` **Summary** Устанавливает client_ip. **Details:** * Inherited From: [\YooKassa\Request\Invoices\PaymentData](../classes/YooKassa-Request-Invoices-PaymentData.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string OR null | client_ip | IPv4 или IPv6-адрес пользователя | **Returns:** self - #### public setDescription() : self ```php public setDescription(string|null $description = null) : self ``` **Summary** Устанавливает description. **Details:** * Inherited From: [\YooKassa\Request\Invoices\PaymentData](../classes/YooKassa-Request-Invoices-PaymentData.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string OR null | description | Описание транзакции | **Returns:** self - #### public setMetadata() : self ```php public setMetadata(\YooKassa\Model\Metadata|array|null $metadata = null) : self ``` **Summary** Устанавливает metadata. **Details:** * Inherited From: [\YooKassa\Request\Invoices\PaymentData](../classes/YooKassa-Request-Invoices-PaymentData.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | \YooKassa\Model\Metadata OR array OR null | metadata | Любые дополнительные данные | **Returns:** self - #### public setReceipt() : self ```php public setReceipt(\YooKassa\Model\Receipt\ReceiptInterface|array|null $receipt = null) : self ``` **Summary** Устанавливает receipt. **Details:** * Inherited From: [\YooKassa\Request\Invoices\PaymentData](../classes/YooKassa-Request-Invoices-PaymentData.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | \YooKassa\Model\Receipt\ReceiptInterface OR array OR null | receipt | Данные для формирования чека | **Returns:** self - #### public setRecipient() : self ```php public setRecipient(\YooKassa\Model\Payment\Recipient|array|null $recipient = null) : self ``` **Summary** Устанавливает recipient. **Details:** * Inherited From: [\YooKassa\Request\Invoices\PaymentData](../classes/YooKassa-Request-Invoices-PaymentData.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | \YooKassa\Model\Payment\Recipient OR array OR null | recipient | Получатель платежа | **Returns:** self - #### public setSavePaymentMethod() : self ```php public setSavePaymentMethod(bool|array|null $save_payment_method = null) : self ``` **Summary** Устанавливает save_payment_method. **Details:** * Inherited From: [\YooKassa\Request\Invoices\PaymentData](../classes/YooKassa-Request-Invoices-PaymentData.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | bool OR array OR null | save_payment_method | Сохранение платежных данных для проведения автоплатежей | **Returns:** self - #### public toArray() : array ```php public toArray() : array ``` **Summary** Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize(). **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) **Returns:** array - Ассоциативный массив со свойствами текущего объекта #### protected getUnknownProperties() : array ```php protected getUnknownProperties() : array ``` **Summary** Возвращает массив свойств которые не существуют, но были заданы у объекта. **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) **Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами #### protected validatePropertyValue() : mixed ```php protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed ``` **Details:** * Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) ##### Parameters: | Type | Name | Description | | ---- | ---- | ----------- | | string | propertyName | | | mixed | propertyValue | | **Returns:** mixed - --- ### Top Namespaces * [\YooKassa](../namespaces/yookassa.md) --- ### Reports * [Errors - 0](../reports/errors.md) * [Markers - 0](../reports/markers.md) * [Deprecated - 43](../reports/deprecated.md) --- This document was automatically generated from source code comments on 2026-08-13 using [phpDocumentor](http://www.phpdoc.org/) © 2026 YooMoney