Евгений Ю. Лозный
260d13f890
Добавлены нулевые привязки по СБП Добавлена причина отмены возвратов `payment_expired`
18 KiB
YooKassa API SDK
Interface: CreateInvoiceRequestInterface
Namespace: \YooKassa\Request\Invoices
Summary:
Класс, представляющий модель CreateInvoiceRequest.
Constants
- No constants found
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | clearValidationError() | Очищает статус валидации текущего запроса. | |
| public | getCart() | Возвращает cart. | |
| public | getDeliveryMethodData() | Возвращает delivery_method_data. | |
| public | getDescription() | Возвращает description. | |
| public | getExpiresAt() | Возвращает expires_at. | |
| public | getLastValidationError() | Возвращает последнюю ошибку валидации. | |
| public | getLocale() | Возвращает locale. | |
| public | getMetadata() | Возвращает metadata. | |
| public | getPaymentData() | Возвращает payment_data. | |
| public | setCart() | Устанавливает cart. | |
| public | setDeliveryMethodData() | Устанавливает delivery_method_data. | |
| public | setDescription() | Устанавливает description. | |
| public | setExpiresAt() | Устанавливает expires_at. | |
| public | setLocale() | Устанавливает locale. | |
| public | setMetadata() | Устанавливает metadata. | |
| public | setPaymentData() | Устанавливает payment_data. | |
| public | validate() | Валидирует текущий запрос, проверяет все ли нужные свойства установлены. |
Details
- File: lib/Request/Invoices/CreateInvoiceRequestInterface.php
- Package: \YooKassa\Model
- Parents:
- See Also:
Tags
| Tag | Version | Description |
|---|---|---|
| category | Class | |
| author | cms@yoomoney.ru | |
| property | Данные для проведения платежа по выставленному счету. | |
| property | Корзина заказа — список товаров или услуг, который отобразится на странице счета перед оплатой. | |
| property | Данные о способе доставки счета пользователю. Доступен только один способ — самостоятельная доставка: ЮKassa возвращает вам ссылку на счет, и вы передаете ее пользователю любым удобным для вас способом. | |
| property | Срок действия счета — дата и время, до которых можно оплатить выставленный счет. Указывается по UTC и передается в формате ISO 8601. Пример: ~2024-10-18T10:51:18.139Z |
|
| property | Язык интерфейса, писем и смс, которые будет видеть или получать пользователь. Формат соответствует ISO/IEC 15897. Возможные значения: ru_RU, en_US. Регистр важен. | |
| property | Описание выставленного счета (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь на странице счета. Например: «Счет на оплату по договору 37». | |
| 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 getPaymentData() : \YooKassa\Request\Invoices\PaymentData|null
public getPaymentData() : \YooKassa\Request\Invoices\PaymentData|null
Summary
Возвращает payment_data.
Details:
- Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Returns: \YooKassa\Request\Invoices\PaymentData|null - Данные для проведения платежа по выставленному счету
public setPaymentData() : \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
public setPaymentData(\YooKassa\Request\Invoices\PaymentData|array|null $payment_data = null) : \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Summary
Устанавливает payment_data.
Details:
- Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Request\Invoices\PaymentData OR array OR null |
payment_data | Данные для проведения платежа по выставленному счету |
Returns: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface -
public getCart() : \YooKassa\Model\Invoice\LineItem[]|\YooKassa\Common\ListObjectInterface
public getCart() : \YooKassa\Model\Invoice\LineItem[]|\YooKassa\Common\ListObjectInterface
Summary
Возвращает cart.
Details:
- Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Returns: \YooKassa\Model\Invoice\LineItem[]|\YooKassa\Common\ListObjectInterface - Корзина заказа — список товаров или услуг
public setCart() : \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
public setCart(\YooKassa\Common\ListObjectInterface|array|null $cart = null) : \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Summary
Устанавливает cart.
Details:
- Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Common\ListObjectInterface OR array OR null |
cart | Корзина заказа — список товаров или услуг, который отобразится на странице счета перед оплатой. |
Returns: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface -
public getDeliveryMethodData() : \YooKassa\Request\Invoices\DeliveryMethodData\AbstractDeliveryMethodData|null
public getDeliveryMethodData() : \YooKassa\Request\Invoices\DeliveryMethodData\AbstractDeliveryMethodData|null
Summary
Возвращает delivery_method_data.
Details:
- Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Returns: \YooKassa\Request\Invoices\DeliveryMethodData\AbstractDeliveryMethodData|null - Данные о способе доставки счета пользователю
public setDeliveryMethodData() : \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
public setDeliveryMethodData(\YooKassa\Request\Invoices\DeliveryMethodData\AbstractDeliveryMethodData|array|null $delivery_method_data = null) : \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Summary
Устанавливает delivery_method_data.
Details:
- Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Request\Invoices\DeliveryMethodData\AbstractDeliveryMethodData OR array OR null |
delivery_method_data | Данные о способе доставки счета пользователю |
Returns: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface -
public getExpiresAt() : \DateTime|null
public getExpiresAt() : \DateTime|null
Summary
Возвращает expires_at.
Details:
- Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Returns: \DateTime|null - Срок действия счета
public setExpiresAt() : \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
public setExpiresAt(\DateTime|string|null $expires_at = null) : \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Summary
Устанавливает expires_at.
Details:
- Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR null |
expires_at | Срок действия счета — дата и время, до которых можно оплатить выставленный счет. Указывается по UTC и передается в формате ISO 8601. Пример: ~2024-10-18T10:51:18.139Z |
Returns: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface -
public getLocale() : string|null
public getLocale() : string|null
Summary
Возвращает locale.
Details:
- Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Returns: string|null - Язык интерфейса, писем и смс, которые будет видеть или получать пользователь
public setLocale() : \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
public setLocale(string|null $locale = null) : \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Summary
Устанавливает locale.
Details:
- Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
locale | Язык интерфейса, писем и смс, которые будет видеть или получать пользователь |
Returns: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface -
public getDescription() : string|null
public getDescription() : string|null
Summary
Возвращает description.
Details:
- Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Returns: string|null - Описание выставленного счета
public setDescription() : \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
public setDescription(string|null $description = null) : \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Summary
Устанавливает description.
Details:
- Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
description | Описание выставленного счета (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь на странице счета. Например: «Счет на оплату по договору 37». |
Returns: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface -
public getMetadata() : \YooKassa\Model\Metadata|null
public getMetadata() : \YooKassa\Model\Metadata|null
Summary
Возвращает metadata.
Details:
- Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Returns: \YooKassa\Model\Metadata|null - Любые дополнительные данные
public setMetadata() : \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
public setMetadata(\YooKassa\Model\Metadata|array|null $metadata = null) : \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Summary
Устанавливает metadata.
Details:
- Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\Metadata OR array OR null |
metadata | Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. |
Returns: \YooKassa\Request\Invoices\CreateInvoiceRequestInterface -
Top Namespaces
Reports
This document was automatically generated from source code comments on 2026-06-29 using phpDocumentor
© 2026 YooMoney