Повернення коштів (refund)¶

Рефанд (refund) — добровільне повернення платежу покупцю. Таке повернення може бути частковим або повним і здійснюватись на прохання покупця або за рішенням самого мерчанта. Існує низка підстав для рефанду: наприклад, невірна сума проведеного платежу, скасування угоди чи невдоволення якістю обслуговування.

Ви можете запросити повернення платежу покупцю у Payplace, якщо така опція передбачена використаним для транзакції платіжним сервісом, а також якщо у вас достатньо коштів для повернення на пов'язаний валютний рахунок.

Частковий рефанд може здійснюватися кілька разів, поки сума коштів з транзакції не складе 0,00 у валюті, що використовується.

Необхідно пам'ятати

Операція рефанду немає зворотної дії. Якщо повернення коштів проведено помилково, на його скасування необхідно запросити чарджбек, тобто. подати заяву до банку чи адміністрації платіжного сервісу.

Запросити рефанд

Відправте повідомлення нашій службі підтримки , якщо вам необхідно провести повне або часткове повернення коштів по транзакції.

Повернення коштів (refund) - нова модель¶

Примітка

Ви можете отримати список усіх повернень за допомогою GET /payment-invoices.

API Reference — Create Refund

API: PRIVATE

URL: (Видається менеджером)/api/payment-invoices/{id}/refund

Авторизація: BasicAuth

Method: POST

Required Fields

Поле	Тип	Опис
`type`	enum	Тип операції. Для цього API встановіть значення `refund`.
`amount`	number	Сума повернення (з плаваючою точкою). Приклад: `100.55`.
`invoiceId`	string	Ідентифікаційний номер, що підлягає відшкодуванню.

Additional Fields

Поле	Тип	Опис
`reference_id`	string	Унікальний ідентифікатор операції на стороні продавця. Обов'язкове поле — якщо його пропустити, система поверне код 422.
`description`	string	Довільний опис повернення коштів (наприклад, «Повернення коштів за замовленням»).

Запит

{
  "data":{
      "type":"refund",
  "attributes":{
      "invoiceId":"cpi_E6GOlfKlHuG43dXq",
      "amount":10,
      "reference_id":"28d1b7ba8-9db9-4153-bb61-4c0d72796b9b",
      "description":"Refund by order"
          }
      }
  }

Відповідь

{
      "data":{
          "type":"refunds",
          "id":"ref_spgCbJh7HNH9JzvL",
          "attributes":{
              "reference_id":"8d1b7ba8-9db9-4153-bb61-4c0d72796b9b",
              "original_id":null,
              "description":"Refund by order",
              "status":"processed",
              "amount":100,
              "fee":0,
              "currency":"UAH",
              "created":1758704170
          }
          "links":{
              "self":"/refunds/ref_spgCbJh7HNH9JzvL"
          }
      }
}

Статуси

У наступній таблиці наведено можливі статуси повернення коштів та зазначено, чи є вони остаточними (без подальших змін статусу) чи неостаточними (можуть змінюватися).

Статус	Опис	Фінальний статус
`created`	Створено	✖
`processing`	В обробці платформою	✖
`process_error`	Помилка обробки; можна продовжити виконання	✖
`process_pending`	Очікування фіналізації	✖
`process_failed`	Невдала спроба повернення коштів.	✔
`processed`	Успішне повернення коштів.	✔
`cancelled`	Повернення коштів скасовано.	✔

Помилки та перевірка

Помилки при виконанні синхронних повернень:

HTTP Code	Error	Пояснення
`422`	Наступна спроба повернення коштів, поки попередня не є остаточною	Оскільки повернення коштів можуть оброблятися синхронно, ініціювання наступного повернення коштів можливе лише після завершення попереднього.
`422`	Сума повернення перевищує залишок, що підлягає поверненню	`amount` не повинна перевищувати залишок, що підлягає поверненню (не може бути нижчою за суму, зазначену в `processed_amount`).

Важливі зауваження

Для часткових транзакцій з неповними сумами платформа може застосувати hold rollback + correct refund коштів або відхилити поточне повернення коштів і створити інше.
Транзакції повернення коштів не мають зворотної дії. Якщо кошти були повернуті помилково, подайте запит на chargeback.