Перейти к содержанию

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

Метод возврата платежа. Возможен полный refunded и частичный возврат part_refunded с указанием суммы.

URL

Метод: POST

  • Production: https://api.pay.kvell.group/v1/orders/{transaction}/refund
  • Stage: https://api.pay.stage.kvell.group/v1/orders/{transaction}/refund

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

Название Тип данных Обязательно Описание
transaction string Да Уникальный номер транзакции на стороне мерчанта

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

Название Тип данных Обязательно Описание
amount int Нет Сумма возврата в копейках. Если не указать, то возврат происходит на всю сумму транзакции.

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

{
  "amount": 1000
}

Заголовки запроса

Название Тип данных Обязательно Описание
X-Api-Key string Да Уникальный идентификатор магазина
X-Signature string Да Подпись

Формирование подписи

Подпись X-Signature формируется конкатенацией X-Api-Key, transaction и secret_key. Формируется sha256 от полученной строки:

sha256({x-api-key}{transaction}{secret_key})

где secret_key - секретный ключ, который находится в настройках магазина мерчанта.

Ответ запроса

Пример ответа

{
  "id": "b13e1610-f26a-4c49-84e8-0edf1650a026",
  "status": "refunded", // "part_refunded"
  "transaction": "436b4ed3-fc6d-431e-963e-a958a730119c",
  "amount": 100,
  "commission": 1000,
  "inner_commission": 500,
  "description": "TEST Invoice",
  "success_url": "https://success.url",
  "fail_url": "https://fail.url",
  "redirect_url": "https://redirect.url",
  "extra_data": {},
  "fiscal_data": {},
  "additional_data": {},
  "error_code": null,
  "error_message": null,
  "created_at": "2024-05-20T12:55:00.951753+00:00"
}

{
  "errors": [
    {
      "message": "string",
      "code": 0
    }
  ]
}

Параметры ответа

Название Тип данных Описание
id string ID транзакции в системе
status string Статус транзакции
transaction string Уникальный номер транзакции на стороне мерчанта
amount integer Сумма в копейках
description string Описание к транзакции
created_at string Дата создания транзакции по UTC
error_code string Код ошибки
error_message string Сообщение ошибки
commission integer Внешняя комиссия в копейках
inner_commission integer Внутренняя комиссия в копейках
success_url string Ссылка при успешном статусе
fail_url string Ссылка при неуспешном статусе
redirect_url string Ссылка для редирект, если не указаны success_url и fail_url
extra_data json Дополнительная информация
fiscal_data json Фискализация чека
additional_data json Дополнительная информация о транзакции

Список статусов

Название Описание
new Новая транзакция
processing Транзакция обрабатывается
canceled Транзакция отклонена
completed Транзакция выполнена
refunded Транзакция возвращена
part_refunded Транзакция частично возвращена