Sign in
Выплаты

Список выплат

Используйте этот запрос, чтобы получить список выплат. Для выгрузки доступны выплаты, созданные за последние 3 года. Список можно отфильтровать по различным критериям. Данные для аутентификации: https://yookassa.ru/developers/using-api/interaction-format#auth запросов зависят от того, какое платежное решение вы используете — обычные выплаты: https://yookassa.ru/developers/payouts/overview или выплаты в рамках Безопасной сделки: https://yookassa.ru/developers/solutions-for-platforms/safe-deal/basics. Подробнее о работе со списками: https://yookassa.ru/developers/using-api/lists

get/payouts

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

payout_destination.type'yoo_money' | 'bank_card' | 'sbp'

Способ получения выплаты: yoo_money — выплаты на кошелек ЮMoney; bank_card — выплаты на банковскую карту; sbp — выплаты через СБП на счет в банке или платежном сервисе.

Фильтр по коду способа получения выплаты: https://yookassa.ru/developers/payouts/getting-started/payout-types-and-limits#types-destination. Пример: payout_destination.type=bank_card

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

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

Фильтр по статусу выплаты: https://yookassa.ru/developers/api#payout_object_status. Пример: 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": "po-27ced252-0025-5000-9000-0a682a8bab8f",
      "amount": {
        "value": "1000.00",
        "currency": "RUB"
      },
      "payout_destination": {
        "card": {
          "first6": "427918",
          "last4": "7918",
          "issuer_country": "RU",
          "issuer_name": "Sberbank"
        }
      },
      "description": "Оплата заказа № 72",
      "created_at": "2020-07-03T11:52:31.827Z",
      "succeeded_at": "2020-07-03T11:52:42.312Z",
      "deal": {
        "id": "dl-d68d2fe4-2abb-47e5-8112-32e28f87fb52"
      },
      "self_employed": {
        "id": "se-7474a846-a965-498d-bbf9-1c3c8907cbbd"
      },
      "receipt": {
        "service_name": "Оказание услуг по доставке товара",
        "npd_receipt_id": "208jd98zqe",
        "url": "https://www.nalog.gov.ru/api/v1/receipt/208jd98zqe/print",
        "amount": {
          "value": "1000.00",
          "currency": "RUB"
        }
      },
      "cancellation_details": {
        "reason": "insufficient_funds"
      }
    }
  ],
  "next_cursor": "37a5c87d-3984-51e8-a7f3-8de646d39ec15"
}

Changes