Sign in
Чеки

Список чеков

Запрос позволяет получить список чеков, отфильтрованный по заданным критериям. Можно запросить чеки по конкретному платежу, чеки по конкретному возврату или все чеки магазина. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists

get/receipts

Query parameters

created_at.gtestring date-time

Фильтр по времени создания: время должно быть больше указанного значения или равно ему («с такого-то момента включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z

created_at.gtstring date-time

Фильтр по времени создания: время должно быть больше указанного значения («с такого-то момента, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z

created_at.ltestring date-time

Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («по такой-то момент включительно»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z

created_at.ltstring date-time

Фильтр по времени создания: время должно быть меньше указанного значения («по такой-то момент, не включая его»). Указывается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z

status'pending' | 'succeeded' | 'canceled'
Example:succeeded

Фильтр по статусу чека. Возможные значения: pending — в обработке, succeeded — успешно зарегистрирован, canceled — отменен. Пример: status=succeeded

payment_idstring

Идентификатор платежа в ЮKassa.

Example:1da5c87d-0984-50e8-a7f3-8de646dd9ec9

Фильтр по идентификатору платежа: https://yookassa.ru/developers/api#payment_object_id (получить все чеки для указанного платежа). Пример: payment_id=1da5c87d-0984-50e8-a7f3-8de646dd9ec9 В запросе можно передать только что-то одно: или идентификатор платежа, или идентификатор возврата.

refund_idstring

Идентификатор возврата платежа в ЮKassa.

Example:1ddd77af-0bd7-500d-895b-c475c55fdefc

Фильтр по идентификатору возврата: https://yookassa.ru/developers/api#refund_object_id (получить все чеки для указанного возврата). Пример: refund_id=1da5c87d-0984-50e8-a7f3-8de646dd9ec9 В запросе можно передать только что-то одно: или идентификатор платежа, или идентификатор возврата.

limitinteger

Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50 Значение по умолчанию: 10

cursorstring

Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15 В качестве указателя необходимо использовать значение параметра next_cursor, полученное в ответе на предыдущий запрос. Используется, если в списке больше объектов, чем может поместиться в выдаче (limit), и конец выдачи не достигнут. Пример использования: https://yookassa.ru/developers/using-api/lists#pagination

Response

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

type'list' required

Формат выдачи результатов запроса. Возможное значение: list (список).

next_cursorstring

Указатель на следующий фрагмент списка. Обязательный параметр, если размер списка больше размера выдачи (limit) и конец выдачи не достигнут.

Example response

{
  "items": [
    {
      "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"
      }
    }
  ],
  "next_cursor": "37a5c87d-3984-51e8-a7f3-8de646d39ec15"
}

Changes