Перейти к содержанию

Отмена счета

Метод для отмены счета.

URL

Метод: GET

  • Production: https://api.pay.kvell.group/v1/invoices/{invoice_guid}/cancel
  • Stage: https://api.pay.stage.kvell.group/v1/invoices/{invoice_guid}/cancel

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

Название Тип данных Обязательно Описание
invoice_guid string Да GUID счета

Заголовки запроса

Название Тип данных Обязательно Описание
X-Api-Key string Да Уникальный идентификатор магазина
X-Signature string Да Подпись

Подпись X-Signature формируется конкатенацией X-Api-Key, invoice_guid и secret_key. Формируется sha256 от полученной строки:

sha256({x-api-key}{invoice_guid}{secret_key})

где secret_key - секретный ключ, который находится в настройках магазина мерчанта;

Ответ запроса

Пример ответа

{
    "id": 86,
    "invoice_guid": "70ed5299-af5e-4f86-a414-58d4fc1fcc27",
    "api_key": "3a8c82d6-d2c6-4165-9a6b-ab3f14d965ae",
    "status": "canceled",
    "amount": 337,
    "created_at": "2022-10-17T07:04:43.794351+00:00",
    "expired_at": "2023-10-05T10:00:00+00:00",
    "invoice_number": "251d8bfb-0114-44a7-a53e-4fd1d827004a",
    "delivery_type": "email",
    "delivery_value": {
      "email": "invoice@test.com",
      "phone": "123456789"
    },
    "description": "Test description",
    "url": "https://pay.kvell.group/checkout/invoice/70ed5299-af5e-4f86-a414-58d4fc1fcc27"
}
{
  "errors": [
    {
      "code": 20099,
      "message": "Invoice not found"
    }
  ]
}