Возврат денег

Создает возврат средств по указанному инвойсу. При создании запроса можно указать режим расчета комиссии за возврат с помощью параметра fee_mode.

URL

Требуется авторизация

POST

https://api.fps.pro/invoices/refund/{id}

Формат запросаapplication/json

fee_mode

number

Режим списания комиссии. Если указано deduct - то комиссия спишется с суммы платежа, и клиент получит суммы инвойса, с вычетом комиссии. Если указанно add - то комиссию за возврат оплачиваете вы, с счета мерчанта, клиент получает полную сумму платежа

По умолчанию: deduct

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

curl --request POST 'https://api.fps.pro/invoices/refund/0a718b02-138d-495a-9661-39ca52139c07' \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: YOUR_CLIENT_ID' \
  --header 'X-Timestamp: 1720000000' \
  --header 'X-Signature: YOUR_HMAC_SHA256_SIGNATURE' \
  --data '{
  "fee_mode": "deduct"
}'

Успешный ответ

{
  "status": 200,
  "message": "success refund"
}

Ошибки

Подробный список ошибок авторизации находится в разделе Авторизация - Ошибки

{
  "status": 400,
  "message": "There is no balance available for refund"
}
{
  "status": 404,
  "message": "The invoice is not found"
}
{
  "status": 422,
  "message": "Validation Error",
  "errors": [
    {
      "field": "fee_mode",
      "message": "invalid value"
    }
  ]
}
{
  "status": 500,
  "message": "Internal Server Error"
}