Перейти к содержанию

Получение информации о платеже

Запрос предназначен для получения информации о платёжной транзакции.

Сценарии, в которых используется запрос информации о платеже, см. в статьях «Оплата с формы партнёра» → «Сценарий оплаты» и «Решение об успешности операции»

Запрос

GET /payin/v1/sites/{siteId}/payments/{paymentId}

Параметры строки запроса

Параметр Обязательный Тип Описание
siteId Да string Строковый идентификатор сайта ТСП в QIWI Кассе
paymentId Да string Уникальный идентификатор платежа в информационной системе ТСП. Уникальность означает, что идентификатор должен отличаться от идентификаторов всех ранее созданных платежей ТСП в рамках одного siteId.

Заголовки

Заголовок Обязательный Тип Описание
Authorization Да string Авторизационные данные. Bearer [access-token]
Accept Нет string Тип ответа. application/json

Пример запроса

Получение информации о платеже
GET /partner/payin/v1/sites/test-01/payments/1811 HTTP/1.1
Accept: application/json
Authorization: Bearer 5c4b25xx93aa435d9cb8cd17480356f9
Content-type: application/json
Host: b2b-api.qiwi.com

Ответ

Поля успешного ответа

Параметр Обязательный Тип Описание
paymentId Да string Идентификатор платежа. Такой же как в запросе
createdDateTime Да string Дата создания счёта
amount Да object Сумма операции
capturedAmount Да object Сумма подтверждений
refundedAmount Да object Сумма возвратов
paymentMethod Да object Метод платежа
status Да object Статус платежа
paymentCardInfo Да object Информация о банковской карте, с которой совершен платёж
customer Нет object Информация о клиенте (повтор объекта customer из запроса).
callbackUrl Нет string URL отправки уведомления по операции. Если данное поле не было указано в запросе, его значение берётся из раздела Настройки в Личном кабинете
flags Нет array of strings Дополнительные флаги операции. Возможные значения: TEST, AFT
customFields Нет object Поля с произвольной информацией, дополняющей данные по операции.
Также может содержать поля с информацией о клиенте по данным НСПК для платежей СБП
settlementAmount Нет object Сумма возмещения мерчанту (если валюта возмещения отличается от валюты авторизации средств)
requirements Нет object Требования для дополнительной аутентификации клиента

Поля ответа с ошибкой

Параметр Обязательный Тип Описание
serviceName Да string Имя сервиса, сгенерировавшего ошибку
errorCode Да string Код ошибки
description Да string Описание ошибки для ТСП
userMessage Да string Описание ошибки для отображения покупателю
dateTime Да string Дата и время ошибки
traceId Да string Уникальный ID лога ошибки
cause Нет object Описание ошибки валидации конкретного поля

Примеры ответов

{
    "paymentId": "d6be1787-67d1-4b30-8ac3-d0ec4b5f301e",
    "billId": "test1",
    "createdDateTime": "2025-07-08T10:28:46+03:00",
    "amount": {
        "currency": "RUB",
        "value": "6.00"
    },
    "capturedAmount": {
        "currency": "RUB",
        "value": "6.00"
    },
    "refundedAmount": {
        "currency": "RUB",
        "value": "0.00"
    },
    "paymentMethod": {
        "type": "CARD",
        "maskedPan": "220220******1111"
    },
    "customer": {
        "phone": "0"
    },
    "status": {
        "value": "COMPLETED",
        "changedDateTime": "2025-07-08T10:28:46+03:00"
    },
    "callbackUrl": "http://s1596.qiwi.com/payin",
    "customFields": {
        "invoice_creation_type": "PAYIN_API",
        "customer_phone": "0"
    },
    "flags": [
        "TEST"
    ],
    "paymentCardInfo": {
        "issuingCountry": "643",
        "issuingBank": "Сбербанк России",
        "paymentSystem": "MIR",
        "fundingSource": "CREDIT",
        "paymentSystemProduct": "CPP"
    }
}
{
  "serviceName":"payin-core",
  "errorCode":"validation.error",
  "description":"Validation error",
  "userMessage":"Validation error",
  "dateTime":"2022-11-13T16:49:59.166+03:00",
  "traceId":"fd0e2a08c63ace83",
  "cause":{
    "paymentToken": [
      "Exchange token error. Token disabled, please create new one"
    ]
  }
}
{
  "serviceName":"payin-core",
  "errorCode":"internal.error",
  "userMessage":"Internal error",
  "description":"Internal error",
  "traceId":"3fb3420ee1795dcf",
  "dateTime":"2020-02-12T21:28:01.813+03:00"
}