Чеки

Создание чека

Используйте этот запрос при оплате с соблюдением требований 54-ФЗ: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/basics, чтобы создать чек зачета предоплаты. Если вы работаете по сценарию Сначала платеж, потом чек: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/basics#receipt-after-payment, в запросе также нужно передавать данные для формирования чека прихода и чека возврата прихода.

post/receipts

Headers

Idempotence-Keystring required

Request body

type'payment' | 'refund' required

Тип чека в онлайн-кассе. Возможные значения: payment (приход), refund (возврат прихода).

payment_idstring

Идентификатор платежа в ЮKassa для отображения информации о чеке в личном кабинете: https://yookassa.ru/my/payments, на платеж не влияет. Обязательный параметр при создании чека прихода: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/payments#create-receipt (тип чека — payment, статус платежа — waiting_for_capture или succeeded) и при создании чека возврата прихода: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/payments#payment-receipt-part-capture для отмененного или частично подтвержденного платежа (тип чека — refund, статус платежа — canceled или succeeded). Для одного платежа можно создать не более 30 чеков.

refund_idstring

Идентификатор возврата в ЮKassa для отображения информации о чеке в личном кабинете: https://yookassa.ru/my. Обязательный параметр при создании чека возврата прихода: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/refunds#after-refund (если тип чека — refund, статус возврата — succeeded). Для одного возврата можно создать не более 30 чеков.

internetboolean

Признак проведения платежа в интернете (тег в 54 ФЗ — 1125) — указывает на оплату через интернет. Возможные значения: true — оплата прошла онлайн, через интернет (например, на вашем сайте или в приложении); false — оплата прошла офлайн, при личном взаимодействии (например, в торговой точке или при встрече с курьером). По умолчанию true. Если вы принимаете платежи офлайн, передайте в запросе значение false.

sendboolean required

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

tax_system_codeinteger

Система налогообложения магазина (тег в 54 ФЗ — 1055). Для сторонних онлайн-касс: обязательный параметр, если вы используете онлайн-кассу Атол Онлайн, обновленную до ФФД 1.2, или у вас несколько систем налогообложения, в остальных случаях не передается. Перечень возможных значений: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#tax-systems Для Чеков от ЮKassa: параметр передавать не нужно, ЮKassa его проигнорирует.

timezoneinteger

Номер часовой зоны для адреса, по которому вы принимаете платежи (тег в 54 ФЗ — 1011). Указывается, только если в чеке есть товары, которые подлежат обязательной маркировке (в items.mark_code_info передается параметр gs_1m, short или fur). Перечень возможных значений: для Чеков от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/parameters-values#timezone; для сторонних онлайн-касс: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#timezone.

on_behalf_ofstring

Идентификатор магазина, от имени которого нужно отправить чек. Выдается ЮKassa, отображается в разделе Продавцы: https://yookassa.ru/my/marketplace/sellers личного кабинета (столбец shopId). Необходимо передавать, если вы используете Сплитование платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics.

Example request

{
  "payment_id": "1da5c87d-0984-50e8-a7f3-8de646dd9ec9",
  "refund_id": "1ddd77af-0bd7-500d-895b-c475c55fdefc",
  "customer": {
    "full_name": "Иванов Иван Иванович",
    "inn": "6321341814",
    "email": "user@yoomoney.ru",
    "phone": "79000000000"
  },
  "items": [
    {
      "amount": {
        "value": "1000.00",
        "currency": "RUB"
      },
      "quantity": 1,
      "measure": "piece",
      "mark_quantity": {
        "numerator": 1,
        "denominator": 100
      },
      "country_of_origin_code": "RU",
      "customs_declaration_number": "10714040/140917/0090376",
      "excise": "20.00",
      "product_code": "00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00",
      "mark_mode": "0",
      "payment_subject_industry_details": [
        {
          "federal_id": "001",
          "document_date": "2020-11-18",
          "value": "123/43"
        }
      ],
      "additional_payment_subject_props": "mdlp2/12&",
      "supplier": {
        "phone": "79000000000",
        "inn": "6321341814"
      }
    }
  ],
  "additional_user_props": {
    "name": "mdlp3108805",
    "value": "ps45102&dnАБV492&&781&dd181110&sid71752852194630&"
  },
  "receipt_industry_details": [
    {
      "federal_id": "001",
      "document_date": "2020-11-18",
      "value": "123/43"
    }
  ],
  "receipt_operational_details": {
    "created_at": "2020-07-03T11:52:31.827Z"
  },
  "settlements": [
    {
      "amount": {
        "value": "1000.00",
        "currency": "RUB"
      }
    }
  ],
  "on_behalf_of": "123"
}

Response

Запрос успешно обработан

idstring required

Идентификатор чека в ЮKassa.

type'payment' | 'refund' required

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

payment_idstring

Идентификатор платежа: https://yookassa.ru/developers/api#payment_object, для которого был сформирован чек.

refund_idstring

Идентификатор возврата: https://yookassa.ru/developers/api#refund_object, для которого был сформирован чек. Отсутствует в чеке платежа.

status'pending' | 'succeeded' | 'canceled' required

Статус доставки данных для чека в онлайн-кассу. Возможные значения: pending — данные в обработке; succeeded — чек успешно зарегистрирован; canceled — чек зарегистрировать не удалось; если используете Чеки от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/basics, обратитесь в техническую поддержку, в остальных случаях сформируйте чек вручную.

fiscal_document_numberstring

Номер фискального документа.

fiscal_storage_numberstring

Номер фискального накопителя в кассовом аппарате.

fiscal_attributestring

Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека.

registered_atstring date-time

Дата и время формирования чека в фискальном накопителе. Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601.

fiscal_provider_idstring

Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать.

internetboolean

Признак проведения платежа в интернете (тег в 54 ФЗ — 1125) — указывает на оплату через интернет. Возможные значения: true — оплата прошла онлайн, через интернет (например, на вашем сайте или в приложении); false — оплата прошла офлайн, при личном взаимодействии (например, в торговой точке или при встрече с курьером). По умолчанию true. Если вы принимаете платежи офлайн, передайте в запросе значение false.

on_behalf_ofstring

Идентификатор магазина, от имени которого нужно отправить чек. Выдается ЮKassa. Присутствует, если вы используете Сплитование платежей: https://yookassa.ru/developers/solutions-for-platforms/split-payments/basics.

tax_system_codeinteger

Система налогообложения магазина (тег в 54 ФЗ — 1055). Для сторонних онлайн-касс: обязательный параметр, если вы используете онлайн-кассу Атол Онлайн, обновленную до ФФД 1.2, или у вас несколько систем налогообложения, в остальных случаях не передается. Перечень возможных значений: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#tax-systems Для Чеков от ЮKassa: параметр передавать не нужно, ЮKassa его проигнорирует.

timezoneinteger

Номер часовой зоны для адреса, по которому вы принимаете платежи (тег в 54 ФЗ — 1011). Указывается, только если в чеке есть товары, которые подлежат обязательной маркировке (в items.mark_code_info передается параметр gs_1m, short или fur). Перечень возможных значений: для Чеков от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/parameters-values#timezone; для сторонних онлайн-касс: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/other-services/parameters-values#timezone.

Example response

{
  "id": "rt-1da5c87d-0984-50e8-a7f3-8de646dd9ec9",
  "payment_id": "215d8da0-000f-50be-b000-0003308c89be",
  "refund_id": "215d8da0-000f-50be-b000-0003308c89be",
  "status": "succeeded",
  "fiscal_document_number": "3986",
  "fiscal_storage_number": "9288000100115785",
  "fiscal_attribute": "2617603921",
  "registered_at": "2019-05-13T17:56:00.000+03:00",
  "fiscal_provider_id": "fd9e9404-eaca-4000-8ec9-dc228ead2345",
  "items": [
    {
      "quantity": 1,
      "amount": {
        "value": "1000.00",
        "currency": "RUB"
      },
      "country_of_origin_code": "RU",
      "customs_declaration_number": "10714040/140917/0090376",
      "excise": "20.00",
      "supplier": {
        "phone": "79000000000",
        "inn": "6321341814"
      },
      "measure": "piece",
      "payment_subject_industry_details": [
        {
          "federal_id": "001",
          "document_date": "2020-11-18",
          "value": "123/43"
        }
      ],
      "product_code": "00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00",
      "mark_mode": "0",
      "mark_quantity": {
        "numerator": 1,
        "denominator": 100
      }
    }
  ],
  "settlements": [
    {
      "amount": {
        "value": "1000.00",
        "currency": "RUB"
      }
    }
  ],
  "on_behalf_of": "123",
  "receipt_industry_details": [
    {
      "federal_id": "001",
      "document_date": "2020-11-18",
      "value": "123/43"
    }
  ],
  "receipt_operational_details": {
    "created_at": "2020-07-03T11:52:31.827Z"
  }
}

Changes