Счета

Создание счета

Используйте этот запрос, чтобы создать в ЮKassa объект счета: https://yookassa.ru/developers/api#invoice_object. В запросе необходимо передать данные о заказе, которые отобразятся на странице счета, и данные для проведения платежа.

post/invoices

Headers

Idempotence-Keystring required

Request body

expires_atstring 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. Пример: 2024-10-18T10:51:18.139Z

locale'ru_RU' | 'en_US'

Язык интерфейса, писем и смс, которые будет видеть или получать пользователь. Формат соответствует ISO/IEC 15897: https://en.wikipedia.org/wiki/Locale_(computer_software). Возможные значения: ru_RU, en_US. Регистр важен.

descriptionstring

Описание выставленного счета (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь на странице счета. Например: «Счет на оплату по договору 37».

metadataMetadata

Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.

Example request

{
  "payment_data": {
    "amount": {
      "value": "1000.00",
      "currency": "RUB"
    },
    "receipt": {
      "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"
            }
          ]
        }
      ],
      "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"
      }
    },
    "recipient": {
      "gateway_id": "456"
    },
    "save_payment_method": true,
    "capture": true,
    "description": "Оплата заказа № 72"
  },
  "cart": [
    {
      "price": {
        "value": "1000.00",
        "currency": "RUB"
      },
      "discount_price": {
        "value": "1000.00",
        "currency": "RUB"
      },
      "quantity": 1
    }
  ],
  "delivery_method_data": {
    "phone": "79000000000"
  },
  "expires_at": "2024-10-18T10:51:18.139Z",
  "locale": "ru_RU",
  "description": "Оплата заказа № 72"
}

Response

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

idstring required

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

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

Статус счета. Возможные значения: pending — счет создан и ожидает успешной оплаты; succeeded — счет успешно оплачен, есть связанный платеж в статусе succeeded (финальный и неизменяемый статус для платежей в одну стадию); canceled — вы отменили счет, успешный платеж по нему не поступил или был отменен (при оплате в две стадии) либо истек срок действия счета (финальный и неизменяемый статус). Подробнее про жизненный цикл счета: https://yookassa.ru/developers/payment-acceptance/scenario-extensions/invoices/basics#invoice-status

created_atstring 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_atstring date-time