Skip to content

Создание возврата

POST /refunds

Создание возврата по ранее проведенному депозиту. Поддерживаются частичные и полные возвраты.

Заголовки

ЗаголовокОбязательныйОписание
merchant-idДаИдентификатор мерчанта
x-signatureДаHMAC-SHA256 подпись запроса
Content-TypeДаapplication/json

Важно: для подписи запросов на возврат используется секретный ключ депозитов (deposit secret).

Тело запроса

ПолеТипОбязательныйОписание
depositIdstringДаUUID депозита, по которому выполняется возврат
amountstringДаСумма возврата (например, "50.00")
merchantRefundIdstringНетИдентификатор возврата на стороне мерчанта
commentstringНетПричина возврата

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

bash
curl -X POST https://api.arcanumpay.ru/api/v1/refunds \
  -H "Content-Type: application/json" \
  -H "merchant-id: 12345" \
  -H "x-signature: a1b2c3d4e5f6..." \
  -d '{
    "depositId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "amount": "50.00",
    "merchantRefundId": "merch-refund-001",
    "comment": "Customer requested refund"
  }'

Ответ

ПолеТипОписание
refundIdstringUUID созданного возврата
statusnumberСтатус: 1 (Processing), 2 (Approved), 3 (Declined)
amountstringСумма возврата
currencystringВалюта

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

json
{
  "data": {
    "refundId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "status": 1,
    "amount": "50.00",
    "currency": "RUB"
  }
}

Ошибки

HTTP-кодОшибкаОписание
400BadRequestНевалидные параметры или депозит не найден
403ForbiddenДепозит не принадлежит данному мерчанту