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

29 KiB
Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Request\Invoices\PaymentData

Namespace: \YooKassa\Request\Invoices

Summary:

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

Description:

Данные для проведения платежа по выставленному счету.

Constants

  • No constants found

Properties

Visibility Name Flag Summary
public $amount Сумма платежа. Должна укладываться в лимиты.
public $capture Автоматический прием поступившего платежа.
public $client_ip IPv4 или IPv6-адрес пользователя. Если не указан, используется IP-адрес TCP-подключения.
public $clientIp IPv4 или IPv6-адрес пользователя. Если не указан, используется IP-адрес TCP-подключения.
public $description Описание транзакции (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь — при оплате. Например: «Оплата заказа № 72 для user@yoomoney.ru».
public $metadata Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa.
public $receipt Данные для формирования чека.
public $recipient Получатель платежа. Нужен, если вы разделяете потоки платежей в рамках одного аккаунта или создаете платеж в адрес другого аккаунта.
public $save_payment_method Сохранение платежных данных для проведения автоплатежей.
public $savePaymentMethod Сохранение платежных данных для проведения автоплатежей.

Methods

Visibility Name Flag Summary
public __construct() AbstractObject constructor.
public __get() Возвращает значение свойства.
public __isset() Проверяет наличие свойства.
public __set() Устанавливает значение свойства.
public __unset() Удаляет свойство.
public fromArray() Устанавливает значения свойств текущего объекта из массива.
public getAmount() Возвращает amount.
public getCapture() Возвращает capture.
public getClientIp() Возвращает client_ip.
public getDescription() Возвращает description.
public getMetadata() Возвращает metadata.
public getReceipt() Возвращает receipt.
public getRecipient() Возвращает recipient.
public getSavePaymentMethod() Возвращает save_payment_method.
public getValidator()
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public setAmount() Устанавливает amount.
public setCapture() Устанавливает capture.
public setClientIp() Устанавливает client_ip.
public setDescription() Устанавливает description.
public setMetadata() Устанавливает metadata.
public setReceipt() Устанавливает receipt.
public setRecipient() Устанавливает recipient.
public setSavePaymentMethod() Устанавливает save_payment_method.
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 $capture : bool

Description

Автоматический прием поступившего платежа.

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

Сохранение платежных данных для проведения автоплатежей.

Type: bool

Details:

public $savePaymentMethod : bool

Description

Сохранение платежных данных для проведения автоплатежей.

Type: bool

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

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

Details:

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

public getCapture() : bool|null

public getCapture() : bool|null

Summary

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

Details:

Returns: bool|null - Автоматический прием поступившего платежа

public getClientIp() : string|null

public getClientIp() : string|null

Summary

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

Details:

Returns: string|null - IPv4 или IPv6-адрес пользователя

public getDescription() : string|null

public getDescription() : string|null

Summary

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

Details:

Returns: string|null - Описание транзакции

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

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

Summary

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

Details:

Returns: \YooKassa\Model\Metadata|null - Любые дополнительные данные

public getReceipt() : \YooKassa\Model\Receipt\ReceiptInterface|null

public getReceipt() : \YooKassa\Model\Receipt\ReceiptInterface|null

Summary

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

Details:

Returns: \YooKassa\Model\Receipt\ReceiptInterface|null - Данные для формирования чека

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

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

Summary

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

Details:

Returns: \YooKassa\Model\Payment\Recipient|null - Получатель платежа

public getSavePaymentMethod() : bool|null

public getSavePaymentMethod() : bool|null

Summary

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

Details:

Returns: bool|null - Сохранение платежных данных для проведения автоплатежей

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

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

Details:

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

Returns: self -

public setCapture() : self

public setCapture(bool|array|null $capture = null) : self

Summary

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

Details:

Parameters:
Type Name Description
bool OR array OR null capture Автоматический прием поступившего платежа

Returns: self -

public setClientIp() : self

public setClientIp(string|null $client_ip = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null client_ip IPv4 или IPv6-адрес пользователя

Returns: self -

public setDescription() : self

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

Summary

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

Details:

Parameters:
Type Name Description
string OR null description Описание транзакции

Returns: self -

public setMetadata() : self

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\Metadata OR array OR null metadata Любые дополнительные данные

Returns: self -

public setReceipt() : self

public setReceipt(\YooKassa\Model\Receipt\ReceiptInterface|array|null $receipt = null) : self

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\Receipt\ReceiptInterface OR array OR null receipt Данные для формирования чека

Returns: self -

public setRecipient() : self

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\Payment\Recipient OR array OR null recipient Получатель платежа

Returns: self -

public setSavePaymentMethod() : self

public setSavePaymentMethod(bool|array|null $save_payment_method = null) : self

Summary

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

Details:

Parameters:
Type Name Description
bool OR array OR null save_payment_method Сохранение платежных данных для проведения автоплатежей

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