Sign in
Платежи

Список платежей

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

get/payments

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

captured_at.gtestring date-time

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

captured_at.gtstring date-time

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

captured_at.ltestring date-time

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

captured_at.ltstring date-time

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

payment_method'bank_card' | 'cash' | 'alfabank' | 'webmoney' | 'wechat' | 'apple_pay' | 'google_pay' | 'qiwi' | 'installments' | 'yoo_money' | 'sberbank' | 'mobile_balance' | 'b2b_sberbank' | 'tinkoff_bank' | 'sbp' | 'sber_loan' | 'electronic_certificate' | 'sber_bnpl'

Код способа оплаты — тип платежного средства, которое используется для оплаты. Подробнее о способах оплаты: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-methods

Example:bank_card

Фильтр по коду способа оплаты: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-methods#all. Пример: payment_method=bank_card

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

Статус платежа. Возможные значения: pending, waiting_for_capture, succeeded и canceled. Подробнее про жизненный цикл платежа: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#lifecycle

Example:succeeded

Фильтр по статусу платежа: https://yookassa.ru/developers/payment-acceptance/getting-started/payment-process#lifecycle. Пример: 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": "1da5c87d-0984-50e8-a7f3-8de646dd9ec9",
      "status": "succeeded",
      "amount": {
        "value": "1000.00",
        "currency": "RUB"
      },
      "income_amount": {
        "value": "1000.00",
        "currency": "RUB"
      },
      "description": "Оплата заказа № 72",
      "recipient": {
        "account_id": "123",
        "gateway_id": "456"
      },
      "payment_method": {
        "type": "bank_card",
        "id": "1da5c87d-0984-50e8-a7f3-8de646dd9ec9",
        "saved": true,
        "status": "active",
        "title": "Основная карта",
        "card": {
          "first6": "427918",
          "last4": "7918",
          "expiry_year": "2017",
          "expiry_month": "07",
          "card_product": {
            "code": "MCP",
            "name": "MIR Privilege"
          },
          "issuer_country": "RU",
          "issuer_name": "Sberbank"
        }
      },
      "captured_at": "2017-11-03T11:52:31.827Z",
      "created_at": "2017-11-03T11:52:31.827Z",
      "expires_at": "2017-11-03T11:52:31.827Z",
      "confirmation": {
        "type": "redirect",
        "enforce": true
      },
      "refunded_amount": {
        "value": "1000.00",
        "currency": "RUB"
      },
      "paid": true,
      "refundable": true,
      "receipt_registration": "succeeded",
      "cancellation_details": {
        "reason": "insufficient_funds"
      },
      "authorization_details": {
        "rrn": "603668680243",
        "auth_code": "062467",
        "three_d_secure": {
          "applied": true
        }
      },
      "transfers": [
        {
          "account_id": "123",
          "amount": {
            "value": "1000.00",
            "currency": "RUB"
          },
          "status": "succeeded",
          "platform_fee_amount": {
            "value": "1000.00",
            "currency": "RUB"
          },
          "description": "Заказ маркетплейса №72"
        }
      ],
      "deal": {
        "id": "dl-d68d2fe4-2abb-47e5-8112-32e28f87fb52",
        "settlements": [
          {
            "type": "payout",
            "amount": {
              "value": "1000.00",
              "currency": "RUB"
            }
          }
        ]
      },
      "merchant_customer_id": "user@test.merchant",
      "invoice_details": {
        "id": "in-e44e8088-bd73-43b1-959a-954f3a7d0c54"
      }
    }
  ],
  "next_cursor": "37a5c87d-3984-51e8-a7f3-8de646d39ec15"
}

Changes