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

Формирование чека

Метод создания и формирования чека для самозанятого.

URL

Метод: POST

  • Production: https://api.baas.kvell.group/v1/smz/receipts
  • Stage: https://api.baas.stage.kvell.group/v1/smz/receipts

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

Название
Тип данных Обязательно Описание
inn string Да ИНН самозанятого
amount integer Да Сумма чека в копейках
service_name string Да Название услуги в чеке
description string Нет Комментарий
merchant_inn string Нет Если не будет передано, то ИНН будет ИНН ЮЛ инициатора запроса
merchant_name string Нет Если не будет передано, то название будет название ЮЛ инициатора запроса

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

{
  "inn": "230900456295",
  "amount": 100,
  "service_name": "Test service 2",
  "description": "string",
  "merchant_inn": "7819853660", 
  "merchant_name": "Рога и Копыта"
}

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

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

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

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

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

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

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

{
  "id": 0,
  "merchant_inn": "string",
  "merchant_name": "string",
  "client": {
    "id": 0,
    "inn": "string",
    "phone": "string",
    "email": "string",
    "created_at": "2024-07-10T18:26:56.931Z"
  },
  "amount": 0,
  "service_name": "string",
  "description": "string",
  "status": "string",
  "message": "string",
  "remote_url": "string",
  "created_at": "2024-07-10T18:26:56.931Z"
}
{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

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

  • id - уникальный идентификатор созданного чека
  • merchant_inn - ИНН ЮЛ
  • merchant_name - название ЮЛ
  • client - информация самозанятого, связанный с чеком
  • amount - cумма в чеке, в копейках
  • service_name - название услуги в чеке
  • description - комментарий
  • status - статус чека:
    • created - чек создан
    • processing - чек в процессе регитрации
    • failed - ошибка формирования чека
    • canceling - чек в процессе аннулирования
    • canceled - чек анулирован
    • ready - чек зарегистирован и готов к выплате
    • paid - чек успешно выплачен
  • message - сообщение об ошибке, в случае неуспешного пробития чека
  • remote_url - url адрес сформированного чека
  • created_at - дата создания чека