Sign in
Возвраты

Список возвратов

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

get/refunds

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

payment_idstring

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

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

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

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

Статус возврата платежа. Возможные значения: pending — возврат создан, но пока еще обрабатывается; succeeded — возврат успешно завершен, указанная в запросе сумма переведена на платежное средство пользователя (финальный и неизменяемый статус); canceled — возврат отменен, инициатор и причина отмены указаны в объекте cancellation_details (финальный и неизменяемый статус).

Example:succeeded

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

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": "1ddd77af-0bd7-500d-895b-c475c55fdefc",
      "payment_id": "1da5c87d-0984-50e8-a7f3-8de646dd9ec9",
      "status": "succeeded",
      "cancellation_details": {
        "party": "yoo_money",
        "reason": "yoo_money_account_closed"
      },
      "receipt_registration": "succeeded",
      "created_at": "2017-11-03T11:52:31.827Z",
      "amount": {
        "value": "1000.00",
        "currency": "RUB"
      },
      "sources": [
        {
          "account_id": "123",
          "amount": {
            "value": "1000.00",
            "currency": "RUB"
          },
          "platform_fee_amount": {
            "value": "1000.00",
            "currency": "RUB"
          }
        }
      ],
      "deal": {
        "id": "dl-d68d2fe4-2abb-47e5-8112-32e28f87fb52",
        "refund_settlements": [
          {
            "type": "payout",
            "amount": {
              "value": "1000.00",
              "currency": "RUB"
            }
          }
        ]
      },
      "refund_method": {
        "type": "sbp",
        "sbp_operation_id": "1027088AE4CB48CB81287833347A8777"
      },
      "refund_authorization_details": {
        "rrn": "603668680243"
      }
    }
  ],
  "next_cursor": "37a5c87d-3984-51e8-a7f3-8de646d39ec15"
}

Changes