Перейти к основному содержимому

Отмена счета

Описание

Счет можно отменить для того, чтобы покупатель не смог оплатить счет. Это нужно в случае, если в счете была допущена ошибка. Счет можно отменить только при соблюдении двух условий:

  • Статус счета: актуален
  • Просмотры платежной страницы: 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"
}