Получение статуса счета

---

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

Пример

Запрос

GET /sites/site-01/bills/0102313fsdfj82/details
Accept: application/json
Authorization: Bearer 5628af1c-26d9-42e7-8a6a-c22d491d79fb
Content-type: application/json
Host: api.qiwip.kz

Ответ

{
  "billId": "0102313fsdfj82",
  "amount": {
    "currency": "KZT",
    "value": "100.00"
  },
  "status": {
    "value": "CREATED",
    "changedDateTime": "2022-12-12T10:10:19+06:00"
  },
  "customer": {
    "account": "1233"
  },
  "payments": [
    {
      "siteId": "site-01",
      "paymentId": "7828af1c-26d9-42e7-8a6a-c22d491d79fb",
      "billId": "0102313fsdfj82",
      "amount": {
        "currency": "KZT",
        "value": "100.00"
      },
      "capturedAmount": {
        "currency": "KZT",
        "value": "0.00"
      },
      "refundedAmount": {
        "currency": "KZT",
        "value": "0.00"
      },
      "paymentMethod": {
        "type": "CARD",
        "maskedPan": "445566******1945"
      },
      "status": {
        "value": "WAITING",
        "changedDateTime": "2022-12-12T10:10:19+06:00"
      },
      "createdDateTime": "2022-12-12T10:10:19+06:00",
      "customer": {
        "account": "1233"
      }
    }
  ]
}

---

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

Path Parameters

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

Headers

Параметр	Тип	Обязательный	Описание
Authorization	string	Да	Авторизационные данные. "Bearer [acсess-token]"
Content-type	string	Да	Тип запроса. "application/json"
Accept	string	Да	Тип запроса. "application/json"

Response

Параметр	Тип	Обязательный	Описание
billId	string	Да	Уникальный идентификатор в запросе статуса счета.
amount	object	Да	Информация о сумме платежа
status	object	Да	Статус счета
customer	object	Нет	Информация о клиенте
payUrl	string	Нет	Ссылка на созданную Платежную форму оплаты счета
payments	array of object	Да	Список платежей

Status

Параметр	Тип	Обязательный	Описание
value	string	Да	Строковое значение статуса счета. CREATED - счет создан. EXPIRED - счет просрочен. PAID - счет оплачен.
changedDateTime	string	Да	Дата изменения платежа в формате ISO8601 (YYYY-MM-DDThh:mm:ss±hh:mm).

Payment

Параметр	Тип	Обязательный	Описание
siteId	string	Да	Идентиикатор сайта
paymentId	string	Да	Идентиикатор платежа
billId	string	Да	Уникальный идентификатор счета, с данного запроса, в информационной системе ТСП.
createdDateTime	string	Да	Дата создания счета в формате ISO8601 (YYYY-MM-DDThh:mm:ss±hh:ss). Если счет не будет оплачен до этой даты, последующая оплата станет невозможна.
amount	object	Да	Информация о сумме платежа
capturedAmount	object	Да	Информация о подтвержденной сумме платежа
refundedAmount	object	Да	Информация о возврате суммы платежа
paymentMethod	object	Да	Метод платежа.
status	object	Да	Статус счета
customer	object	Нет	Информация о клиенте

Amount

Параметр	Тип	Обязательный	Описание
value	number	Да	Сумма операции (округленная до двух десятичных знаков в меньшую сторону).
currency	string(3)	Да	Валюта в буквенном формате согласно ISO 4217.

PaymentMethod

Параметр	Тип	Обязательный	Описание
type	string	Да	Метод значения платежа. CARD - оплата по карте. TOKEN - оплата по платежному токену. WALLET - оплата через QIWI кошелек.
maskedPan	string	Нет	Пан код номера карты.

Status

Параметр	Тип	Обязательный	Описание
value	string	Да	Строковое значение статуса. WAITING - ожидание платежа. DECLINED - ошибка в платеже. COMPLETED - успешность платежа.
changedDateTime	string	Да	Дата изменения платежа в формате ISO8601 (YYYY-MM-DDThh:mm:ss±hh:mm).
reason	string	Нет	Строковое описание ошибки платежа.

Customer

Параметр	Тип	Обязательный	Описание
account	string	Да	Уникальный идентификатор клиента в системе ТСП