Appearance
Создание возврата
POST /refunds
Создание возврата по ранее проведенному депозиту. Поддерживаются частичные и полные возвраты.
Заголовки
| Заголовок | Обязательный | Описание |
|---|---|---|
merchant-id | Да | Идентификатор мерчанта |
x-signature | Да | HMAC-SHA256 подпись запроса |
Content-Type | Да | application/json |
Важно: для подписи запросов на возврат используется секретный ключ депозитов (
deposit secret).
Тело запроса
| Поле | Тип | Обязательный | Описание |
|---|---|---|---|
depositId | string | Да | UUID депозита, по которому выполняется возврат |
amount | string | Да | Сумма возврата (например, "50.00") |
merchantRefundId | string | Нет | Идентификатор возврата на стороне мерчанта |
comment | string | Нет | Причина возврата |
Пример запроса
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"
}'Ответ
| Поле | Тип | Описание |
|---|---|---|
refundId | string | UUID созданного возврата |
status | number | Статус: 1 (Processing), 2 (Approved), 3 (Declined) |
amount | string | Сумма возврата |
currency | string | Валюта |
Пример ответа
json
{
"data": {
"refundId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"status": 1,
"amount": "50.00",
"currency": "RUB"
}
}Ошибки
| HTTP-код | Ошибка | Описание |
|---|---|---|
400 | BadRequest | Невалидные параметры или депозит не найден |
403 | Forbidden | Депозит не принадлежит данному мерчанту |