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

54 KiB

YooKassa API SDK

Class: \YooKassa\Request\Receipts\CreatePostReceiptRequest

Namespace: \YooKassa\Request\Receipts


Summary:

Класс объекта запроса к API на создание чека.


Examples

Пример использования билдера

try {
    $receiptBuilder = \YooKassa\Request\Receipts\CreatePostReceiptRequest::builder();
    $receiptBuilder->setType(\YooKassa\Model\Receipt\ReceiptType::PAYMENT)
        ->setObjectId('24b94598-000f-5000-9000-1b68e7b15f3f', \YooKassa\Model\Receipt\ReceiptType::PAYMENT) // payment_id
        ->setCustomer([
            'email' => 'john.doe@merchant.com',
            'phone' => '71111111111',
        ])
        ->setItems([
            [
                'description' => 'Платок Gucci',
                'quantity' => '1.00',
                'amount' => [
                    'value' => '3000.00',
                    'currency' => 'RUB',
                ],
                'vat_code' => 2,
                'payment_mode' => 'full_payment',
                'payment_subject' => 'commodity',
            ],
        ])
        ->addSettlement([
            [
                'type' => 'prepayment',
                'amount' => [
                    'value' => 100.00,
                    'currency' => 'RUB',
                ],
            ],
        ])
        ->setSend(true)
    ;

    // Создаем объект запроса
    $request = $receiptBuilder->build();

    // Можно изменить данные, если нужно
    $request->setOnBehalfOf('159753');
    $request->getitems()->add(new \YooKassa\Model\Receipt\ReceiptItem([
        'description' => 'Платок Gucci Новый',
        'quantity' => '1.00',
        'amount' => [
            'value' => '3500.00',
            'currency' => 'RUB',
        ],
        'vat_code' => 2,
        'payment_mode' => 'full_payment',
        'payment_subject' => 'commodity',
    ]));

    $idempotenceKey = uniqid('', true);
    $response = $client->createReceipt($request, $idempotenceKey);
} catch (Exception $e) {
    $response = $e;
}

var_dump($response);


Constants

  • No constants found

Properties

Visibility Name Flag Summary
public $additional_user_props Дополнительный реквизит пользователя.
public $additionalUserProps Дополнительный реквизит пользователя.
public $customer Информация о плательщике
public $internet Признак проведения платежа в интернете (тег в 54 ФЗ — 1125) — указывает на оплату через интернет.
public $items Список товаров в заказе: для Чеков от ЮKassa — не более 80 товаров, для сторонних онлайн-касс — не более 100 товаров.
public $object_id Идентификатор объекта оплаты
public $object_type Тип объекта: приход "payment" или возврат "refund".
public $objectId Идентификатор объекта оплаты
public $objectType Тип объекта: приход "payment" или возврат "refund".
public $on_behalf_of Идентификатор магазина в ЮKassa.
public $onBehalfOf Идентификатор магазина в ЮKassa.
public $receipt_industry_details Отраслевой реквизит предмета расчета.
public $receipt_operational_details Операционный реквизит чека.
public $receiptIndustryDetails Отраслевой реквизит предмета расчета.
public $receiptOperationalDetails Операционный реквизит чека.
public $send Формирование чека в онлайн-кассе сразу после создания объекта чека. Сейчас можно передать только значение ~true.
public $settlements Список платежей
public $tax_system_code Система налогообложения магазина (тег в 54 ФЗ — 1055).
public $taxSystemCode Система налогообложения магазина (тег в 54 ФЗ — 1055).
public $timezone Номер часовой зоны для адреса, по которому вы принимаете платежи (тег в 54 ФЗ — 1011).
public $type Тип чека в онлайн-кассе: приход "payment" или возврат "refund".

Methods

Visibility Name Flag Summary
public __construct() AbstractObject constructor.
public __get() Возвращает значение свойства.
public __isset() Проверяет наличие свойства.
public __set() Устанавливает значение свойства.
public __unset() Удаляет свойство.
public builder() Возвращает билдер объектов запросов создания платежа.
public clearValidationError() Очищает статус валидации текущего запроса.
public fromArray() Устанавливает значения свойств текущего объекта из массива.
public getAdditionalUserProps() Возвращает дополнительный реквизит пользователя.
public getCustomer() Возвращает информацию о плательщике.
public getInternet() Возвращает признак проведения платежа в интернете.
public getItems() Возвращает список позиций в текущем чеке.
public getLastValidationError() Возвращает последнюю ошибку валидации.
public getObjectId() Возвращает Id объекта чека.
public getObjectType() Возвращает тип объекта чека.
public getOnBehalfOf() Возвращает идентификатор магазина, от имени которого нужно отправить чек.
public getReceiptIndustryDetails() Возвращает отраслевой реквизит чека.
public getReceiptOperationalDetails() Возвращает операционный реквизит чека.
public getSend() Возвращает признак отложенной отправки чека.
public getSettlements() Возвращает массив оплат, обеспечивающих выдачу товара.
public getTaxSystemCode() Возвращает код системы налогообложения.
public getTimezone() Возвращает номер часовой зоны.
public getType() Возвращает тип чека в онлайн-кассе.
public getValidator()
public hasCustomer() Проверяет наличие данных о плательщике.
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public notEmpty() Проверяет есть ли в чеке хотя бы одна позиция товаров и оплат
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public setAdditionalUserProps() Устанавливает дополнительный реквизит пользователя.
public setCustomer() Устанавливает информацию о плательщике.
public setInternet() Устанавливает признак проведения платежа в интернете.
public setItems() Устанавливает список позиций в чеке.
public setObjectId() Устанавливает Id объекта чека.
public setObjectType() Устанавливает тип объекта чека.
public setOnBehalfOf() Устанавливает идентификатор магазина, от имени которого нужно отправить чек.
public setReceiptIndustryDetails() Устанавливает отраслевой реквизит чека.
public setReceiptOperationalDetails() Устанавливает операционный реквизит чека.
public setSend() Устанавливает признак отложенной отправки чека.
public setSettlements() Устанавливает массив оплат, обеспечивающих выдачу товара.
public setTaxSystemCode() Устанавливает код системы налогообложения.
public setTimezone() Устанавливает номер часовой зоны.
public setType() Устанавливает тип чека в онлайн-кассе.
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
public validate() Валидирует текущий запрос, проверяет все ли нужные свойства установлены.
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected setValidationError() Устанавливает ошибку валидации.
protected validatePropertyValue()

Details


Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Properties

public $additional_user_props : \YooKassa\Model\Receipt\AdditionalUserProps


Description

Дополнительный реквизит пользователя.

Type: AdditionalUserProps

Details:

public $additionalUserProps : \YooKassa\Model\Receipt\AdditionalUserProps


Description

Дополнительный реквизит пользователя.

Type: AdditionalUserProps

Details:

public $customer : \YooKassa\Model\Receipt\ReceiptCustomer


Description

Информация о плательщике

Type: ReceiptCustomer

Details:

public $internet : bool


Description

Признак проведения платежа в интернете (тег в 54 ФЗ — 1125) — указывает на оплату через интернет.

Type: bool

Details:

public $items : \YooKassa\Model\Receipt\ReceiptItemInterface[]|\YooKassa\Common\ListObjectInterface


Description

Список товаров в заказе: для Чеков от ЮKassa — не более 80 товаров, для сторонних онлайн-касс — не более 100 товаров.

Type: ListObjectInterface

Details:

public $object_id : string


Description

Идентификатор объекта оплаты

Type: string

Details:

public $object_type : string


Description

Тип объекта: приход "payment" или возврат "refund".

Type: string

Details:

public $objectId : string


Description

Идентификатор объекта оплаты

Type: string

Details:

public $objectType : string


Description

Тип объекта: приход "payment" или возврат "refund".

Type: string

Details:

public $on_behalf_of : string


Description

Идентификатор магазина в ЮKassa.

Type: string

Details:

public $onBehalfOf : string


Description

Идентификатор магазина в ЮKassa.

Type: string

Details:

public $receipt_industry_details : \YooKassa\Model\Receipt\IndustryDetails[]|\YooKassa\Common\ListObjectInterface


Description

Отраслевой реквизит предмета расчета.

Type: ListObjectInterface

Details:

public $receipt_operational_details : \YooKassa\Model\Receipt\OperationalDetails


Description

Операционный реквизит чека.

Type: OperationalDetails

Details:

public $receiptIndustryDetails : \YooKassa\Model\Receipt\IndustryDetails[]|\YooKassa\Common\ListObjectInterface


Description

Отраслевой реквизит предмета расчета.

Type: ListObjectInterface

Details:

public $receiptOperationalDetails : \YooKassa\Model\Receipt\OperationalDetails


Description

Операционный реквизит чека.

Type: OperationalDetails

Details:

public $send : bool


Description

Формирование чека в онлайн-кассе сразу после создания объекта чека. Сейчас можно передать только значение ~true.

Type: bool

Details:

public $settlements : \YooKassa\Model\Receipt\SettlementInterface[]|\YooKassa\Common\ListObjectInterface


Description

Список платежей

Type: ListObjectInterface

Details:

public $tax_system_code : int


Description

Система налогообложения магазина (тег в 54 ФЗ — 1055).

Type: int

Details:

public $taxSystemCode : int


Description

Система налогообложения магазина (тег в 54 ФЗ — 1055).

Type: int

Details:

public $timezone : int


Description

Номер часовой зоны для адреса, по которому вы принимаете платежи (тег в 54 ФЗ — 1011).

Type: int

Details:

public $type : string


Description

Тип чека в онлайн-кассе: приход "payment" или возврат "refund".

Type: string

Details:


Methods

public __construct() : mixed

public __construct(array|null $data = []) : mixed

Summary

AbstractObject constructor.

Details:

Parameters:
Type Name Description
array OR null data

Returns: mixed -

public __get() : mixed

public __get(string $propertyName) : mixed

Summary

Возвращает значение свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя свойства

Returns: mixed - Значение свойства

public __isset() : bool

public __isset(string $propertyName) : bool

Summary

Проверяет наличие свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public __set() : void

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

Summary

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

Details:

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

Returns: void -

public __unset() : void

public __unset(string $propertyName) : void

Summary

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

Details:

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

Returns: void -

public builder() : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder

Static public builder() : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder

Summary

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

Details:

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

public clearValidationError() : void

public clearValidationError() : void

Summary

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

Details:

Returns: void -

public fromArray() : void

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

Summary

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

Details:

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

Returns: void -

public getAdditionalUserProps() : \YooKassa\Model\Receipt\AdditionalUserProps|null

public getAdditionalUserProps() : \YooKassa\Model\Receipt\AdditionalUserProps|null

Summary

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

Details:

Returns: \YooKassa\Model\Receipt\AdditionalUserProps|null - Дополнительный реквизит пользователя

public getCustomer() : \YooKassa\Model\Receipt\ReceiptCustomerInterface|null

public getCustomer() : \YooKassa\Model\Receipt\ReceiptCustomerInterface|null

Summary

Возвращает информацию о плательщике.

Details:

Returns: \YooKassa\Model\Receipt\ReceiptCustomerInterface|null - Информация о плательщике

public getInternet() : bool|null

public getInternet() : bool|null

Summary

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

Details:

Returns: bool|null - Признак проведения платежа в интернете

public getItems() : \YooKassa\Model\Receipt\ReceiptItemInterface[]|\YooKassa\Common\ListObjectInterface

public getItems() : \YooKassa\Model\Receipt\ReceiptItemInterface[]|\YooKassa\Common\ListObjectInterface

Summary

Возвращает список позиций в текущем чеке.

Details:

Returns: \YooKassa\Model\Receipt\ReceiptItemInterface[]|\YooKassa\Common\ListObjectInterface - Список товаров в заказе

public getLastValidationError() : string|null

public getLastValidationError() : string|null

Summary

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

Details:

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

public getObjectId() : string|null

public getObjectId() : string|null

Summary

Возвращает Id объекта чека.

Details:

Returns: string|null - Id объекта чека

public getObjectType() : string|null

public getObjectType() : string|null

Summary

Возвращает тип объекта чека.

Details:

Returns: string|null - Тип объекта чека

public getOnBehalfOf() : string|null

public getOnBehalfOf() : string|null

Summary

Возвращает идентификатор магазина, от имени которого нужно отправить чек.

Description

Выдается ЮKassa, отображается в разделе Продавцы личного кабинета (столбец shopId). Необходимо передавать, если вы используете решение ЮKassa для платформ.

Details:

Returns: string|null -

public getReceiptIndustryDetails() : \YooKassa\Model\Receipt\IndustryDetails[]|\YooKassa\Common\ListObjectInterface

public getReceiptIndustryDetails() : \YooKassa\Model\Receipt\IndustryDetails[]|\YooKassa\Common\ListObjectInterface

Summary

Возвращает отраслевой реквизит чека.

Details:

Returns: \YooKassa\Model\Receipt\IndustryDetails[]|\YooKassa\Common\ListObjectInterface - Отраслевой реквизит чека

public getReceiptOperationalDetails() : \YooKassa\Model\Receipt\OperationalDetails|null

public getReceiptOperationalDetails() : \YooKassa\Model\Receipt\OperationalDetails|null

Summary

Возвращает операционный реквизит чека.

Details:

Returns: \YooKassa\Model\Receipt\OperationalDetails|null - Операционный реквизит чека

public getSend() : bool

public getSend() : bool

Summary

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

Details:

Returns: bool - Признак отложенной отправки чека

public getSettlements() : \YooKassa\Model\Receipt\SettlementInterface[]|\YooKassa\Common\ListObjectInterface

public getSettlements() : \YooKassa\Model\Receipt\SettlementInterface[]|\YooKassa\Common\ListObjectInterface

Summary

Возвращает массив оплат, обеспечивающих выдачу товара.

Details:

Returns: \YooKassa\Model\Receipt\SettlementInterface[]|\YooKassa\Common\ListObjectInterface - Массив оплат, обеспечивающих выдачу товара

public getTaxSystemCode() : int|null

public getTaxSystemCode() : int|null

Summary

Возвращает код системы налогообложения.

Details:

Returns: int|null - Код системы налогообложения. Число 1-6.

public getTimezone() : int|null

public getTimezone() : int|null

Summary

Возвращает номер часовой зоны.

Details:

Returns: int|null - Номер часовой зоны

public getType() : string|null

public getType() : string|null

Summary

Возвращает тип чека в онлайн-кассе.

Details:

Returns: string|null - Тип чека в онлайн-кассе: приход "payment" или возврат "refund"

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

public hasCustomer() : bool

public hasCustomer() : bool

Summary

Проверяет наличие данных о плательщике.

Details:

Returns: bool -

public jsonSerialize() : array

public jsonSerialize() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.

Details:

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

public notEmpty() : bool

public notEmpty() : bool

Summary

Проверяет есть ли в чеке хотя бы одна позиция товаров и оплат

Details:

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

public offsetExists() : bool

public offsetExists(string $offset) : bool

Summary

Проверяет наличие свойства.

Details:

Parameters:
Type Name Description
string offset Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public offsetGet() : mixed

public offsetGet(string $offset) : mixed

Summary

Возвращает значение свойства.

Details:

Parameters:
Type Name Description
string offset Имя свойства

Returns: mixed - Значение свойства

public offsetSet() : void

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

Summary

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

Details:

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

Returns: void -

public offsetUnset() : void

public offsetUnset(string $offset) : void

Summary

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

Details:

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

Returns: void -

public setAdditionalUserProps() : self

public setAdditionalUserProps(null|\YooKassa\Model\Receipt\AdditionalUserProps|array $additional_user_props = null) : self

Summary

Устанавливает дополнительный реквизит пользователя.

Details:

Parameters:
Type Name Description
null OR \YooKassa\Model\Receipt\AdditionalUserProps OR array additional_user_props Дополнительный реквизит пользователя

Returns: self -

public setCustomer() : self

public setCustomer(array|\YooKassa\Model\Receipt\ReceiptCustomerInterface $customer = null) : self

Summary

Устанавливает информацию о плательщике.

Details:

Parameters:
Type Name Description
array OR \YooKassa\Model\Receipt\ReceiptCustomerInterface customer Информация о плательщике

Returns: self -

public setInternet() : self

public setInternet(bool|null $internet = null) : self

Summary

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

Details:

Parameters:
Type Name Description
bool OR null internet Признак проведения платежа в интернете (тег в 54 ФЗ — 1125) — указывает на оплату через интернет.

Returns: self -

public setItems() : self

public setItems(array|\YooKassa\Common\ListObjectInterface $items = null) : self

Summary

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

Description

Если до этого в чеке уже были установлены значения, они удаляются и полностью заменяются переданным списком позиций. Все передаваемые значения в массиве позиций должны быть объектами класса, реализующего интерфейс ReceiptItemInterface, в противном случае будет выброшено исключение InvalidPropertyValueTypeException.

Details:

Parameters:
Type Name Description
array OR \YooKassa\Common\ListObjectInterface items Список товаров в заказе: для Чеков от ЮKassa — не более 80 товаров, для сторонних онлайн-касс — не более 100 товаров.

Returns: self -

public setObjectId() : \YooKassa\Request\Receipts\CreatePostReceiptRequest

public setObjectId(string|null $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequest

Summary

Устанавливает Id объекта чека.

Details:

Parameters:
Type Name Description
string OR null value Id объекта чека

Returns: \YooKassa\Request\Receipts\CreatePostReceiptRequest -

public setObjectType() : \YooKassa\Request\Receipts\CreatePostReceiptRequest

public setObjectType(string|null $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequest

Summary

Устанавливает тип объекта чека.

Details:

Parameters:
Type Name Description
string OR null value Тип объекта чека

Returns: \YooKassa\Request\Receipts\CreatePostReceiptRequest -

public setOnBehalfOf() : self

public setOnBehalfOf(string|null $on_behalf_of = null) : self

Summary

Устанавливает идентификатор магазина, от имени которого нужно отправить чек.

Description

Выдается ЮKassa, отображается в разделе Продавцы личного кабинета (столбец shopId). Необходимо передавать, если вы используете решение ЮKassa для платформ.

Details:

Parameters:
Type Name Description
string OR null on_behalf_of

Returns: self -

public setReceiptIndustryDetails() : self

public setReceiptIndustryDetails(null|array|\YooKassa\Common\ListObjectInterface $receipt_industry_details = null) : self

Summary

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

Details:

Parameters:
Type Name Description
null OR array OR \YooKassa\Common\ListObjectInterface receipt_industry_details Отраслевой реквизит чека

Returns: self -

public setReceiptOperationalDetails() : self

public setReceiptOperationalDetails(array|\YooKassa\Model\Receipt\OperationalDetails|null $receipt_operational_details = null) : self

Summary

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

Details:

Parameters:
Type Name Description
array OR \YooKassa\Model\Receipt\OperationalDetails OR null receipt_operational_details Операционный реквизит чека

Returns: self -

public setSend() : self

public setSend(bool $send = null) : self

Summary

Устанавливает признак отложенной отправки чека.

Details:

Parameters:
Type Name Description
bool send Признак отложенной отправки чека

Returns: self -

public setSettlements() : self

public setSettlements(array|\YooKassa\Common\ListObjectInterface|null $settlements = null) : self

Summary

Устанавливает массив оплат, обеспечивающих выдачу товара.

Details:

Parameters:
Type Name Description
array OR \YooKassa\Common\ListObjectInterface OR null settlements Массив оплат, обеспечивающих выдачу товара

Returns: self -

public setTaxSystemCode() : self

public setTaxSystemCode(int|null $tax_system_code = null) : self

Summary

Устанавливает код системы налогообложения.

Details:

Parameters:
Type Name Description
int OR null tax_system_code Код системы налогообложения. Число 1-6

Returns: self -

public setTimezone() : self

public setTimezone(int|null $timezone = null) : self

Summary

Устанавливает номер часовой зоны.

Details:

Parameters:
Type Name Description
int OR null timezone Номер часовой зоны для адреса, по которому вы принимаете платежи (тег в 54 ФЗ — 1011).

Returns: self -

public setType() : self

public setType(string|null $type = null) : self

Summary

Устанавливает тип чека в онлайн-кассе.

Details:

Parameters:
Type Name Description
string OR null type тип чека в онлайн-кассе: приход "payment" или возврат "refund"

Returns: self -

public toArray() : array

public toArray() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().

Details:

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

public validate() : bool

public validate() : bool

Summary

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

Details:

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

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

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

protected setValidationError() : void

protected setValidationError(string $value) : void

Summary

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

Details:

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

Returns: void -

protected validatePropertyValue() : mixed

protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed

Details:

Parameters:
Type Name Description
string propertyName
mixed propertyValue

Returns: mixed -


Top Namespaces


Reports


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

© 2026 YooMoney