Перейти до основного вмісту

Скасування рахунку

Опис

Рахунок можна скасувати, щоб покупець не зміг його оплатити. Це потрібно, якщо в рахунку допущено помилку. Скасувати рахунок можна лише за дотримання двох умов:

  • Статус рахунку: неоплачений
  • Перегляди платіжної сторінки: 0 переглядів

Якщо рахунок належить чужому проєкту, а ключ обмежено проєктом, метод відповідає Restricted project. Якщо рахунку з таким ідентифікатором у вас немає — Invoice not found. Якщо рахунок знайдено, але умови скасування не виконано — Invoice cannot be canceled.

Запит

curl -X POST https://api.bitsby.app/invoices/cancel \
-H "Authorization: Token MSvL2ltaDZdWVjmZURURMVWhqSJLT2NURjhL2Fla1Z1T1IxQTltKs1T3Ay" \
-F "invoiceId=ade9550d-3dc7-4fd3-b94e-3b4c12aaaa0c"

Параметри запиту

ПараметрТип данихОписПрикладОбов’язковий?
invoiceIdUUIDID рахунку у форматі UUIDade9550d-3dc7-4fd3-b94e-3b4c12aaaa0cтак

Приклад відповіді

{
"result":"success",
"data":"Invoice canceled"
}