--- title: "Информация о счете" method: GET path: "/invoices/{invoice_id}" tags: ["Счета"] --- # Информация о счете `GET /invoices/{invoice_id}` Используйте этот запрос, чтобы получить информацию о текущем состоянии счета по его уникальному идентификатору. ## Path parameters - `invoice_id` string, required ## Response `200` Запрос успешно обработан - Invoice — Объект счета (Invoice) — актуальная информация о счете. - `id` string, required — Идентификатор счета в ЮKassa. - `status` 'pending' | 'succeeded' | 'canceled', required — Статус счета. Возможные значения: pending — счет создан и ожидает успешной оплаты; succeeded — счет успешно оплачен, есть связанный платеж в статусе succeeded (финальный и неизменяемый статус для платежей в одну стадию); canceled — вы отменили счет, успешный платеж по нему не поступил или был отменен (при оплате в две стадии) либо истек срок действия счета (финальный и неизменяемый статус). Подробнее про жизненный цикл счета: https://yookassa.ru/developers/payment-acceptance/scenario-extensions/invoices/basics#invoice-status - `cart` LineItem[], required — Корзина заказа — список товаров или услуг, который отобразится на странице счета перед оплатой. - `description` string, required — Название товара или услуги (от 1 до 128 символов). Пользователь увидит его на странице счета перед оплатой. - `price` object, required — Полная цена товара или услуги. Пользователь увидит ее на странице счета перед оплатой. - `value` string, required — Сумма в выбранной валюте. Всегда дробное значение. Разделитель дробной части — точка, разделитель тысяч отсутствует. Количество знаков после точки зависит от выбранной валюты. Пример: 1000.00. - `currency` 'RUB' | 'EUR' | 'USD' | 'KZT' | 'BYN' | 'UAH' | 'UZS' | 'TRY' | 'INR' | 'MDL' | 'AZN' | 'AMD', required — Трехбуквенный код валюты в формате ISO-4217: https://www.iso.org/iso-4217-currency-codes.html. Пример: RUB. - `discount_price` object — Итоговая цена товара с учетом скидки. Если передана, то на странице счета цена отобразится с учетом скидки. Не нужно передавать, если пользователь оплачивает полную стоимость товара или услуги. - `value` string, required — Сумма в выбранной валюте. Всегда дробное значение. Разделитель дробной части — точка, разделитель тысяч отсутствует. Количество знаков после точки зависит от выбранной валюты. Пример: 1000.00. - `currency` 'RUB' | 'EUR' | 'USD' | 'KZT' | 'BYN' | 'UAH' | 'UZS' | 'TRY' | 'INR' | 'MDL' | 'AZN' | 'AMD', required — Трехбуквенный код валюты в формате ISO-4217: https://www.iso.org/iso-4217-currency-codes.html. Пример: RUB. - `quantity` number, required — Количество товара. Можно передать целое или дробное число. Разделитель дробной части — точка, разделитель тысяч отсутствует, максимум три знака после точки. Пример: 5.000 - `delivery_method` union - DeliveryMethodSelf — Данные о выбранном способе доставки счета. Присутствует только для счетов в статусе pending. - `type` 'self' | 'sms' | 'email', required - `url` string — URL страницы счета, который необходимо передать пользователю для оплаты. Не более 2048 символов. - DeliveryMethodSms — Данные о выбранном способе доставки счета. Присутствует только для счетов в статусе pending. - `type` 'self' | 'sms' | 'email', required - DeliveryMethodEmail — Данные о выбранном способе доставки счета. Присутствует только для счетов в статусе pending. - `type` 'self' | 'sms' | 'email', required - `payment_details` PaymentDetails — Данные о платеже по выставленному счету. Присутствуют, только если платеж успешно подтвержден пользователем: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#user-confirmation. - `id` string, required — Идентификатор платежа в ЮKassa. - `status` 'pending' | 'waiting_for_capture' | 'succeeded' | 'canceled', required — Статус платежа. Возможные значения: waiting_for_capture — для платежей в две стадии: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-and-cancel: платеж оплачен, деньги авторизованы, вам необходимо списать оплату или отменить платеж; succeeded — платеж успешно завершен, деньги будут перечислены на ваш расчетный счет в соответствии с вашим договором с ЮKassa (финальный и неизменяемый статус); canceled — для платежей в две стадии: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#capture-and-cancel: вы отменили платеж по API (финальный и неизменяемый статус). - `created_at` string, date-time, required — Дата и время создания счета на оплату. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: 2017-11-03T11:52:31.827Z - `expires_at` string, date-time — Срок действия счета — дата и время, до которых можно оплатить выставленный счет. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: 2024-10-18T10:51:18.139Z Присутствует только для счетов в статусе pending. - `description` string — Описание выставленного счета (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь на странице счета. Например: «Счет на оплату по договору 37». - `cancellation_details` InvoiceCancellationDetails — Комментарий к статусу canceled: кто отменил счет и по какой причине. - `party` 'yoo_money' | 'merchant', required — Участник процесса, который принял решение об отмене счета. Возможные значения: merchant — продавец товаров и услуг (вы); yoo_money — ЮKassa. - `reason` 'invoice_canceled' | 'invoice_expired' | 'general_decline' | 'payment_canceled' | 'payment_expired_on_capture', required — Причина отмены счета. Возможные значения: invoice_canceled — счет отменен вручную: https://yookassa.ru/docs/support/merchant/invoices-to-clients/invoicing#invoicing__cancel из личного кабинета ЮKassa; invoice_expired — истек срок действия счета, который вы установили в запросе на создание счета в параметре expires_at, и по счету нет ни одного успешного платежа; general_decline — причина не детализирована, поэтому пользователю следует обратиться к инициатору отмены счета за уточнением подробностей; payment_canceled — платеж отменен по API: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#cancel при оплате в две стадии; payment_expired_on_capture — истек срок списания оплаты: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#hold для платежа в две стадии. - `metadata` Metadata — Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8. ## Other responses - `400` — Запрос не может быть обработан. Причиной может быть неправильный синтаксис запроса, ошибка в обязательных параметрах запроса, их отсутствие или неподдерживаемый метод. - `401` — В заголовке Authorization указан неверный ключ. - `403` — Секретный ключ указан верно, но не хватает прав для совершения операции. - `500` — Внутренняя ошибка сервера ЮKassa. --- [API](https://skmtc.dev/hexlet/apis/api-kassa.md) · [All operations](https://skmtc.dev/hexlet/apis/api-kassa/llms.txt) · [OpenAPI document](https://skmtc.dev/hexlet/apis/api-kassa/revisions/e79983ebb73d?raw)