Отмена и возврат¶

Запрос создаёт отмену или возврат по указанному платежу.

Подробности см. в разделе «Отмена и возврат»

Запрос¶

PUT /payin/v1/sites/{siteId}/payments/{paymentId}/refunds/{refundId}

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

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

Заголовки¶

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

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

Параметр	Обязательный	Тип	Описание
amount	Да	object	Данные о сумме операции
callbackUrl	Нет	string(256)	URL отправки уведомления по операции
comment	Нет	string(255)	Дополнительное описание возврата
settlementAmount	Нет	object	Сумма возмещения мерчанту (если валюта возмещения отличается от валюты авторизации средств)

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

Возврат по платежу

PUT /partner/payin/v1/sites/test-01/payments/1811/refunds/tcwv3132 HTTP/1.1
Accept: application/json
Authorization: Bearer 5c4b25xx93aa435d9cb8cd17480356f9
Content-type: application/json
Host: b2b-api.qiwi.com

{
  "amount": {
    "value": 2.34,
    "currency": "RUB"
  }
}

Ответ¶

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

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

Параметр	Обязательный	Тип	Описание
refundId	Да	string	Идентификатор операции. Такой же как в запросе
createdDateTime	Да	string	Дата создания операции
amount	Да	object	Сумма операции
status	Да	object	Статус операции
flags	Нет	string(256)	Дополнительные флаги. `REVERSAL` — в случае с банковскими картами использовалась операция отмены

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

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

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

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

{
  "refundId": "tcwv3132",
  "createdDateTime": "2024-03-20T16:32:55.547+03:00",
  "amount": {
    "currency": "RUB",
    "value": "2.34"
  },
  "status": {
    "value": "COMPLETED",
    "changedDateTime": "2024-03-20T16:32:55.55+03:00"
  },
  "flags": [
    "REVERSAL"
  ]
}

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

{
  "serviceName":"payin-core",
  "errorCode":"internal.error",
  "userMessage":"Internal error",
  "description":"Internal error",
  "traceId":"3fb3420ee1795dcf",
  "dateTime":"2020-02-12T21:28:01.813+03:00"
}