Skip to main content

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


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

Пример

Запрос

GET /sites/site-01/bills/0102313fsdfj82/details
Accept: application/json
Authorization: Bearer 5628af1c-26d9-42e7-8a6a-c22d491d79fb
Content-type: application/json
Host: qpay-api.qiwi.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

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

Headers

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

Response

ПараметрТипОбязательныйОписание
billIdstringДаУникальный идентификатор в запросе статуса счета.
amountobjectДаИнформация о сумме платежа
statusobjectДаСтатус счета
customerobjectНетИнформация о клиенте
payUrlstringНетСсылка на созданную Платежную форму оплаты счета
paymentsarray of objectДаСписок платежей

Status

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

Payment

ПараметрТипОбязательныйОписание
siteIdstringДаИдентиикатор сайта
paymentIdstringДаИдентиикатор платежа
billIdstringДаУникальный идентификатор счета, с данного запроса, в информационной системе ТСП.
createdDateTimestringДаДата создания счета в формате ISO8601 (YYYY-MM-DDThh:mm:ss±hh:ss). Если счет не будет оплачен до этой даты, последующая оплата станет невозможна.
amountobjectДаИнформация о сумме платежа
capturedAmountobjectДаИнформация о подтвержденной сумме платежа
refundedAmountobjectДаИнформация о возврате суммы платежа
paymentMethodobjectДаМетод платежа.
statusobjectДаСтатус счета
customerobjectНетИнформация о клиенте

Amount

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

PaymentMethod

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

Status

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

Customer

ПараметрТипОбязательныйОписание
accountstringДаУникальный идентификатор клиента в системе ТСП
emailstringНетEmail клиента в системе ТСП
namestringНетНаименование клиента
phonestringНетНомер мобильного телефона. Например: 77071112233