Callbacks

Callbacks are used to get the final status of an invoice. Once the invoice reaches a final status, a request is sent to the Invoice callback URL specified in the shop's settings.

Method: POST

Parameters

Name	Data type	Description
`id`	integer	Unique invoice number in the table
`invoice_guid`	string	Invoice GUID
`invoice_number`	string	Unique invoice number in the system
`amount`	integer	Invoice amount in kopecks
`status`	string	Invoice status
`delivery_type`	string	Invoice delivery method
`delivery_value`	json	Data for invoice delivery
`∟phone`	string	Phone number for invoice delivery
`∟email`	string	Email for invoice delivery
`expired_at`	string	Invoice expiration date
`description`	string	Description
`created_at`	string	Invoice creation date
`url`	string	Link to the invoice

{
  "id": 1401,
  "invoice_guid": "a8a4da0f-b4eb-461b-8323-57c3ea37f438",
  "invoice_number": "1578624f-1fd2-43a3-be9a-9ad5f1e07d31",
  "amount": 10000,
  "status": "canceled",
  "delivery_type": "email",
  "delivery_value": {
    "email": "invoice@test.com",
    "phone": "123456789"
  },
  "expired_at": "2022-11-05 10:10:00+00:00",
  "description": "Test description",
  "created_at": "2022-10-27 11:39:15.826311+00:00",
  "url": "https://pay.kvell.group/checkout/invoices/a8a4da0f-b4eb-461b-8323-57c3ea37f438"
}

Headers

The request headers also include:

X-Api-Key — unique shop identifier
X-Signature — request signature

Signature generation:

sha256({api-key}{invoice_number}{amount}{secret-key})

Callback delivery

A callback is considered successfully delivered if the merchant's server returns HTTP code 200. Any other HTTP response code means the request was not delivered.

If the first attempt is unsuccessful, 5 more attempts will be made every 10 minutes.