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

payments/refund - Возврат денег

  • HTTP-метод: POST
  • URL: /payments/refund
  • Форма взаимодействия: Сервер-сервер
  • Формат тела запроса: application/json
  • Аутентификация: HTTP Basic Auth (PublicId / ApiSecret)
  • Назначение: полный или частичный возврат уже списанной (подтверждённой) оплаты.

URL

1
https://cloud.wallet.kvell.group/payments/refund

1
/payments/refund

Структура запроса

Поле Тип Обяз. Описание
TransactionId int ✔ Номер транзакции оплаты.
Amount decimal ✔ Сумма возврата в валюте транзакции. Меньше суммы оплаты — частичный возврат.
JsonData json Любые другие данные, которые будут связаны с транзакцией, в том числе инструкции для формирования чека.
ItemId str Идентификатор товара из SplitData для адресного частичного возврата по конкретному товару. Наше расширение — в спецификации CloudPayments отсутствует.

Структура ответа

Поле Тип Описание
Success bool Результат запроса.
Message string Описание ошибки (при неуспехе).
Model.TransactionId int Номер созданной транзакции возврата.

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

1
2
3
4
{
  "TransactionId": 455,
  "Amount": 100
}

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

1
2
3
4
5
6
7
{
  "Model": {
    "TransactionId": 568
  },
  "Success": true,
  "Message": null
}

1
2
3
4
{
  "Message": "Транзакция не найдена",
  "Success": false
}

Примечания

  • Перед возвратом сервис проверяет, что заказ находится в статусе Completed (см. Статусы транзакции). Если оплата ещё не подтверждена или уже возвращена — метод вернёт 400 с сообщением «Транзакция не найдена», не обращаясь к провайдеру.
  • Для отмены ещё не подтверждённого холда используйте payments/void.
  • Возвраты по транзакциям старше года не проводятся.