API отмены платежей в торговом эквайринге¶

Метод применяет агрегатор торгового эквайринга, если функциональность отмен/возвратов не поддерживается POS-терминалом. Метод не предполагает использования банковской карты клиента и POS-терминала.

URL для вызова API¶

PUT https://api.qiwi.com/partner/payin-iso/v1/sites/<SID>/reverts/<UID>

Где:

SID — строковый идентификатор агрегатора (не мерчанта!).
UID — Уникальный идентификатор возврата на вашей стороне.

Запрос является идемпотентным.

Для авторизации запроса используется значение ключа доступа к API в HTTP-заголовке Authorization. Ключ/токен выпускается в личном кабинете.

Authorization: Bearer [acсess-token]
Content-type: application/json

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

Параметр	Тип	Описание
tid	String	Уникальный идентификатор торговой точки
mid	String	Уникальный идентификатор платёжного терминала
rrn	String	RRN исходной операции
stan	String	Идентификатор сообщения (Systems Trace Audit Number, Системный номер проверки трассировки)

{
 "tid": "11111111",
 "mid": "222222222222222",
 "rrn": "333333333333",
 "stan": "444444"
}

Формат ответа¶

В случае успеха возвращается HTTP status 200.

Пример тела успешного ответа:

{
  "createdDateTime": "2023-03-01T17:44:21+03:00",
  "tid": "11111111",
  "mid": "222222222222222",
  "rrn": "333333333333",
  "stan": "444444",
  "status": {
    "value": "COMPLETED", // WAITING, DECLINED, COMPLETED
    "changedDateTime": "2023-03-01T17:44:37.128835+03:00",
    "declineReason": "Some interesting decline reason" // optional
  },
  "amount": {
    "value": 3.00,
    "currency": "RUB"
  }
}

Параметр ответа	Тип	Описание
createdDateTime	String	Дата/время создания операции отмены, в формате `ГГГГ-ММ-ДДTчч:мм:сс±TMZ`
tid	String	Уникальный идентификатор торговой точки
mid	String	Уникальный идентификатор платёжного терминала
rrn	String	RRN исходной операции
stan	String	Значение идентификатора `stan` из тела запроса
status	Object	Описание статуса операции
status. value	String	Статус операции
status. changedDateTime	String	Дата/время последнего изменения статуса
status. declineReason	String	Описание причины изменения статуса
amount	Object	Описание суммы операции
amount. value	Number	Сумма операции
amount. currency	String	Валюта операции

В случае ошибки валидации параметров запроса возвращается HTTP status 4xx.

В случае технической ошибки возвращается HTTP status 5xx.

Пример тела ответа с ошибкой:

{
  "serviceName": "payin-iso8583-gateway",
  "errorCode": "payin-iso8583-gateway.service.entity-not-found",
  "description": "Parent operation not found",
  "userMessage": "Parent operation not found",
  "dateTime": "2023-03-02T11:54:11.122618+03:00",
  "traceId": "21dfc855f684676d"
}