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

36 KiB
Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Request\PersonalData\PersonalDataType\SbpPayoutRecipientPersonalDataRequest

Namespace: \YooKassa\Request\PersonalData\PersonalDataType

Summary:

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

Constants

Visibility Name Flag Summary
public MAX_LENGTH_LAST_NAME Максимальная длина строки фамилии или отчества
public MAX_LENGTH_FIRST_NAME Максимальная длина строки имени

Properties

Visibility Name Flag Summary
public $first_name Имя пользователя.
public $firstName Имя пользователя.
public $last_name Фамилия пользователя.
public $lastName Фамилия пользователя.
public $metadata Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа).
public $metadata Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа).
public $middle_name Отчество пользователя. Обязательный параметр, если есть в паспорте.
public $middleName Отчество пользователя. Обязательный параметр, если есть в паспорте.
public $type Значение — sbp_payout_recipient. Тип персональных данных.
public $type Тип персональных данных.
protected $_metadata Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа).
protected $_type Тип персональных данных — цель, для которой вы будете использовать данные

Methods

Visibility Name Flag Summary
public __construct()
public __get() Возвращает значение свойства.
public __isset() Проверяет наличие свойства.
public __set() Устанавливает значение свойства.
public __unset() Удаляет свойство.
public builder() Возвращает билдер объектов запросов создания платежа.
public clearValidationError() Очищает статус валидации текущего запроса.
public fromArray() Устанавливает значения свойств текущего объекта из массива.
public getFirstName() Возвращает first_name.
public getLastName() Возвращает last_name.
public getLastValidationError() Возвращает последнюю ошибку валидации.
public getMetadata() Возвращает metadata.
public getMiddleName() Возвращает middle_name.
public getType() Возвращает type.
public getValidator()
public hasFirstName() Проверяет наличие имени пользователя в запросе.
public hasLastName() Проверяет наличие фамилии пользователя в запросе.
public hasMetadata() Проверяет, были ли установлены метаданные.
public hasMiddleName() Проверяет наличие отчества пользователя в запросе.
public hasType() Проверяет наличие типа персональных данных в запросе.
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public setFirstName() Устанавливает first_name.
public setLastName() Устанавливает last_name.
public setMetadata() Устанавливает metadata.
public setMiddleName() Устанавливает middle_name.
public setType() Устанавливает type.
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
public validate() Проверяет на валидность текущий объект
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected setValidationError() Устанавливает ошибку валидации.
protected validatePropertyValue()

Details

Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Constants

MAX_LENGTH_LAST_NAME

Inherited from \YooKassa\Request\PersonalData\PersonalDataType\AbstractPersonalDataRequest

Максимальная длина строки фамилии или отчества

MAX_LENGTH_LAST_NAME = 200

MAX_LENGTH_FIRST_NAME

Inherited from \YooKassa\Request\PersonalData\PersonalDataType\AbstractPersonalDataRequest

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

MAX_LENGTH_FIRST_NAME = 100

Properties

public $first_name : string

Description

Имя пользователя.

Type: string

Details:

public $firstName : string

Description

Имя пользователя.

Type: string

Details:

public $last_name : string

Description

Фамилия пользователя.

Type: string

Details:

public $lastName : string

Description

Фамилия пользователя.

Type: string

Details:

public $metadata : \YooKassa\Model\Metadata|null

Description

Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа).

Type: Metadata|null

Details:

public $metadata : \YooKassa\Model\Metadata

Description

Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа).

Type: Metadata

Details:

public $middle_name : string|null

Description

Отчество пользователя. Обязательный параметр, если есть в паспорте.

Type: string|null

Details:

public $middleName : string|null

Description

Отчество пользователя. Обязательный параметр, если есть в паспорте.

Type: string|null

Details:

public $type : string

Description

Значение — sbp_payout_recipient. Тип персональных данных.

Type: string

Details:

public $type : string

Description

Тип персональных данных.

Type: string

Details:

protected $_metadata : ?\YooKassa\Model\Metadata

Summary

Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа).

Description

Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.

Type: Metadata

Details:

protected $_type : ?string

Summary

Тип персональных данных — цель, для которой вы будете использовать данные

Type: ?string

Details:

Methods

public __construct() : mixed

public __construct(?array $data = []) : mixed

Details:

Parameters:
Type Name Description
?array 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 builder() : \YooKassa\Request\PersonalData\CreateSbpPayoutRecipientPersonalDataRequestBuilder

Static public builder() : \YooKassa\Request\PersonalData\CreateSbpPayoutRecipientPersonalDataRequestBuilder

Summary

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

Details:

Returns: \YooKassa\Request\PersonalData\CreateSbpPayoutRecipientPersonalDataRequestBuilder - Инстанс билдера объектов запросов

public clearValidationError() : void

public clearValidationError() : void

Summary

Очищает статус валидации текущего запроса.

Details:

Returns: void -

public fromArray() : void

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

Summary

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

Details:

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

Returns: void -

public getFirstName() : string|null

public getFirstName() : string|null

Summary

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

Details:

Returns: string|null -

public getLastName() : string|null

public getLastName() : string|null

Summary

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

Details:

Returns: string|null -

public getLastValidationError() : string|null

public getLastValidationError() : string|null

Summary

Возвращает последнюю ошибку валидации.

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

public getMiddleName() : string|null

Summary

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

Details:

Returns: string|null -

public getType() : string|null

public getType() : string|null

Summary

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

Details:

Returns: string|null -

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

public hasFirstName() : bool

public hasFirstName() : bool

Summary

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

Details:

Returns: bool - True если имя пользователя задано, false если нет

public hasLastName() : bool

public hasLastName() : bool

Summary

Проверяет наличие фамилии пользователя в запросе.

Details:

Returns: bool - True если фамилия пользователя задана, false если нет

public hasMetadata() : bool

public hasMetadata() : bool

Summary

Проверяет, были ли установлены метаданные.

Details:

Returns: bool - True если метаданные были установлены, false если нет

public hasMiddleName() : bool

public hasMiddleName() : bool

Summary

Проверяет наличие отчества пользователя в запросе.

Details:

Returns: bool - True если отчество пользователя задано, false если нет

public hasType() : bool

public hasType() : bool

Summary

Проверяет наличие типа персональных данных в запросе.

Details:

Returns: bool - True если тип персональных данных задан, false если нет

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

public setFirstName(string|null $first_name = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null first_name Имя пользователя.

Returns: self -

public setLastName() : self

public setLastName(string|null $last_name = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null last_name Фамилия пользователя.

Returns: self -

public setMetadata() : self

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\Metadata OR array OR null value Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.

Returns: self -

public setMiddleName() : self

public setMiddleName(string|null $middle_name = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null middle_name Отчество пользователя. Обязательный параметр, если есть в паспорте.

Returns: self -

public setType() : self

public setType(string|null $type = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null type

Returns: self -

public toArray() : array

public toArray() : array

Summary

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

Details:

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

public validate() : bool

public validate() : bool

Summary

Проверяет на валидность текущий объект

Details:

Returns: bool - True если объект запроса валиден, false если нет

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

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

protected setValidationError() : void

protected setValidationError(string $value) : void

Summary

Устанавливает ошибку валидации.

Details:

Parameters:
Type Name Description
string value Ошибка, произошедшая при валидации объекта

Returns: void -

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