Добавлены нулевые привязки по СБП Добавлена причина отмены возвратов `payment_expired`
12 KiB
YooKassa API SDK
Class: \YooKassa\Request\PersonalData\CreatePayoutStatementRecipientPersonalDataRequestBuilder
Namespace: \YooKassa\Request\PersonalData
Summary:
Класс, представляющий модель CreatePayoutStatementRecipientPersonalDataRequestBuilder.
Description:
Класс билдера объектов запросов к API на создание платежа.
Examples
Пример использования билдера
try {
$personalDataBuilder = \YooKassa\Request\PersonalData\PersonalDataType\SbpPayoutRecipientPersonalDataRequest::builder();
$personalDataBuilder
->setFirstName('Иван')
->setLastName('Иванов')
->setMiddleName('Иванович')
->setMetadata(['recipient_id' => '37'])
;
// Создаем объект запроса
$request = $personalDataBuilder->build();
$idempotenceKey = uniqid('', true);
$response = $client->createPersonalData($request, $idempotenceKey);
} catch (Exception $e) {
$response = $e;
}
var_dump($response);
Constants
- No constants found
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| protected | $currentObject | Собираемый объект запроса. |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать. | |
| public | build() | Строит и возвращает объект запроса для отправки в API ЮKassa. | |
| public | setBirthdate() | Устанавливает дату рождения. | |
| public | setFirstName() | Устанавливает имя пользователя. | |
| public | setLastName() | Устанавливает фамилию пользователя. | |
| public | setMetadata() | Устанавливает метаданные, привязанные к платежу. | |
| public | setMiddleName() | Устанавливает отчество пользователя. | |
| public | setOptions() | Устанавливает свойства запроса из массива. | |
| protected | initCurrentObject() | Инициализирует объект запроса, который в дальнейшем будет собираться билдером |
Details
-
File: lib/Request/PersonalData/CreatePayoutStatementRecipientPersonalDataRequestBuilder.php
-
Package: YooKassa\Request
-
Class Hierarchy:
- \YooKassa\Common\AbstractRequestBuilder
- \YooKassa\Request\PersonalData\CreatePayoutStatementRecipientPersonalDataRequestBuilder
-
See Also:
Tags
| Tag | Version | Description |
|---|---|---|
| category | Class | |
| author | cms@yoomoney.ru |
Properties
protected $currentObject : ?\YooKassa\Common\AbstractRequestInterface
Summary
Собираемый объект запроса.
Type: AbstractRequestInterface
Details:
Methods
public __construct() : mixed
public __construct() : mixed
Summary
Конструктор, инициализирует пустой запрос, который в будущем начнём собирать.
Details:
- Inherited From: \YooKassa\Common\AbstractRequestBuilder
Returns: mixed -
public build() : \YooKassa\Common\AbstractRequestInterface|\YooKassa\Request\PersonalData\PersonalDataType\PayoutStatementRecipientPersonalDataRequest
public build(null|array $options = null) : \YooKassa\Common\AbstractRequestInterface|\YooKassa\Request\PersonalData\PersonalDataType\PayoutStatementRecipientPersonalDataRequest
Summary
Строит и возвращает объект запроса для отправки в API ЮKassa.
Details:
- Inherited From: \YooKassa\Request\PersonalData\CreatePayoutStatementRecipientPersonalDataRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
null OR array |
options | Массив параметров для установки в объект запроса |
Returns: \YooKassa\Common\AbstractRequestInterface|\YooKassa\Request\PersonalData\PersonalDataType\PayoutStatementRecipientPersonalDataRequest - Инстанс объекта запроса
public setBirthdate() : self
public setBirthdate(\DateTime|string|null $value = null) : self
Summary
Устанавливает дату рождения.
Details:
- Inherited From: \YooKassa\Request\PersonalData\CreatePayoutStatementRecipientPersonalDataRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR null |
value | Дата рождения. Передается в формате ISO 8601 |
Returns: self - Инстанс текущего билдера
public setFirstName() : self
public setFirstName(string $value) : self
Summary
Устанавливает имя пользователя.
Details:
- Inherited From: \YooKassa\Request\PersonalData\CreatePayoutStatementRecipientPersonalDataRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | имя пользователя |
Returns: self -
public setLastName() : self
public setLastName(string $value) : self
Summary
Устанавливает фамилию пользователя.
Details:
- Inherited From: \YooKassa\Request\PersonalData\CreatePayoutStatementRecipientPersonalDataRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | фамилия пользователя |
Returns: self -
public setMetadata() : self
public setMetadata(null|array|\YooKassa\Model\Metadata $value) : self
Summary
Устанавливает метаданные, привязанные к платежу.
Details:
- Inherited From: \YooKassa\Request\PersonalData\CreatePayoutStatementRecipientPersonalDataRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
null OR array OR \YooKassa\Model\Metadata |
value | Метаданные платежа, устанавливаемые мерчантом |
Returns: self - Инстанс текущего билдера
public setMiddleName() : self
public setMiddleName(null|string $value) : self
Summary
Устанавливает отчество пользователя.
Details:
- Inherited From: \YooKassa\Request\PersonalData\CreatePayoutStatementRecipientPersonalDataRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
null OR string |
value | Отчество пользователя |
Returns: self -
public setOptions() : \YooKassa\Common\AbstractRequestBuilder
public setOptions(iterable|null $options) : \YooKassa\Common\AbstractRequestBuilder
Summary
Устанавливает свойства запроса из массива.
Details:
- Inherited From: \YooKassa\Common\AbstractRequestBuilder
Parameters:
| Type | Name | Description |
|---|---|---|
iterable OR null |
options | Массив свойств запроса |
Throws:
| Type | Description |
|---|---|
| \InvalidArgumentException | Выбрасывается если аргумент не массив и не итерируемый объект |
| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданных в массиве настроек |
Returns: \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов
protected initCurrentObject() : \YooKassa\Request\PersonalData\PersonalDataType\PayoutStatementRecipientPersonalDataRequest
protected initCurrentObject() : \YooKassa\Request\PersonalData\PersonalDataType\PayoutStatementRecipientPersonalDataRequest
Summary
Инициализирует объект запроса, который в дальнейшем будет собираться билдером
Details:
- Inherited From: \YooKassa\Request\PersonalData\CreatePayoutStatementRecipientPersonalDataRequestBuilder
Returns: \YooKassa\Request\PersonalData\PersonalDataType\PayoutStatementRecipientPersonalDataRequest - Инстанс собираемого объекта запроса к API
Top Namespaces
Reports
This document was automatically generated from source code comments on 2026-06-29 using phpDocumentor
© 2026 YooMoney