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

Создание счета

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

URL

Метод: POST

  • Production: https://api.pay.kvell.group/v1/invoices
  • Stage: https://api.pay.stage.kvell.group/v1/invoices

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

Название
 Тип Обязательно Описание
invoice_number string Да Уникальный номер транзакции (счета)
amount integer Да Сумма заказа в копейках
delivery_type string Нет Способ выставления счета. По умолчанию подставляется значение link
delivery_value json Нет Данные для выставления счета
∟phone string Нет Номер для выставления счета
∟email string Нет Почта для выставления счета
description string Нет Описание счета
expired_at string Нет Срок истечения счета
fiscal_data json Нет Фискальные данные
extra_data json Нет Дополнительные данные

Способы выставления счета

Название Описание
sms По SMS
email По email
sms-email По SMS и email одновременно
link По ссылке
whatsapp По Whatsapp

Пример запроса

{
  "invoice_number": "ae1eea1e-58fc-497e-aa74-c9acc4535733",
  "amount": 10000,
  "delivery_type": "email",
  "delivery_value": {
    "email": "invoice@test.com",
    "phone": "123456789"
  },
  "fiscal_data": {},
  "extra_data": {},
  "description": "Test invoice 1",
  "expired_at": "2023-10-05 10:00"
}

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

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

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

sha256({X-Api-Key}{invoice_number}{amount}{secret_key})

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

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

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

{
  "id": 48,
  "invoice_guid": "fab90932-6b26-453c-b46e-8572342b5286",
  "api_key": "3a8c82d6-d2c6-4165-9a6b-ab3f14d965ae",
  "status": "new",
  "amount": 10000,
  "created_at": "2022-10-04T07:33:10.915751+00:00",
  "expired_at": "2022-10-05T10:10:00+00:00",
  "invoice_number": "ae1eea1e-58fc-497e-aa74-c9acc4535733",
  "delivery_type": "email",
  "delivery_value": {
    "email": "invoice@test.com",
    "phone": "123456789"
  },
  "fiscal_data": {},
  "extra_data": {},
  "description": "Test invoice 1",
  "url": "https://pay.kvell.group/checkout/invoice/fab90932-6b26-453c-b46e-8572342b5286"
}

{
  "errors": [
    {
      "code": 20098,
      "message": "field required"
    }
  ]
}

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

Название Тип данных Описание
id string ID платежа в системе
invoice_guid string GUID счета
api_key string Уникальный идентификатор магазина
status string Статус транзакции
amount integer Сумма в копейках
created_at string Время создания счета
expired_at string Дата истечения срока счета
invoice_number string Уникальный номер транзакции (счета)
delivery_type string Способ отправки счета
delivery_value json Данные для отправки счета
∟phone string Телефон для отправки счета
∟email string Почта для отправки счета
fiscal_data json Фискальные данные
extra_data json Дополнительные данные
description string Описание счета
url string Ссылка на счет

Список статусов

Название Описание
new Новый счет
processing Счет обрабатывается
canceled Счет отклонен
completed Счет завершен
expired Счет истек