yookassa-sdk-php/docs/classes/YooKassa-Request-PersonalData-CreatePersonalDataRequestBuilder.md

YooKassa API SDK

Class: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder

Namespace: \YooKassa\Request\PersonalData

---

Summary:

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

Description:

Класс билдера объектов запросов к API на создание платежа.

---

Examples

Пример использования билдера

try {
    $personalDataBuilder = \YooKassa\Request\PersonalData\CreatePersonalDataRequest::builder();
    $personalDataBuilder
        ->setType(\YooKassa\Model\PersonalData\PersonalDataType::SBP_PAYOUT_RECIPIENT)
        ->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	setFirstName()		Устанавливает имя пользователя.
public	setLastName()		Устанавливает фамилию пользователя.
public	setMetadata()		Устанавливает метаданные, привязанные к платежу.
public	setMiddleName()		Устанавливает отчество пользователя.
public	setOptions()		Устанавливает свойства запроса из массива.
public	setType()		Устанавливает тип персональных данных.
protected	initCurrentObject()		Инициализирует объект запроса, который в дальнейшем будет собираться билдером

---

Details

• File: lib/Request/PersonalData/CreatePersonalDataRequestBuilder.php

• Package: YooKassa\Request

• Class Hierarchy:

  • \YooKassa\Common\AbstractRequestBuilder
  • \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder

• 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\Request\PersonalData\CreatePersonalDataRequestInterface|\YooKassa\Common\AbstractRequestInterface

public build(null|array $options = null) : \YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface|\YooKassa\Common\AbstractRequestInterface

Summary

Строит и возвращает объект запроса для отправки в API ЮKassa.

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder

Parameters:

Type	Name	Description
null OR array	options	Массив параметров для установки в объект запроса

Returns: \YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface|\YooKassa\Common\AbstractRequestInterface - Инстанс объекта запроса

public setFirstName() : self

public setFirstName(string $value) : self

Summary

Устанавливает имя пользователя.

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder

Parameters:

Type	Name	Description
string	value	имя пользователя

Returns: self -

public setLastName() : self

public setLastName(string $value) : self

Summary

Устанавливает фамилию пользователя.

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder

Parameters:

Type	Name	Description
string	value	фамилия пользователя

Returns: self -

public setMetadata() : \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder

public setMetadata(null|array|\YooKassa\Model\Metadata $value) : \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder

Summary

Устанавливает метаданные, привязанные к платежу.

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder

Parameters:

Type	Name	Description
null OR array OR \YooKassa\Model\Metadata	value	Метаданные платежа, устанавливаемые мерчантом

Returns: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder - Инстанс текущего билдера

public setMiddleName() : self

public setMiddleName(null|string $value) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder

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 - Инстанс текущего билдера запросов

public setType() : self

public setType(string $value) : self

Summary

Устанавливает тип персональных данных.

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder

Parameters:

Type	Name	Description
string	value	Тип персональных данных

Returns: self - Инстанс билдера запросов

protected initCurrentObject() : \YooKassa\Request\PersonalData\CreatePersonalDataRequest

protected initCurrentObject() : \YooKassa\Request\PersonalData\CreatePersonalDataRequest

Summary

Инициализирует объект запроса, который в дальнейшем будет собираться билдером

Details:

• Inherited From: \YooKassa\Request\PersonalData\CreatePersonalDataRequestBuilder

Returns: \YooKassa\Request\PersonalData\CreatePersonalDataRequest - Инстанс собираемого объекта запроса к API

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 0
• Deprecated - 15

---

This document was automatically generated from source code comments on 2023-10-17 using phpDocumentor

© 2023 YooMoney