Александра Д. Спиридонова
16 KiB
YooKassa API SDK
Interface: CreatePaymentMethodRequestInterface
Namespace: \YooKassa\Request\PaymentMethods
Summary:
Класс, представляющий модель CreatePaymentMethodRequest.
Description:
Данные для проверки и сохранения способа оплаты.
Constants
- No constants found
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | clearValidationError() | Очищает статус валидации текущего запроса. | |
| public | getCard() | Возвращает card. | |
| public | getClientIp() | Возвращает client_ip. | |
| public | getConfirmation() | Возвращает confirmation. | |
| public | getHolder() | Возвращает holder. | |
| public | getLastValidationError() | Возвращает последнюю ошибку валидации. | |
| public | getMetadata() | Возвращает metadata. | |
| public | getType() | Возвращает type. | |
| public | hasMetadata() | Проверяет, были ли установлены метаданные. | |
| public | setCard() | Устанавливает card. | |
| public | setClientIp() | Устанавливает client_ip. | |
| public | setConfirmation() | Устанавливает confirmation. | |
| public | setHolder() | Устанавливает holder. | |
| public | setMetadata() | Устанавливает metadata. | |
| public | setType() | Устанавливает type. | |
| public | validate() | Валидирует текущий запрос, проверяет все ли нужные свойства установлены. |
Details
- File: lib/Request/PaymentMethods/CreatePaymentMethodRequestInterface.php
- Package: \YooKassa\Model
- Parents:
- See Also:
Tags
| Tag | Version | Description |
|---|---|---|
| category | Class | |
| author | cms@yoomoney.ru | |
| property | Код способа оплаты. Возможное значение: ~bank_card — банковская карта. |
|
| property | Данные банковской карты (необходимы, если вы собираете данные карты пользователей на своей стороне). | |
| property | Данные магазина, для которого сохраняется способ оплаты. | |
| property | IPv4 или IPv6-адрес пользователя. Если не указан, используется IP-адрес TCP-подключения. | |
| property | IPv4 или IPv6-адрес пользователя. Если не указан, используется IP-адрес TCP-подключения. | |
| property | Данные, необходимые для инициирования сценария подтверждения привязки. | |
| property | Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. |
Methods
public validate() : bool
public validate() : bool
Summary
Валидирует текущий запрос, проверяет все ли нужные свойства установлены.
Details:
- Inherited From: \YooKassa\Common\AbstractRequestInterface
Returns: bool - True если запрос валиден, false если нет
public clearValidationError() : void
public clearValidationError() : void
Summary
Очищает статус валидации текущего запроса.
Details:
- Inherited From: \YooKassa\Common\AbstractRequestInterface
Returns: void -
public getLastValidationError() : string|null
public getLastValidationError() : string|null
Summary
Возвращает последнюю ошибку валидации.
Details:
- Inherited From: \YooKassa\Common\AbstractRequestInterface
Returns: string|null - Последняя произошедшая ошибка валидации
public getType() : string|null
public getType() : string|null
Summary
Возвращает type.
Details:
Returns: string|null -
public setType() : \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest
public setType(string|null $type = null) : \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest
Summary
Устанавливает type.
Details:
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
type | Код способа оплаты. Возможное значение: ~bank_card — банковская карта. |
Returns: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest -
public getCard() : \YooKassa\Request\PaymentMethods\PaymentMethodCard|null
public getCard() : \YooKassa\Request\PaymentMethods\PaymentMethodCard|null
Summary
Возвращает card.
Details:
Returns: \YooKassa\Request\PaymentMethods\PaymentMethodCard|null -
public setCard() : \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest
public setCard(\YooKassa\Request\PaymentMethods\PaymentMethodCard|array|null $card) : \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest
Summary
Устанавливает card.
Details:
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Request\PaymentMethods\PaymentMethodCard OR array OR null |
card | Данные для проверки и сохранения банковской карты. |
Returns: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest -
public getHolder() : \YooKassa\Request\PaymentMethods\PaymentMethodHolder|null
public getHolder() : \YooKassa\Request\PaymentMethods\PaymentMethodHolder|null
Summary
Возвращает holder.
Details:
Returns: \YooKassa\Request\PaymentMethods\PaymentMethodHolder|null -
public setHolder() : \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest
public setHolder(\YooKassa\Request\PaymentMethods\PaymentMethodHolder|array|null $holder = null) : \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest
Summary
Устанавливает holder.
Details:
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Request\PaymentMethods\PaymentMethodHolder OR array OR null |
holder | Данные магазина, для которого сохраняется способ оплаты. |
Returns: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest -
public getClientIp() : string|null
public getClientIp() : string|null
Summary
Возвращает client_ip.
Details:
Returns: string|null -
public setClientIp() : \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest
public setClientIp(string|null $client_ip = null) : \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest
Summary
Устанавливает client_ip.
Details:
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
client_ip | IPv4 или IPv6-адрес пользователя. Если не указан, используется IP-адрес TCP-подключения. |
Returns: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest -
public getConfirmation() : \YooKassa\Request\PaymentMethods\ConfirmationData\AbstractConfirmation|null
public getConfirmation() : \YooKassa\Request\PaymentMethods\ConfirmationData\AbstractConfirmation|null
Summary
Возвращает confirmation.
Details:
Returns: \YooKassa\Request\PaymentMethods\ConfirmationData\AbstractConfirmation|null -
public setConfirmation() : \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest
public setConfirmation(\YooKassa\Request\PaymentMethods\ConfirmationData\AbstractConfirmation|array|null $confirmation = null) : \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest
Summary
Устанавливает confirmation.
Details:
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Request\PaymentMethods\ConfirmationData\AbstractConfirmation OR array OR null |
confirmation | Данные, необходимые для инициирования сценария подтверждения привязки. |
Returns: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest -
public getMetadata() : \YooKassa\Model\Metadata|null
public getMetadata() : \YooKassa\Model\Metadata|null
Summary
Возвращает metadata.
Details:
Returns: \YooKassa\Model\Metadata|null -
public hasMetadata() : bool
public hasMetadata() : bool
Summary
Проверяет, были ли установлены метаданные.
Details:
Returns: bool - True если метаданные были установлены, false если нет
public setMetadata() : \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest
public setMetadata(\YooKassa\Model\Metadata|array|null $metadata) : \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest
Summary
Устанавливает metadata.
Details:
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\Metadata OR array OR null |
metadata | Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. |
Returns: \YooKassa\Request\PaymentMethods\CreatePaymentMethodRequest -
Top Namespaces
Reports
This document was automatically generated from source code comments on 2026-08-13 using phpDocumentor
© 2026 YooMoney