Перейти к основному содержимому

Возврат/отмена


Запрос предназначен для возврата средств по завершенному платежу. ТСП может выполнить несколько запросов для возврата частичных сумм.

Запрос

PUT /sites/{siteId}/payments/{paymentId}/refunds/{refundId}
Accept: application/json
Authorization: Bearer 5628af1c-26d9-42e7-8a6a-c22d491d79fb
Content-type: application/json
Host: api.qiwip.kz
{
"amount": {
"currency": "KZT",
"value": "100.00"
}
}

Ответ

{
"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

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

Headers

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

Request

ПараметрТипОбязательныйОписание
amountobjectДаИнформация о сумме операций

Amount

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

Response

ПараметрТипОбязательныйОписание
refundIdstringДаУникальный идентификатор в запросе возврата в информационной системе ТСП.
createdDateTimestringДаДата создания платежа в формате ISO8601 (YYYY-MM-DDThh:mm:ss±hh:mm).
amountobjectДаИнформация о сумме операций
statusobjectДаИнформация о сумме подтверждений.

Status

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