Получение списка платежей по счёту¶

Запрос предназначен для получения списка платежей по платёжному счёту. В ответ приходит список данных по платежам с запрошенным billId.

Запрос¶

GET /payin/v1/sites/{siteId}/bills/{billId}

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

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

Заголовки¶

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

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

Запрос статуса счёта

GET /partner/payin/v1/sites/site-01/bills/3a3d0286cefe645d2b00 HTTP/1.1
Accept: application/json
Authorization: Bearer 5c4b25xx93aa435d9cb8cd17480356f9
Content-type: application/json
Host: b2b-api.qiwi.com

Ответ¶

См. также список общих HTTP кодов ошибок

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

Список платежей по указанному в запросе billId передаётся в виде массива payments, содержащего объекты с указанными в таблице параметрами.

Параметр	Обязательный	Тип	Описание
paymentId	Да	string	Идентификатор платежа по счёту
billId	Да	string	Идентификатор счёта. Такой же как в запросе
createdDateTime	Да	string	Дата создания платежа
amount	Да	object	Сумма операции
capturedAmount	Да	object	Сумма подтверждений
refundedAmount	Да	object	Сумма возвратов
paymentMethod	Да	object	Метод платежа
status	Да	string	Статус счёта
paymentCardInfo	Да	object	Информация о банковской карте, с которой совершен платёж
createdToken	Нет	object	Информация о платёжном токене
customer	Нет	object	Данные покупателя: `account`, `email`, `phone`
comment	Нет	string	Описание услуги, которую получает плательщик
customFields	Нет	object	Поля с произвольной информацией, дополняющей данные по операции

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

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

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

Успешный ответОтвет с ошибкой 4xx

{
    "billId": "3a3d0286cefe645d2b11",
    "invoiceUid": "235d8d5a-38ed-11fc-9ab6-8b5a65d7e2f8",
    "amount": {
        "currency": "RUB",
        "value": "3000.00"
    },
    "expirationDateTime": "2023-05-07T19:25:36+03:00",
    "status": {
        "value": "PAID",
        "changedDateTime": "2023-04-07T19:28:12+03:00"
    },
    "comment": "Детская футбольная школа «Тигры»",
    "flags": [
        "SALE"
    ],
    "payUrl": "https://payment.qiwi.com/form?invoiceUid=235d8d5a-11ed-46fc-9ab6-8b5a65d7e2f8",
    "payments": [
        {
            "paymentId": "cd4a4ade-011e6-484d-87c8-40a7f48326fa",
            "billId": "3a3d0286cefe645d2b11",
            "createdDateTime": "2023-04-07T19:27:52+03:00",
            "amount": {
                "currency": "RUB",
                "value": "3000.00"
            },
            "capturedAmount": {
                "currency": "RUB",
                "value": "3000.00"
            },
            "refundedAmount": {
                "currency": "RUB",
                "value": "0.00"
            },
            "paymentMethod": {
                "type": "CARD",
                "maskedPan": "422264******1232",
                "rrn": "309711196151",
                "authCode": "231181"
            },
            "status": {
                "value": "COMPLETED",
                "changedDateTime": "2023-04-07T19:28:12+03:00"
            },
            "comment": "Детская футбольная школа «Тигры»",
            "customFields": {
                "auto_capture": "true",
                "invoice_creation_type": "PUBLIC_KEY"
            },
                "paymentCardInfo": {
                    "issuingCountry": "643",
                    "issuingBank": "Сбербанк России",
                    "paymentSystem": "VISA",
                    "fundingSource": "DEBIT",
                    "paymentSystemProduct": "N1|Visa Rewards"
                }
            },
            {
            "paymentId": "A30971626215731E01110841111138B2",
            "billId": "3a3d0286cefe645d2b11",
            "createdDateTime": "2023-04-07T19:26:21+03:00",
            "amount": {
                "currency": "RUB",
                "value": "3000.00"
            },
            "capturedAmount": {
                "currency": "RUB",
                "value": "3000.00"
            },
            "refundedAmount": {
                "currency": "RUB",
                "value": "0.00"
            },
            "paymentMethod": {
                "type": "SBP",
                "phone": "0079031232001"
            },
            "status": {
                "value": "DECLINED",
                "changedDateTime": "2023-04-07T19:26:23+03:00",
                "reason": "GATEWAY_INTEGRATION_ERROR",
                "reasonMessage": "I07999 OPKC_TECH_ERROR"
            },
            "comment": "Детская футбольная школа «Тигры»",
            "customFields": {
                "auto_capture": "true",
                "invoice_creation_type": "PUBLIC_KEY"
            }
        }
    ]
}

{
  "serviceName" : "payin-core",
  "errorCode" : "validation.error",
  "description" : "Validation error",
  "userMessage" : "Validation error",
  "dateTime" : "2022-03-05T11:49:59.166+03:00",
  "traceId" : "fd0e2a08c63ace83"
}