meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md

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	getFraudData()		Возвращает информацию для проверки операции на мошенничество
public	getMerchantCustomerId()		Возвращает идентификатор покупателя в вашей системе
public	getMetadata()		Возвращает данные оплаты установленные мерчантом
public	getPaymentMethodData()		Возвращает данные для создания метода оплаты
public	getPaymentMethodId()		Устанавливает идентификатор записи платёжных данных покупателя
public	getPaymentToken()		Возвращает одноразовый токен для проведения оплаты
public	getReceipt()		Возвращает чек, если он есть
public	getRecipient()		Возвращает объект получателя платежа
public	getSavePaymentMethod()		Возвращает флаг сохранения платёжных данных
public	getTransfers()		Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести.
public	hasAirline()		Проверяет, были ли установлены данные длинной записи
public	hasCapture()		Проверяет, был ли установлен флаг автоматического приняти поступившей оплаты
public	hasClientIp()		Проверяет, был ли установлен IPv4 или IPv6-адрес покупателя
public	hasConfirmation()		Проверяет, был ли установлен способ подтверждения платежа
public	hasDeal()		Проверяет, были ли установлены данные о сделке
public	hasDescription()		Проверяет наличие описания транзакции в создаваемом платеже
public	hasFraudData()		Проверяет, была ли установлена информация для проверки операции на мошенничество
public	hasMerchantCustomerId()		Проверяет, был ли установлен идентификатор покупателя в вашей системе
public	hasMetadata()		Проверяет, были ли установлены метаданные заказа
public	hasPaymentMethodData()		Проверяет установлен ли объект с методом оплаты
public	hasPaymentMethodId()		Проверяет наличие идентификатора записи о платёжных данных покупателя
public	hasPaymentToken()		Проверяет наличие одноразового токена для проведения оплаты
public	hasReceipt()		Проверяет наличие чека в создаваемом платеже
public	hasRecipient()		Проверяет наличие получателя платежа в запросе
public	hasSavePaymentMethod()		Проверяет, был ли установлен флаг сохранения платёжных данных
public	hasTransfers()		Проверяет наличие данных о распределении денег
public	setAirline()		Устанавливает данные авиабилетов
public	setCapture()		Устанавливает флаг автоматического принятия поступившей оплаты
public	setClientIp()		Устанавливает IP адрес покупателя
public	setConfirmation()		Устанавливает способ подтверждения платежа
public	setDeal()		Устанавливает данные о сделке, в составе которой проходит платеж.
public	setDescription()		Устанавливает описание транзакции
public	setFraudData()		Устанавливает информацию для проверки операции на мошенничество
public	setMerchantCustomerId()		Устанавливает идентификатор покупателя в вашей системе
public	setMetadata()		Устанавливает метаданные, привязанные к платежу
public	setPaymentMethodData()		Устанавливает объект с информацией для создания метода оплаты
public	setPaymentMethodId()		Устанавливает идентификатор записи о сохранённых данных покупателя
public	setPaymentToken()		Устанавливает одноразовый токен для проведения оплаты, сформированный YooKassa JS widget
public	setRecipient()		Устанавливает объект с информацией о получателе платежа
public	setSavePaymentMethod()		Устанавливает флаг сохранения платёжных данных. Значение true инициирует создание многоразового payment_method.
public	setTransfers()		Устанавливает данные о распределении денег — сколько и в какой магазин нужно перевести.

---

Details

• File: lib/Request/Payments/CreatePaymentRequestInterface.php
• Package: \YooKassa

---

Tags

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

---

Methods

public getRecipient() : \YooKassa\Model\RecipientInterface|null

public getRecipient() : \YooKassa\Model\RecipientInterface|null

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public hasRecipient() : bool

public hasRecipient() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public setRecipient() : mixed

public setRecipient(\YooKassa\Model\RecipientInterface|null $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Parameters:

Type	Name	Description
\YooKassa\Model\RecipientInterface OR null	value	Инстанс объекта информации о получателе платежа или null

Returns: mixed -

public getAmount() : \YooKassa\Model\AmountInterface

public getAmount() : \YooKassa\Model\AmountInterface

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public getDescription() : string

public getDescription() : string

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public hasDescription() : bool

public hasDescription() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public setDescription() : mixed

public setDescription(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Parameters:

Type	Name	Description
string	value	Описание транзакции

Returns: mixed -

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public hasReceipt() : bool

public hasReceipt() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public getPaymentToken() : string

public getPaymentToken() : string

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public hasPaymentToken() : bool

public hasPaymentToken() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public setPaymentToken() : mixed

public setPaymentToken(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Parameters:

Type	Name	Description
string	value	Одноразовый токен для проведения оплаты

Returns: mixed -

public getPaymentMethodId() : string

public getPaymentMethodId() : string

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public hasPaymentMethodId() : bool

public hasPaymentMethodId() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public setPaymentMethodId() : mixed

public setPaymentMethodId(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Parameters:

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

Returns: mixed -

public getPaymentMethodData() : \YooKassa\Model\PaymentData\AbstractPaymentData

public getPaymentMethodData() : \YooKassa\Model\PaymentData\AbstractPaymentData

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public hasPaymentMethodData() : bool

public hasPaymentMethodData() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public setPaymentMethodData() : mixed

public setPaymentMethodData(\YooKassa\Model\PaymentData\AbstractPaymentData|null $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Parameters:

Type	Name	Description
\YooKassa\Model\PaymentData\AbstractPaymentData OR null	value	Объект создания метода оплаты или null

Returns: mixed -

public getConfirmation() : \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes

public getConfirmation() : \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public hasConfirmation() : bool

public hasConfirmation() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public setConfirmation() : mixed

public setConfirmation(\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes|null $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Parameters:

Type	Name	Description
\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes OR null	value	Способ подтверждения платежа

Returns: mixed -

public getSavePaymentMethod() : bool

public getSavePaymentMethod() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public hasSavePaymentMethod() : bool

public hasSavePaymentMethod() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public setSavePaymentMethod() : mixed

public setSavePaymentMethod(bool $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Parameters:

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

Returns: mixed -

public getCapture() : bool

public getCapture() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public hasCapture() : bool

public hasCapture() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public setCapture() : mixed

public setCapture(bool $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Parameters:

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

Returns: mixed -

public getClientIp() : string

public getClientIp() : string

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public hasClientIp() : bool

public hasClientIp() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public setClientIp() : mixed

public setClientIp(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Parameters:

Type	Name	Description
string	value	IPv4 или IPv6-адрес покупателя

Returns: mixed -

public getMetadata() : \YooKassa\Model\Metadata

public getMetadata() : \YooKassa\Model\Metadata

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public hasMetadata() : bool

public hasMetadata() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public setMetadata() : mixed

public setMetadata(\YooKassa\Model\Metadata|array|null $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Parameters:

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

Returns: mixed -

public getAirline() : \YooKassa\Model\Airline

public getAirline() : \YooKassa\Model\Airline

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Returns: \YooKassa\Model\Airline -

public hasAirline() : bool

public hasAirline() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Returns: bool -

public setAirline() : mixed

public setAirline(\YooKassa\Model\AirlineInterface $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Parameters:

Type	Name	Description
\YooKassa\Model\AirlineInterface	value	Данные авиабилетов

Returns: mixed -

public hasTransfers() : bool

public hasTransfers() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Returns: bool -

public getTransfers() : \YooKassa\Model\TransferInterface[]

public getTransfers() : \YooKassa\Model\TransferInterface[]

Summary

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

Description

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public setTransfers() : mixed

public setTransfers(\YooKassa\Model\TransferInterface[]|array|null $value) : mixed

Summary

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

Description

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Parameters:

Type	Name	Description
\YooKassa\Model\TransferInterface[] OR array OR null	value	Данные о распределении денег

Returns: mixed -

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public hasDeal() : bool

public hasDeal() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public setDeal() : mixed

public setDeal(\YooKassa\Model\Deal\PaymentDealInfo|array|null $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Parameters:

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

Returns: mixed -

public getFraudData() : \YooKassa\Model\FraudData

public getFraudData() : \YooKassa\Model\FraudData

Summary

Возвращает информацию для проверки операции на мошенничество

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Returns: \YooKassa\Model\FraudData - Информация для проверки операции на мошенничество

public hasFraudData() : bool

public hasFraudData() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public setFraudData() : mixed

public setFraudData(\YooKassa\Model\FraudData|array|null $value) : mixed

Summary

Устанавливает информацию для проверки операции на мошенничество

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Parameters:

Type	Name	Description
\YooKassa\Model\FraudData OR array OR null	value	Информация для проверки операции на мошенничество

Returns: mixed -

public getMerchantCustomerId() : string

public getMerchantCustomerId() : string

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public hasMerchantCustomerId() : bool

public hasMerchantCustomerId() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

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

public setMerchantCustomerId() : mixed

public setMerchantCustomerId(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Request\Payments\CreatePaymentRequestInterface

Parameters:

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

Returns: mixed -

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 1
• Deprecated - 25

---

This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor

© 2023 YooMoney