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

YooKassa API SDK

Class: \YooKassa\Request\Payments\CreatePaymentRequest

Namespace: \YooKassa\Request\Payments

---

Summary:

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

---

Examples

02-builder.php 11 78 Пример использования билдера

---

Constants

Visibility	Name	Flag	Summary
public	MAX_LENGTH_PAYMENT_TOKEN

---

Properties

Visibility	Name	Flag	Summary
public	$amount		Сумма создаваемого платежа
public	$amount		Сумма
public	$capture		Автоматически принять поступившую оплату
public	$client_ip		IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения
public	$clientIp		IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения
public	$confirmation		Способ подтверждения платежа
public	$deal		Данные о сделке, в составе которой проходит платеж
public	$description		Описание транзакции
public	$fraud_data		Информация для проверки операции на мошенничество
public	$fraudData		Информация для проверки операции на мошенничество
public	$merchant_customer_id		Идентификатор покупателя в вашей системе, например электронная почта или номер телефона
public	$merchantCustomerId		Идентификатор покупателя в вашей системе, например электронная почта или номер телефона
public	$metadata		Метаданные привязанные к платежу
public	$payment_method_data		Данные используемые для создания метода оплаты
public	$payment_method_id		Идентификатор записи о сохраненных платежных данных покупателя
public	$payment_token		Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget
public	$paymentMethodData		Данные используемые для создания метода оплаты
public	$paymentMethodId		Идентификатор записи о сохраненных платежных данных покупателя
public	$paymentToken		Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget
public	$receipt		Данные фискального чека 54-ФЗ
public	$receipt		Данные фискального чека 54-ФЗ
public	$recipient		Получатель платежа, если задан
public	$save_payment_method		Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method
public	$savePaymentMethod		Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method
public	$transfers		Данные о распределении платежа между магазинами

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства
public	__isset()		Проверяет наличие свойства
public	__set()		Устанавливает значение свойства
public	__unset()		Удаляет свойство
public	builder()		Возвращает билдер объектов запросов создания платежа
public	clearValidationError()		Очищает статус валидации текущего запроса
public	fromArray()		Устанавливает значения свойств текущего объекта из массива
public	getAirline()		Возвращает данные авиабилетов
public	getAmount()		Возвращает сумму оплаты
public	getCapture()		Возвращает флаг автоматического принятия поступившей оплаты
public	getClientIp()		Возвращает IPv4 или IPv6-адрес покупателя
public	getConfirmation()		Возвращает способ подтверждения платежа
public	getDeal()		Возвращает данные о сделке, в составе которой проходит платеж
public	getDescription()		Возвращает описание транзакции
public	getFraudData()		Возвращает информацию для проверки операции на мошенничество.
public	getLastValidationError()		Возвращает последнюю ошибку валидации
public	getMerchantCustomerId()		Возвращает идентификатор покупателя в вашей системе
public	getMetadata()		Возвращает данные оплаты установленные мерчантом
public	getPaymentMethodData()		Возвращает данные для создания метода оплаты
public	getPaymentMethodId()		Устанавливает идентификатор записи платёжных данных покупателя
public	getPaymentToken()		Возвращает одноразовый токен для проведения оплаты
public	getReceipt()		Возвращает чек, если он есть
public	getRecipient()		Возвращает объект получателя платежа
public	getSavePaymentMethod()		Возвращает флаг сохранения платёжных данных
public	getTransfers()		Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести.
public	hasAirline()		Проверяет, были ли установлены данные авиабилетов
public	hasAmount()		Проверяет, была ли установлена сумма оплаты
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	jsonSerialize()
public	offsetExists()
public	offsetGet()
public	offsetSet()
public	offsetUnset()
public	removeReceipt()		Удаляет чек из запроса
public	setAirline()		Устанавливает данные авиабилетов
public	setAmount()		Устанавливает сумму оплаты
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	setReceipt()		Устанавливает чек
public	setRecipient()		Устанавливает объект с информацией о получателе платежа
public	setSavePaymentMethod()		Устанавливает флаг сохранения платёжных данных. Значение true инициирует создание многоразового payment_method.
public	setTransfers()		Устанавливает transfers (массив распределения денег между магазинами)
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
public	validate()		Проверяет на валидность текущий объект
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта
protected	setValidationError()		Устанавливает ошибку валидации

---

Details

• File: lib/Request/Payments/CreatePaymentRequest.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Common\AbstractRequest
  • \YooKassa\Common\AbstractPaymentRequest
  • \YooKassa\Request\Payments\CreatePaymentRequest
• Implements:
  • \YooKassa\Request\Payments\CreatePaymentRequestInterface

---

Constants

MAX_LENGTH_PAYMENT_TOKEN

MAX_LENGTH_PAYMENT_TOKEN = 10240

---

Properties

public $amount : \YooKassa\Model\AmountInterface

---

Description

Сумма создаваемого платежа

Type: AmountInterface

Details:

public $amount : \YooKassa\Model\AmountInterface

---

Description

Сумма

Type: AmountInterface

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

public $capture : bool

---

Description

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

Type: bool

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\Model\ConfirmationAttributes\AbstractConfirmationAttributes

---

Description

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

Type: AbstractConfirmationAttributes

Details:

public $deal : \YooKassa\Model\Deal\PaymentDealInfo

---

Description

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

Type: PaymentDealInfo

Details:

public $description : string

---

Description

Описание транзакции

Type: string

Details:

public $fraud_data : \YooKassa\Model\FraudData

---

Description

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

Type: FraudData

Details:

public $fraudData : \YooKassa\Model\FraudData

---

Description

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

Type: FraudData

Details:

public $merchant_customer_id : string

---

Description

Идентификатор покупателя в вашей системе, например электронная почта или номер телефона

Type: string

Details:

public $merchantCustomerId : string

---

Description

Идентификатор покупателя в вашей системе, например электронная почта или номер телефона

Type: string

Details:

public $metadata : \YooKassa\Model\Metadata

---

Description

Метаданные привязанные к платежу

Type: Metadata

Details:

public $payment_method_data : \YooKassa\Model\PaymentData\AbstractPaymentData

---

Description

Данные используемые для создания метода оплаты

Type: AbstractPaymentData

Details:

public $payment_method_id : string

---

Description

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

Type: string

Details:

public $payment_token : string

---

Description

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

Type: string

Details:

public $paymentMethodData : \YooKassa\Model\PaymentData\AbstractPaymentData

---

Description

Данные используемые для создания метода оплаты

Type: AbstractPaymentData

Details:

public $paymentMethodId : string

---

Description

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

Type: string

Details:

public $paymentToken : string

---

Description

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

Type: string

Details:

public $receipt : \YooKassa\Model\ReceiptInterface

---

Description

Данные фискального чека 54-ФЗ

Type: ReceiptInterface

Details:

public $receipt : \YooKassa\Model\ReceiptInterface

---

Description

Данные фискального чека 54-ФЗ

Type: ReceiptInterface

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

public $recipient : \YooKassa\Model\RecipientInterface

---

Description

Получатель платежа, если задан

Type: RecipientInterface

Details:

public $save_payment_method : bool

---

Description

Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method

Type: bool

Details:

public $savePaymentMethod : bool

---

Description

Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method

Type: bool

Details:

public $transfers : \YooKassa\Model\TransferInterface[]

---

Description

Данные о распределении платежа между магазинами

Type: TransferInterface[]

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

---

Methods

public __construct() : mixed

public __construct(array $data = array()) : mixed

Summary

AbstractObject constructor.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array	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() : mixed

public __set(string $propertyName, mixed $value) : mixed

Summary

Устанавливает значение свойства

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя свойства
mixed	value	Значение свойства

Returns: mixed -

public __unset() : mixed

public __unset(string $propertyName) : mixed

Summary

Удаляет свойство

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя удаляемого свойства

Returns: mixed -

public builder() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Static public builder() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

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

Details:

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

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

public clearValidationError() : mixed

public clearValidationError() : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Returns: mixed -

public fromArray() : mixed

public fromArray(array|\Traversable $sourceArray) : mixed

Summary

Устанавливает значения свойств текущего объекта из массива

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array OR \Traversable	sourceArray	Ассоциативный массив с настройками

Returns: mixed -

public getAirline() : \YooKassa\Model\AirlineInterface

public getAirline() : \YooKassa\Model\AirlineInterface

Summary

Возвращает данные авиабилетов

Details:

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

Returns: \YooKassa\Model\AirlineInterface - Данные авиабилетов

public getAmount() : \YooKassa\Model\AmountInterface

public getAmount() : \YooKassa\Model\AmountInterface

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

Returns: \YooKassa\Model\AmountInterface - Сумма оплаты

public getCapture() : bool

public getCapture() : bool

Summary

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

Details:

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

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

public getClientIp() : string

public getClientIp() : string

Summary

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

Details:

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

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

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

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

Summary

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

Details:

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

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

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

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

Summary

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

Details:

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

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

public getDescription() : string

public getDescription() : string

Summary

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

Details:

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

Returns: string -

public getFraudData() : \YooKassa\Model\FraudData|null

public getFraudData() : \YooKassa\Model\FraudData|null

Summary

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

Details:

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

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

public getLastValidationError() : string

public getLastValidationError() : string

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

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

public getMerchantCustomerId() : string

public getMerchantCustomerId() : string

Summary

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

Details:

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

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

public getMetadata() : \YooKassa\Model\Metadata

public getMetadata() : \YooKassa\Model\Metadata

Summary

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

Details:

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

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

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

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

Summary

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

Details:

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

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

public getPaymentMethodId() : string

public getPaymentMethodId() : string

Summary

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

Details:

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

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

public getPaymentToken() : string

public getPaymentToken() : string

Summary

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

Details:

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

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

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

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

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

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

Summary

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

Details:

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

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

public getSavePaymentMethod() : bool

public getSavePaymentMethod() : bool

Summary

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

Details:

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

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\Common\AbstractPaymentRequest

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

public hasAirline() : bool

public hasAirline() : bool

Summary

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

Details:

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

Returns: bool -

public hasAmount() : bool

public hasAmount() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

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

public hasCapture() : bool

public hasCapture() : bool

Summary

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

Details:

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

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

public hasClientIp() : bool

public hasClientIp() : bool

Summary

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

Details:

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

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

public hasConfirmation() : bool

public hasConfirmation() : bool

Summary

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

Details:

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

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

public hasDeal() : bool

public hasDeal() : bool

Summary

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

Details:

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

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

public hasDescription() : bool

public hasDescription() : bool

Summary

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

Details:

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

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

public hasFraudData() : bool

public hasFraudData() : bool

Summary

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

Details:

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

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

public hasMerchantCustomerId() : bool

public hasMerchantCustomerId() : bool

Summary

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

Details:

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

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

public hasMetadata() : bool

public hasMetadata() : bool

Summary

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

Details:

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

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

public hasPaymentMethodData() : bool

public hasPaymentMethodData() : bool

Summary

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

Details:

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

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

public hasPaymentMethodId() : bool

public hasPaymentMethodId() : bool

Summary

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

Details:

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

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

public hasPaymentToken() : bool

public hasPaymentToken() : bool

Summary

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

Details:

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

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

public hasReceipt() : bool

public hasReceipt() : bool

Summary

Проверяет наличие чека

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

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

public hasRecipient() : bool

public hasRecipient() : bool

Summary

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

Details:

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

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

public hasSavePaymentMethod() : bool

public hasSavePaymentMethod() : bool

Summary

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

Details:

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

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

public hasTransfers() : bool

public hasTransfers() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

Returns: bool -

public jsonSerialize() : mixed

public jsonSerialize() : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: mixed -

public offsetExists() : mixed

public offsetExists(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetGet() : mixed

public offsetGet(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetSet() : mixed

public offsetSet(mixed $offset, mixed $value) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset
mixed	value

Returns: mixed -

public offsetUnset() : mixed

public offsetUnset(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public removeReceipt() : mixed

public removeReceipt() : mixed

Summary

Удаляет чек из запроса

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

Returns: mixed -

public setAirline() : mixed

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

Summary

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

Details:

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

Parameters:

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

Returns: mixed -

public setAmount() : mixed

public setAmount(\YooKassa\Model\AmountInterface $value) : mixed

Summary

Устанавливает сумму оплаты

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

Parameters:

Type	Name	Description
\YooKassa\Model\AmountInterface	value	Сумма оплаты

Returns: mixed -

public setCapture() : mixed

public setCapture(bool $value) : mixed

Summary

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

Details:

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

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Генерируется если переданный аргумент не кастится в bool

Returns: mixed -

public setClientIp() : mixed

public setClientIp(string $value) : mixed

Summary

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

Details:

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

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданный аргумент не является строкой

Returns: mixed -

public setConfirmation() : mixed

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

Summary

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

Details:

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

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданное значение не является объектом типа AbstractConfirmationAttributes или null

Returns: mixed -

public setDeal() : mixed

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

Summary

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

Details:

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

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданные данные не удалось интерпретировать как метаданные платежа

Returns: mixed -

public setDescription() : mixed

public setDescription(string $value) : mixed

Summary

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

Details:

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

Parameters:

Type	Name	Description
string	value

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если переданное значение превышает допустимую длину
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданное значение не является строкой

Returns: mixed -

public setFraudData() : mixed

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

Summary

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

Details:

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

Parameters:

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

Returns: mixed -

public setMerchantCustomerId() : mixed

public setMerchantCustomerId(string $value) : mixed

Summary

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

Details:

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

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданный аргумент не является строкой

Returns: mixed -

public setMetadata() : mixed

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

Summary

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

Details:

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

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданные данные не удалось интерпретировать как метаданные платежа

Returns: mixed -

public setPaymentMethodData() : mixed

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

Summary

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

Details:

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

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если был передан объект невалидного типа

Returns: mixed -

public setPaymentMethodId() : mixed

public setPaymentMethodId(string $value) : mixed

Summary

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

Details:

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

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Генерируется если переданные значение не является строкой или null

Returns: mixed -

public setPaymentToken() : mixed

public setPaymentToken(string $value) : mixed

Summary

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

Details:

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

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если переданное значение превышает допустимую длину
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданное значение не является строкой

Returns: mixed -

public setReceipt() : mixed

public setReceipt(\YooKassa\Model\ReceiptInterface|null $value) : mixed

Summary

Устанавливает чек

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

Parameters:

Type	Name	Description
\YooKassa\Model\ReceiptInterface OR null	value	Инстанс чека или null для удаления информации о чеке

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если передан не инстанс класса чека и не null

Returns: mixed -

public setRecipient() : mixed

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

Summary

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

Details:

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

Parameters:

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

Returns: mixed -

public setSavePaymentMethod() : mixed

public setSavePaymentMethod(bool $value) : mixed

Summary

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

Details:

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

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Генерируется если переданный аргумент не кастится в bool

Returns: mixed -

public setTransfers() : mixed

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

Summary

Устанавливает transfers (массив распределения денег между магазинами)

Details:

• Inherited From: \YooKassa\Common\AbstractPaymentRequest

Parameters:

Type	Name	Description
\YooKassa\Model\TransferInterface[] OR array OR null	value

Returns: mixed -

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\Payments\CreatePaymentRequest

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

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

protected setValidationError() : mixed

protected setValidationError(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Parameters:

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

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