yookassa-sdk-php/docs/classes/YooKassa-Request-PaymentMethods-CreatePaymentMethodRequest.md

YooKassa API SDK

Class: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest

Namespace: \YooKassa\Request\PaymentMethods

---

Summary:

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

Description:

Данные для проверки и сохранения способа оплаты.

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
public	$card		Данные банковской карты (необходимы, если вы собираете данные карты пользователей на своей стороне).
public	$client_ip		IPv4 или IPv6-адрес пользователя. Если не указан, используется IP-адрес TCP-подключения.
public	$clientIp		IPv4 или IPv6-адрес пользователя. Если не указан, используется IP-адрес TCP-подключения.
public	$confirmation		Данные, необходимые для инициирования сценария подтверждения привязки.
public	$holder		Данные магазина, для которого сохраняется способ оплаты.
public	$type		Код способа оплаты. Возможное значение: ~bank_card — банковская карта, ~sbp - СБП (Система быстрых платежей)

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства.
public	__isset()		Проверяет наличие свойства.
public	__set()		Устанавливает значение свойства.
public	__unset()		Удаляет свойство.
public	builder()		Возвращает билдер объектов запросов создания платежа.
public	clearValidationError()		Очищает статус валидации текущего запроса.
public	fromArray()		Устанавливает значения свойств текущего объекта из массива.
public	getCard()		Возвращает card.
public	getClientIp()		Возвращает client_ip.
public	getConfirmation()		Возвращает confirmation.
public	getHolder()		Возвращает holder.
public	getLastValidationError()		Возвращает последнюю ошибку валидации.
public	getType()		Возвращает type.
public	getValidator()
public	hasType()		Проверяет, были ли установлен код способа оплаты.
public	jsonSerialize()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public	offsetExists()		Проверяет наличие свойства.
public	offsetGet()		Возвращает значение свойства.
public	offsetSet()		Устанавливает значение свойства.
public	offsetUnset()		Удаляет свойство.
public	setCard()		Устанавливает card.
public	setClientIp()		Устанавливает client_ip.
public	setConfirmation()		Устанавливает confirmation.
public	setHolder()		Устанавливает holder.
public	setType()		Устанавливает type.
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
public	validate()		Валидирует текущий запрос, проверяет все ли нужные свойства установлены.
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected	setValidationError()		Устанавливает ошибку валидации.
protected	validatePropertyValue()

---

Details

• File: lib/Request/PaymentMethods/CreatePaymentMethodRequest.php

• Package: YooKassa\Model

• Class Hierarchy:

  • \YooKassa\Common\AbstractObject
  • \YooKassa\Common\AbstractRequest
  • \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest

• Implements:

  • \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequestInterface

• See Also:

---

Tags

Tag	Version	Description
category		Class
author		cms@yoomoney.ru

---

Properties

public $card : \YooKassa\Request\PaymentMethods\PaymentMethodCard

---

Description

Данные банковской карты (необходимы, если вы собираете данные карты пользователей на своей стороне).

Type: PaymentMethodCard

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 $confirmation : \YooKassa\Request\PaymentMethods\ConfirmationData\AbstractConfirmation

---

Description

Данные, необходимые для инициирования сценария подтверждения привязки.

Type: AbstractConfirmation

Details:

public $holder : \YooKassa\Request\PaymentMethods\PaymentMethodHolder

---

Description

Данные магазина, для которого сохраняется способ оплаты.

Type: PaymentMethodHolder

Details:

public $type : string

---

Description

Код способа оплаты. Возможное значение: ~bank_card — банковская карта, ~sbp - СБП (Система быстрых платежей)

Type: string

Details:

---

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 builder() : \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequestBuilder

Static public builder() : \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequestBuilder

Summary

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

Details:

• Inherited From: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest

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

public clearValidationError() : void

public clearValidationError() : void

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

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 getCard() : \YooKassa\Request\PaymentMethods\PaymentMethodCard|null

public getCard() : \YooKassa\Request\PaymentMethods\PaymentMethodCard|null

Summary

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

Details:

• Inherited From: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest

Returns: \YooKassa\Request\PaymentMethods\PaymentMethodCard|null -

public getClientIp() : string|null

public getClientIp() : string|null

Summary

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

Details:

• Inherited From: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest

Returns: string|null -

public getConfirmation() : \YooKassa\Request\PaymentMethods\ConfirmationData\AbstractConfirmation|null

public getConfirmation() : \YooKassa\Request\PaymentMethods\ConfirmationData\AbstractConfirmation|null

Summary

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

Details:

• Inherited From: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest

Returns: \YooKassa\Request\PaymentMethods\ConfirmationData\AbstractConfirmation|null -

public getHolder() : \YooKassa\Request\PaymentMethods\PaymentMethodHolder|null

public getHolder() : \YooKassa\Request\PaymentMethods\PaymentMethodHolder|null

Summary

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

Details:

• Inherited From: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest

Returns: \YooKassa\Request\PaymentMethods\PaymentMethodHolder|null -

public getLastValidationError() : string|null

public getLastValidationError() : string|null

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Returns: string|null - Последняя произошедшая ошибка валидации

public getType() : string|null

public getType() : string|null

Summary

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

Details:

• Inherited From: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest

Returns: string|null -

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: \YooKassa\Validator\Validator -

public hasType() : bool

public hasType() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest

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

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

public setCard(\YooKassa\Request\PaymentMethods\PaymentMethodCard|array|null $card) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest

Parameters:

Type	Name	Description
\YooKassa\Request\PaymentMethods\PaymentMethodCard OR array OR null	card	Данные для проверки и сохранения банковской карты.

Returns: self -

public setClientIp() : self

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest

Parameters:

Type	Name	Description
string OR null	client_ip	IPv4 или IPv6-адрес пользователя. Если не указан, используется IP-адрес TCP-подключения.

Returns: self -

public setConfirmation() : self

public setConfirmation(\YooKassa\Request\PaymentMethods\ConfirmationData\AbstractConfirmation|array|null $confirmation = null) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest

Parameters:

Type	Name	Description
\YooKassa\Request\PaymentMethods\ConfirmationData\AbstractConfirmation OR array OR null	confirmation	Данные, необходимые для инициирования сценария подтверждения привязки.

Returns: self -

public setHolder() : self

public setHolder(\YooKassa\Request\PaymentMethods\PaymentMethodHolder|array|null $holder = null) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest

Parameters:

Type	Name	Description
\YooKassa\Request\PaymentMethods\PaymentMethodHolder OR array OR null	holder	Данные магазина, для которого сохраняется способ оплаты.

Returns: self -

public setType() : self

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest

Parameters:

Type	Name	Description
string OR null	type	Код способа оплаты. Возможное значение: ~bank_card — банковская карта.

Returns: self -

public toArray() : array

public toArray() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

public validate() : bool

public validate() : bool

Summary

Валидирует текущий запрос, проверяет все ли нужные свойства установлены.

Details:

• Inherited From: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest

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

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

protected setValidationError() : void

protected setValidationError(string $value) : void

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Parameters:

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

Returns: void -

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

• \YooKassa

---

Reports

• Errors - 0
• Markers - 0
• Deprecated - 43

---

This document was automatically generated from source code comments on 2026-06-29 using phpDocumentor

© 2026 YooMoney