Skip to content

Invoice Cancellation

Method for canceling an invoice.

URL

Method: PATCH

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

Request parameters

Name Data type Required Description
invoice_guid string Yes Invoice GUID

Request headers

Name Data type Required Description
X-Api-Key string Yes Unique shop identifier
X-Signature string Yes Signature

The X-Signature signature is formed by concatenating X-Api-Key, invoice_guid, and secret_key. It is generated as the sha256 hash of the resulting string:

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

where secret_key is the secret key found in the merchant's shop settings;

Response

Response example

{
    "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"
    }
  ]
}