Files
yookassa-sdk-php/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md
Евгений Ю. Лозный 260d13f890 Добавлен прием платежей через Alfa Pay. Добавлен новый тип ошибки RuleViolationError
Добавлены нулевые привязки по СБП
Добавлена причина отмены возвратов `payment_expired`
2026-06-29 17:46:40 +03:00

47 KiB

YooKassa API SDK

Interface: CreatePaymentRequestInterface

Namespace: \YooKassa\Request\Payments


Summary:

Interface CreatePaymentRequestInterface.


Constants

  • No constants found

Methods

Visibility Name Flag Summary
public getAirline() Возвращает данные длинной записи.
public getAmount() Возвращает сумму заказа.
public getCapture() Возвращает флаг автоматического принятия поступившей оплаты.
public getClientIp() Возвращает IPv4 или IPv6-адрес покупателя.
public getConfirmation() Возвращает способ подтверждения платежа.
public getDeal() Возвращает данные о сделке, в составе которой проходит платеж.
public getDescription() Возвращает описание транзакции.
public getMerchantCustomerId() Возвращает идентификатор покупателя в вашей системе.
public getMetadata() Возвращает данные оплаты установленные мерчантом
public getPaymentMethodData() Возвращает данные для создания метода оплаты.
public getPaymentMethodId() Устанавливает идентификатор записи платёжных данных покупателя.
public getPaymentOrder() Возвращает платежное поручение.
public getPaymentToken() Возвращает одноразовый токен для проведения оплаты.
public getReceipt() Возвращает чек, если он есть.
public getReceiver() Возвращает реквизиты получателя оплаты.
public getRecipient() Возвращает объект получателя платежа.
public getSavePaymentMethod() Возвращает флаг сохранения платёжных данных.
public getTransfers() Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести.
public hasAirline() Проверяет, были ли установлены данные длинной записи.
public hasCapture() Проверяет, был ли установлен флаг автоматического приняти поступившей оплаты.
public hasClientIp() Проверяет, был ли установлен IPv4 или IPv6-адрес покупателя.
public hasConfirmation() Проверяет, был ли установлен способ подтверждения платежа.
public hasDeal() Проверяет, были ли установлены данные о сделке.
public hasDescription() Проверяет наличие описания транзакции в создаваемом платеже.
public hasMerchantCustomerId() Проверяет, был ли установлен идентификатор покупателя в вашей системе.
public hasMetadata() Проверяет, были ли установлены метаданные заказа.
public hasPaymentMethodData() Проверяет установлен ли объект с методом оплаты.
public hasPaymentMethodId() Проверяет наличие идентификатора записи о платёжных данных покупателя.
public hasPaymentOrder() Проверяет, было ли установлено платежное поручение.
public hasPaymentToken() Проверяет наличие одноразового токена для проведения оплаты.
public hasReceipt() Проверяет наличие чека в создаваемом платеже.
public hasReceiver() Проверяет, были ли установлены реквизиты получателя оплаты.
public hasRecipient() Проверяет наличие получателя платежа в запросе.
public hasSavePaymentMethod() Проверяет, был ли установлен флаг сохранения платёжных данных.
public hasTransfers() Проверяет наличие данных о распределении денег.
public setAirline() Устанавливает данные авиабилетов.
public setCapture() Устанавливает флаг автоматического принятия поступившей оплаты.
public setClientIp() Устанавливает IP адрес покупателя.
public setConfirmation() Устанавливает способ подтверждения платежа.
public setDeal() Устанавливает данные о сделке, в составе которой проходит платеж.
public setDescription() Устанавливает описание транзакции.
public setMerchantCustomerId() Устанавливает идентификатор покупателя в вашей системе.
public setMetadata() Устанавливает метаданные, привязанные к платежу.
public setPaymentMethodData() Устанавливает объект с информацией для создания метода оплаты.
public setPaymentMethodId() Устанавливает идентификатор записи о сохранённых данных покупателя.
public setPaymentOrder() Устанавливает платежное поручение.
public setPaymentToken() Устанавливает одноразовый токен для проведения оплаты, сформированный YooKassa JS widget.
public setReceiver() Устанавливает реквизиты получателя оплаты.
public setRecipient() Устанавливает объект с информацией о получателе платежа.
public setSavePaymentMethod() Устанавливает флаг сохранения платёжных данных. Значение true инициирует создание многоразового payment_method.
public setTransfers() Устанавливает данные о распределении денег — сколько и в какой магазин нужно перевести.

Details


Tags

Tag Version Description
category Class
author cms@yoomoney.ru
property Получатель платежа, если задан
property Сумма создаваемого платежа
property Описание транзакции
property Данные фискального чека 54-ФЗ
property Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget
property Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget
property Идентификатор записи о сохраненных платежных данных покупателя
property Идентификатор записи о сохраненных платежных данных покупателя
property Данные используемые для создания метода оплаты
property Данные используемые для создания метода оплаты
property Способ подтверждения платежа
property Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method
property Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method
property Автоматически принять поступившую оплату
property IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения
property IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения
property Метаданные привязанные к платежу
property Данные о сделке, в составе которой проходит платеж
property Идентификатор покупателя в вашей системе, например электронная почта или номер телефона
property Идентификатор покупателя в вашей системе, например электронная почта или номер телефона
property Реквизиты получателя оплаты при пополнении электронного кошелька, банковского счета или баланса телефона

Methods

public getRecipient() : null|\YooKassa\Request\Payments\Recipient

public getRecipient() : null|\YooKassa\Request\Payments\Recipient

Summary

Возвращает объект получателя платежа.

Details:

Returns: null|\YooKassa\Request\Payments\Recipient - Объект с информацией о получателе платежа или null, если получатель не задан

public hasRecipient() : bool

public hasRecipient() : bool

Summary

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

Details:

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

public setRecipient() : mixed

public setRecipient(null|\YooKassa\Request\Payments\Recipient $recipient) : mixed

Summary

Устанавливает объект с информацией о получателе платежа.

Details:

Parameters:
Type Name Description
null OR \YooKassa\Request\Payments\Recipient recipient Инстанс объекта информации о получателе платежа или null

Returns: mixed -

public getAmount() : \YooKassa\Model\AmountInterface|null

public getAmount() : \YooKassa\Model\AmountInterface|null

Summary

Возвращает сумму заказа.

Details:

Returns: \YooKassa\Model\AmountInterface|null - Сумма заказа

public getDescription() : string|null

public getDescription() : string|null

Summary

Возвращает описание транзакции.

Details:

Returns: string|null - Описание транзакции

public hasDescription() : bool

public hasDescription() : bool

Summary

Проверяет наличие описания транзакции в создаваемом платеже.

Details:

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

public setDescription() : self

public setDescription(string|null $description) : self

Summary

Устанавливает описание транзакции.

Details:

Parameters:
Type Name Description
string OR null description Описание транзакции

Returns: self -

public getReceipt() : null|\YooKassa\Model\Receipt\ReceiptInterface

public getReceipt() : null|\YooKassa\Model\Receipt\ReceiptInterface

Summary

Возвращает чек, если он есть.

Details:

Returns: null|\YooKassa\Model\Receipt\ReceiptInterface - Данные фискального чека 54-ФЗ или null, если чека нет

public hasReceipt() : bool

public hasReceipt() : bool

Summary

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

Details:

Returns: bool - True если чек есть, false если нет

public getPaymentToken() : string|null

public getPaymentToken() : string|null

Summary

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

Details:

Returns: string|null - Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget

public hasPaymentToken() : bool

public hasPaymentToken() : bool

Summary

Проверяет наличие одноразового токена для проведения оплаты.

Details:

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

public setPaymentToken() : self

public setPaymentToken(string|null $payment_token) : self

Summary

Устанавливает одноразовый токен для проведения оплаты, сформированный YooKassa JS widget.

Details:

Parameters:
Type Name Description
string OR null payment_token Одноразовый токен для проведения оплаты

Returns: self -

public getPaymentMethodId() : string|null

public getPaymentMethodId() : string|null

Summary

Устанавливает идентификатор записи платёжных данных покупателя.

Details:

Returns: string|null - Идентификатор записи о сохраненных платежных данных покупателя

public hasPaymentMethodId() : bool

public hasPaymentMethodId() : bool

Summary

Проверяет наличие идентификатора записи о платёжных данных покупателя.

Details:

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

public setPaymentMethodId() : self

public setPaymentMethodId(string|null $payment_method_id) : self

Summary

Устанавливает идентификатор записи о сохранённых данных покупателя.

Details:

Parameters:
Type Name Description
string OR null payment_method_id Идентификатор записи о сохраненных платежных данных покупателя

Returns: self -

public getPaymentMethodData() : \YooKassa\Request\Payments\PaymentData\AbstractPaymentData|null

public getPaymentMethodData() : \YooKassa\Request\Payments\PaymentData\AbstractPaymentData|null

Summary

Возвращает данные для создания метода оплаты.

Details:

Returns: \YooKassa\Request\Payments\PaymentData\AbstractPaymentData|null - Данные используемые для создания метода оплаты

public hasPaymentMethodData() : bool

public hasPaymentMethodData() : bool

Summary

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

Details:

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

public setPaymentMethodData() : self

public setPaymentMethodData(null|\YooKassa\Request\Payments\PaymentData\AbstractPaymentData $payment_method_data) : self

Summary

Устанавливает объект с информацией для создания метода оплаты.

Details:

Parameters:
Type Name Description
null OR \YooKassa\Request\Payments\PaymentData\AbstractPaymentData payment_method_data Объект создания метода оплаты или null

Returns: self -

public getConfirmation() : \YooKassa\Request\Payments\ConfirmationAttributes\AbstractConfirmationAttributes|null

public getConfirmation() : \YooKassa\Request\Payments\ConfirmationAttributes\AbstractConfirmationAttributes|null

Summary

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

Details:

Returns: \YooKassa\Request\Payments\ConfirmationAttributes\AbstractConfirmationAttributes|null - Способ подтверждения платежа

public hasConfirmation() : bool

public hasConfirmation() : bool

Summary

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

Details:

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

public setConfirmation() : self

public setConfirmation(null|array|\YooKassa\Request\Payments\ConfirmationAttributes\AbstractConfirmationAttributes $confirmation) : self

Summary

Устанавливает способ подтверждения платежа.

Details:

Parameters:
Type Name Description
null OR array OR \YooKassa\Request\Payments\ConfirmationAttributes\AbstractConfirmationAttributes confirmation Способ подтверждения платежа

Returns: self -

public getSavePaymentMethod() : bool|null

public getSavePaymentMethod() : bool|null

Summary

Возвращает флаг сохранения платёжных данных.

Details:

Returns: bool|null - Флаг сохранения платёжных данных

public hasSavePaymentMethod() : bool

public hasSavePaymentMethod() : bool

Summary

Проверяет, был ли установлен флаг сохранения платёжных данных.

Details:

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

public setSavePaymentMethod() : self

public setSavePaymentMethod(bool|null $save_payment_method = null) : self

Summary

Устанавливает флаг сохранения платёжных данных. Значение true инициирует создание многоразового payment_method.

Details:

Parameters:
Type Name Description
bool OR null save_payment_method Сохранить платежные данные для последующего использования

Returns: self -

public getCapture() : bool

public getCapture() : bool

Summary

Возвращает флаг автоматического принятия поступившей оплаты.

Details:

Returns: bool - True если требуется автоматически принять поступившую оплату, false если нет

public hasCapture() : bool

public hasCapture() : bool

Summary

Проверяет, был ли установлен флаг автоматического приняти поступившей оплаты.

Details:

Returns: bool - True если флаг автоматического принятия оплаты был установлен, false если нет

public setCapture() : self

public setCapture(bool $capture) : self

Summary

Устанавливает флаг автоматического принятия поступившей оплаты.

Details:

Parameters:
Type Name Description
bool capture Автоматически принять поступившую оплату

Returns: self -

public getClientIp() : string|null

public getClientIp() : string|null

Summary

Возвращает IPv4 или IPv6-адрес покупателя.

Details:

Returns: string|null - IPv4 или IPv6-адрес покупателя

public hasClientIp() : bool

public hasClientIp() : bool

Summary

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

Details:

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

public setClientIp() : self

public setClientIp(string|null $client_ip) : self

Summary

Устанавливает IP адрес покупателя.

Details:

Parameters:
Type Name Description
string OR null client_ip IPv4 или IPv6-адрес покупателя

Returns: self -

public getMetadata() : \YooKassa\Model\Metadata|null

public getMetadata() : \YooKassa\Model\Metadata|null

Summary

Возвращает данные оплаты установленные мерчантом

Details:

Returns: \YooKassa\Model\Metadata|null - Метаданные привязанные к платежу

public hasMetadata() : bool

public hasMetadata() : bool

Summary

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

Details:

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

public setMetadata() : self

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

Summary

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

Details:

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

Returns: self -

public getAirline() : ?\YooKassa\Request\Payments\AirlineInterface

public getAirline() : ?\YooKassa\Request\Payments\AirlineInterface

Summary

Возвращает данные длинной записи.

Details:

Returns: ?\YooKassa\Request\Payments\AirlineInterface -

public hasAirline() : bool

public hasAirline() : bool

Summary

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

Details:

Returns: bool -

public setAirline() : \YooKassa\Common\AbstractRequestInterface

public setAirline(\YooKassa\Request\Payments\AirlineInterface|array|null $airline) : \YooKassa\Common\AbstractRequestInterface

Summary

Устанавливает данные авиабилетов.

Details:

Parameters:
Type Name Description
\YooKassa\Request\Payments\AirlineInterface OR array OR null airline Данные авиабилетов

Returns: \YooKassa\Common\AbstractRequestInterface -

public hasTransfers() : bool

public hasTransfers() : bool

Summary

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

Details:

Returns: bool -

public getTransfers() : \YooKassa\Model\Payment\TransferInterface[]|\YooKassa\Common\ListObjectInterface|null

public getTransfers() : \YooKassa\Model\Payment\TransferInterface[]|\YooKassa\Common\ListObjectInterface|null

Summary

Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести.

Description

Присутствует, если вы используете решение ЮKassa для платформ. (https://yookassa.ru/developers/special-solutions/checkout-for-platforms/basics).

Details:

Returns: \YooKassa\Model\Payment\TransferInterface[]|\YooKassa\Common\ListObjectInterface|null - Данные о распределении денег

public setTransfers() : self

public setTransfers(\YooKassa\Common\ListObjectInterface|array|null $transfers = null) : self

Summary

Устанавливает данные о распределении денег — сколько и в какой магазин нужно перевести.

Description

Присутствует, если вы используете решение ЮKassa для платформ. (https://yookassa.ru/developers/special-solutions/checkout-for-platforms/basics).

Details:

Parameters:
Type Name Description
\YooKassa\Common\ListObjectInterface OR array OR null transfers Массив распределения денег

Returns: self -

public getDeal() : \YooKassa\Model\Deal\PaymentDealInfo|null

public getDeal() : \YooKassa\Model\Deal\PaymentDealInfo|null

Summary

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

Details:

Returns: \YooKassa\Model\Deal\PaymentDealInfo|null - Данные о сделке, в составе которой проходит платеж

public hasDeal() : bool

public hasDeal() : bool

Summary

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

Details:

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

public setDeal() : self

public setDeal(null|array|\YooKassa\Model\Deal\PaymentDealInfo $deal) : self

Summary

Устанавливает данные о сделке, в составе которой проходит платеж.

Details:

Parameters:
Type Name Description
null OR array OR \YooKassa\Model\Deal\PaymentDealInfo deal Данные о сделке, в составе которой проходит платеж

Returns: self -

public getMerchantCustomerId() : string|null

public getMerchantCustomerId() : string|null

Summary

Возвращает идентификатор покупателя в вашей системе.

Details:

Returns: string|null - Идентификатор покупателя в вашей системе

public hasMerchantCustomerId() : bool

public hasMerchantCustomerId() : bool

Summary

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

Details:

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

public setMerchantCustomerId() : self

public setMerchantCustomerId(string|null $merchant_customer_id) : self

Summary

Устанавливает идентификатор покупателя в вашей системе.

Details:

Parameters:
Type Name Description
string OR null merchant_customer_id Идентификатор покупателя в вашей системе, например электронная почта или номер телефона. Не более 200 символов

Returns: self -

public getPaymentOrder() : \YooKassa\Request\Payments\PaymentOrderData\AbstractPaymentOrder|null

public getPaymentOrder() : \YooKassa\Request\Payments\PaymentOrderData\AbstractPaymentOrder|null

Summary

Возвращает платежное поручение.

Details:

Returns: \YooKassa\Request\Payments\PaymentOrderData\AbstractPaymentOrder|null - Платежное поручение — распоряжение на перевод банку для оплаты жилищно-коммунальных услуг (ЖКУ), сведения о платеже для регистрации в ГИС ЖКХ.

public hasPaymentOrder() : bool

public hasPaymentOrder() : bool

Summary

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

Details:

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

public setPaymentOrder() : self

public setPaymentOrder(\YooKassa\Request\Payments\PaymentOrderData\AbstractPaymentOrder|array|null $payment_order = null) : self

Summary

Устанавливает платежное поручение.

Details:

Parameters:
Type Name Description
\YooKassa\Request\Payments\PaymentOrderData\AbstractPaymentOrder OR array OR null payment_order Платежное поручение — распоряжение на перевод банку для оплаты жилищно-коммунальных услуг (ЖКУ), сведения о платеже для регистрации в ГИС ЖКХ.

Returns: self -

public getReceiver() : null|\YooKassa\Request\Payments\ReceiverData\AbstractReceiver

public getReceiver() : null|\YooKassa\Request\Payments\ReceiverData\AbstractReceiver

Summary

Возвращает реквизиты получателя оплаты.

Details:

Returns: null|\YooKassa\Request\Payments\ReceiverData\AbstractReceiver - Реквизиты получателя оплаты при пополнении электронного кошелька, банковского счета или баланса телефона.

public hasReceiver() : bool

public hasReceiver() : bool

Summary

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

Details:

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

public setReceiver() : self

public setReceiver(null|array|\YooKassa\Request\Payments\ReceiverData\AbstractReceiver $receiver) : self

Summary

Устанавливает реквизиты получателя оплаты.

Details:

Parameters:
Type Name Description
null OR array OR \YooKassa\Request\Payments\ReceiverData\AbstractReceiver receiver Реквизиты получателя оплаты при пополнении электронного кошелька, банковского счета или баланса телефона.

Returns: self -


Top Namespaces


Reports


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

© 2026 YooMoney