Статус операции возврата
Получить информацию о возврате платежа.
Запрос
GET /sites/{siteId}/payments/{paymentId}/refunds/{refundId}
Accept: application/json
Authorization: Bearer 5628af1c-26d9-42e7-8a6a-c22d491d79fb
Content-type: application/json
Host: qpay-api.qiwi.kz
Ответ
{
"refundId": "2342342",
"createdDateTime": "2022-12-12T10:10:19+06:00",
"amount": {
"currency": "KZT",
"value": "100.00"
},
"status": {
"value": "DECLINED",
"changedDateTime": "2022-12-12T10:10:19+06:00"
}
}
Параметры запроса
Path Parameters
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
siteId | string | Да | Строковый идентификатор сайта ТСП в QIWI Кассе. |
paymentId | string | Да | Уникальный идентификатор платежа в информационной системе ТСП, по которому нужно провести возврат платежа. |
refundId | string | Да | Уникальный идентификатор возврата в информационной системе ТСП. Уникальность означает, что идентификатор должен отличаться от идентификаторов всех ранее созданных возвратов ТСП в рамках одного siteId . |
Headers
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
Authorization | string | Да | Авторизационные данные. "Bearer [acсess-token]" |
Content-type | string | Да | Тип запроса. "application/json" |
Accept | string | Да | Тип запроса. "application/json" |
Response
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
refundId | string | Да | Уникальный идентификатор в запросе возврата в информационной системе ТСП. |
createdDateTime | string | Да | Дата создания платежа в формате ISO8601 (YYYY-MM-DDThh:mm:ss±hh:mm). |
amount | object | Да | Информация о сумме операций |
status | object | Да | Информация о сумме подтверждений. |
Amount
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
value | number | Да | Сумма операции (округленная до двух десятичных знаков в меньшую сторону). |
currency | string(3) | Да | Валюта в буквенном формате согласно ISO 4217. |
Status
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
value | string | Да | Значение статуса операции. WAITING - ожидание платежа. DECLINED - ошибка в платеже. COMPLETED - успешность платежа. |
changedDateTime | string | Да | Дата изменения статуса в формате ISO8601 (YYYY-MM-DDThh:mm:ss±hh:mm). |
reason | string | Нет | Причина отклонения операции |