Добавлены нулевые привязки по СБП Добавлена причина отмены возвратов `payment_expired`
36 KiB
YooKassa API SDK
Class: \YooKassa\Request\PersonalData\PersonalDataResponse
Namespace: \YooKassa\Request\PersonalData
Summary:
Класс, представляющий модель PersonalDataResponse.
Description:
Информация о персональных данных
Constants
- No constants found
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | $cancellation_details | Комментарий к отмене выплаты | |
| public | $cancellationDetails | Комментарий к отмене выплаты | |
| public | $created_at | Время создания персональных данных | |
| public | $createdAt | Время создания персональных данных | |
| public | $expires_at | Срок жизни объекта персональных данных | |
| public | $expiresAt | Срок жизни объекта персональных данных | |
| public | $id | Идентификатор персональных данных | |
| public | $metadata | Метаданные выплаты указанные мерчантом | |
| public | $status | Текущий статус персональных данных | |
| public | $type | Тип персональных данных | |
| protected | $_cancellation_details | Комментарий к статусу canceled: кто и по какой причине аннулировал хранение данных. | |
| protected | $_created_at | Время создания персональных данных. | |
| protected | $_expires_at | Срок жизни объекта персональных данных — время, до которого вы можете использовать персональные данные при проведении операций. | |
| protected | $_id | Идентификатор персональных данных, сохраненных в ЮKassa. | |
| protected | $_metadata | Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). | |
| protected | $_status | Статус персональных данных. | |
| protected | $_type | Тип персональных данных — цель, для которой вы будете использовать данные. |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | AbstractObject constructor. | |
| public | __get() | Возвращает значение свойства. | |
| public | __isset() | Проверяет наличие свойства. | |
| public | __set() | Устанавливает значение свойства. | |
| public | __unset() | Удаляет свойство. | |
| public | fromArray() | Устанавливает значения свойств текущего объекта из массива. | |
| public | getCancellationDetails() | Возвращает комментарий к статусу canceled: кто и по какой причине аннулировал хранение данных. | |
| public | getCreatedAt() | Возвращает время создания персональных данных. | |
| public | getExpiresAt() | Возвращает срок жизни объекта персональных данных. | |
| public | getId() | Возвращает идентификатор персональных данных, сохраненных в ЮKassa. | |
| public | getMetadata() | Возвращает любые дополнительные данные. | |
| public | getStatus() | Возвращает статус персональных данных. | |
| public | getType() | Возвращает тип персональных данных. | |
| public | getValidator() | ||
| public | jsonSerialize() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации. | |
| public | offsetExists() | Проверяет наличие свойства. | |
| public | offsetGet() | Возвращает значение свойства. | |
| public | offsetSet() | Устанавливает значение свойства. | |
| public | offsetUnset() | Удаляет свойство. | |
| public | setCancellationDetails() | Устанавливает Комментарий к статусу canceled: кто и по какой причине аннулировал хранение данных. | |
| public | setCreatedAt() | Устанавливает время создания персональных данных. | |
| public | setExpiresAt() | Устанавливает срок жизни объекта персональных данных. | |
| public | setId() | Устанавливает идентификатор персональных данных, сохраненных в ЮKassa. | |
| public | setMetadata() | Устанавливает любые дополнительные данные. | |
| public | setStatus() | Устанавливает статус персональных данных. | |
| public | setType() | Устанавливает тип персональных данных. | |
| public | toArray() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize(). | |
| protected | getUnknownProperties() | Возвращает массив свойств которые не существуют, но были заданы у объекта. | |
| protected | validatePropertyValue() |
Details
-
Package: YooKassa\Request
-
Class Hierarchy:
- \YooKassa\Common\AbstractObject
- \YooKassa\Model\PersonalData\PersonalData
- \YooKassa\Request\PersonalData\PersonalDataResponse
-
See Also:
Tags
| Tag | Version | Description |
|---|---|---|
| category | Class | |
| author | cms@yoomoney.ru |
Properties
public $cancellation_details : \YooKassa\Model\PersonalData\PersonalDataCancellationDetails
Description
Комментарий к отмене выплаты
Type: PersonalDataCancellationDetails
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
public $cancellationDetails : \YooKassa\Model\PersonalData\PersonalDataCancellationDetails
Description
Комментарий к отмене выплаты
Type: PersonalDataCancellationDetails
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
public $created_at : \DateTime
Description
Время создания персональных данных
Type: \DateTime
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
public $createdAt : \DateTime
Description
Время создания персональных данных
Type: \DateTime
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
public $expires_at : null|\DateTime
Description
Срок жизни объекта персональных данных
Type: DateTime
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
public $expiresAt : null|\DateTime
Description
Срок жизни объекта персональных данных
Type: DateTime
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
public $id : string
Description
Идентификатор персональных данных
Type: string
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
public $metadata : \YooKassa\Model\Metadata
Description
Метаданные выплаты указанные мерчантом
Type: Metadata
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
public $status : string
Description
Текущий статус персональных данных
Type: string
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
public $type : string
Description
Тип персональных данных
Type: string
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
protected $_cancellation_details : ?\YooKassa\Model\PersonalData\PersonalDataCancellationDetails
Summary
Комментарий к статусу canceled: кто и по какой причине аннулировал хранение данных.
Type: PersonalDataCancellationDetails
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
protected $_created_at : ?\DateTime
Summary
Время создания персональных данных.
Description
Указывается по UTC и передается в формате ISO 8601.
Пример: ~2017-11-03T11:52:31.827Z
Type: DateTime
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
protected $_expires_at : ?\DateTime
Summary
Срок жизни объекта персональных данных — время, до которого вы можете использовать персональные данные при проведении операций.
Description
Указывается только для объекта в статусе ~active. Указывается по UTC
и передается в формате ISO 8601.
Пример: ~2017-11-03T11:52:31.827Z
Type: DateTime
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
protected $_id : ?string
Summary
Идентификатор персональных данных, сохраненных в ЮKassa.
Type: ?string
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
protected $_metadata : ?\YooKassa\Model\Metadata
Summary
Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа).
Description
Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.
Type: Metadata
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
protected $_status : ?string
Summary
Статус персональных данных.
Description
Возможные значения:
waiting_for_operation— данные сохранены, но не использованы при проведении выплаты;active— данные сохранены и использованы при проведении выплаты; данные можно использовать повторно до срока, указанного в параметреexpires_at;canceled— хранение данных отменено, данные удалены, инициатор и причина отмены указаны в объектеcancellation_details(финальный и неизменяемый статус).
Жизненный цикл персональных данных зависит от назначения данных: передача данных получателя выплаты для выписки из реестра или проверка получателя при выплатах через СБП.
Type: ?string
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
protected $_type : ?string
Summary
Тип персональных данных — цель, для которой вы будете использовать данные.
Description
Возможные значение:
sbp_payout_recipient— выплаты с проверкой получателя(только для выплат через СБП);payout_statement_recipient— выплаты с передачей данных получателя выплаты для выписок из реестра.
Type: ?string
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Methods
public __construct() : mixed
public __construct(array|null $data = []) : mixed
Summary
AbstractObject constructor.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
array OR null |
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() : void
public __set(string $propertyName, mixed $value) : void
Summary
Устанавливает значение свойства.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | Имя свойства |
mixed |
value | Значение свойства |
Returns: void -
public __unset() : void
public __unset(string $propertyName) : void
Summary
Удаляет свойство.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | Имя удаляемого свойства |
Returns: void -
public fromArray() : void
public fromArray(array|\Traversable $sourceArray) : void
Summary
Устанавливает значения свойств текущего объекта из массива.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
array OR \Traversable |
sourceArray | Ассоциативный массив с настройками |
Returns: void -
public getCancellationDetails() : \YooKassa\Model\PersonalData\PersonalDataCancellationDetails|null
public getCancellationDetails() : \YooKassa\Model\PersonalData\PersonalDataCancellationDetails|null
Summary
Возвращает комментарий к статусу canceled: кто и по какой причине аннулировал хранение данных.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Returns: \YooKassa\Model\PersonalData\PersonalDataCancellationDetails|null - Комментарий к статусу canceled
public getCreatedAt() : \DateTime|null
public getCreatedAt() : \DateTime|null
Summary
Возвращает время создания персональных данных.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Returns: \DateTime|null - Время создания персональных данных
public getExpiresAt() : \DateTime|null
public getExpiresAt() : \DateTime|null
Summary
Возвращает срок жизни объекта персональных данных.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Returns: \DateTime|null - Срок жизни объекта персональных данных
public getId() : string|null
public getId() : string|null
Summary
Возвращает идентификатор персональных данных, сохраненных в ЮKassa.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Returns: string|null -
public getMetadata() : \YooKassa\Model\Metadata|null
public getMetadata() : \YooKassa\Model\Metadata|null
Summary
Возвращает любые дополнительные данные.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Returns: \YooKassa\Model\Metadata|null - Любые дополнительные данные
public getStatus() : string|null
public getStatus() : string|null
Summary
Возвращает статус персональных данных.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Returns: string|null - Статус персональных данных
public getType() : string|null
public getType() : string|null
Summary
Возвращает тип персональных данных.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Returns: string|null - Тип персональных данных
public getValidator() : \YooKassa\Validator\Validator
public getValidator() : \YooKassa\Validator\Validator
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: \YooKassa\Validator\Validator -
public jsonSerialize() : array
public jsonSerialize() : array
Summary
Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: array - Ассоциативный массив со свойствами текущего объекта
public offsetExists() : bool
public offsetExists(string $offset) : bool
Summary
Проверяет наличие свойства.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
offset | Имя проверяемого свойства |
Returns: bool - True если свойство имеется, false если нет
public offsetGet() : mixed
public offsetGet(string $offset) : mixed
Summary
Возвращает значение свойства.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
offset | Имя свойства |
Returns: mixed - Значение свойства
public offsetSet() : void
public offsetSet(string $offset, mixed $value) : void
Summary
Устанавливает значение свойства.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
offset | Имя свойства |
mixed |
value | Значение свойства |
Returns: void -
public offsetUnset() : void
public offsetUnset(string $offset) : void
Summary
Удаляет свойство.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
offset | Имя удаляемого свойства |
Returns: void -
public setCancellationDetails() : self
public setCancellationDetails(\YooKassa\Model\PersonalData\PersonalDataCancellationDetails|array|null $cancellation_details = null) : self
Summary
Устанавливает Комментарий к статусу canceled: кто и по какой причине аннулировал хранение данных.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\PersonalData\PersonalDataCancellationDetails OR array OR null |
cancellation_details | Комментарий к статусу canceled |
Returns: self -
public setCreatedAt() : self
public setCreatedAt(\DateTime|string|null $created_at = null) : self
Summary
Устанавливает время создания персональных данных.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR null |
created_at | Время создания персональных данных. |
Returns: self -
public setExpiresAt() : self
public setExpiresAt(\DateTime|string|null $expires_at = null) : self
Summary
Устанавливает срок жизни объекта персональных данных.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR null |
expires_at | Срок жизни объекта персональных данных |
Returns: self -
public setId() : self
public setId(string|null $id = null) : self
Summary
Устанавливает идентификатор персональных данных, сохраненных в ЮKassa.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
id | Идентификатор персональных данных, сохраненных в ЮKassa. |
Returns: self -
public setMetadata() : self
public setMetadata(\YooKassa\Model\Metadata|array|null $metadata = null) : self
Summary
Устанавливает любые дополнительные данные.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\Metadata OR array OR null |
metadata | Любые дополнительные данные |
Returns: self -
public setStatus() : $this
public setStatus(string|null $status = null) : $this
Summary
Устанавливает статус персональных данных.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
status | Статус персональных данных |
Returns: $this -
public setType() : self
public setType(?string $type = null) : self
Summary
Устанавливает тип персональных данных.
Details:
- Inherited From: \YooKassa\Model\PersonalData\PersonalData
Parameters:
| Type | Name | Description |
|---|---|---|
?string |
type | Тип персональных данных |
Returns: self -
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 - Ассоциативный массив с не существующими у текущего объекта свойствами
protected validatePropertyValue() : mixed
protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed
Details:
- Inherited From: \YooKassa\Common\AbstractObject
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