СБП (статический QR)

Приём платежей через статический QR-код СБП. Статический QR-код привязан к магазину и позволяет принимать платежи без создания отдельной сессии на каждую транзакцию — покупатель сканирует один и тот же код и самостоятельно указывает сумму, либо сумма фиксируется при создании шаблона.

Создание шаблона QR-кода

URL

Метод: POST

Production: https://api.pay.kvell.group/v1/qr-templates/sbp
Stage: https://api.pay.stage.kvell.group/v1/qr-templates/sbp

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

Название	Тип данных	Обязательно	Описание
`name`	string	Да	Название шаблона (не более 140 символов)
`payment_purpose`	string	Да	Назначение платежа, отображаемое плательщику (не более 140 символов)
`qr_width`	integer	Да	Ширина изображения QR-кода (от 15 до 100)
`qr_height`	integer	Да	Высота изображения QR-кода (от 15 до 100)
`amount`	integer	Нет	Фиксированная сумма в копейках. Если не указана — плательщик вводит сумму сам
`start_date`	string	Нет	Дата начала действия шаблона (ISO 8601). Указывается вместе с `end_date`
`end_date`	string	Нет	Дата окончания действия шаблона (ISO 8601). Должна быть позже `start_date`

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

{
  "name": "Оплата в кассе",
  "payment_purpose": "Оплата товаров и услуг",
  "qr_width": 50,
  "qr_height": 50,
  "amount": 10000,
  "start_date": "2024-01-01T00:00:00",
  "end_date": "2024-12-31T23:59:59"
}

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

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

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

sha256({X-Api-Key}{тело запроса}{secret_key})

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

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

200: Success422: Validation error

{
  "id": 1,
  "remote_template_id": "BSQR00000XXXXXX",
  "description": null,
  "amount": 10000,
  "start_date": "2024-01-01T00:00:00",
  "end_date": "2024-12-31T23:59:59",
  "payload": "https://qr.nspk.ru/BSQR00000XXXXXX",
  "name": "Оплата в кассе",
  "currency": "RUB",
  "qr_width": 50,
  "qr_height": 50,
  "render_qr": "iVBORw0KGgoAAAANSUhEUgAA..."
}

{
  "errors": [
    {
      "message": "string",
      "code": 0
    }
  ]
}

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

Название	Тип данных	Описание
`id`	integer	ID шаблона в системе
`remote_template_id`	string	ID шаблона в СБП
`description`	string	Описание шаблона
`amount`	integer	Фиксированная сумма в копейках (null — сумма задаётся покупателем)
`start_date`	string	Дата начала действия шаблона
`end_date`	string	Дата окончания действия шаблона
`payload`	string	Данные QR-кода (ссылка СБП)
`name`	string	Название шаблона
`currency`	string	Валюта (RUB)
`qr_width`	integer	Ширина изображения QR-кода
`qr_height`	integer	Высота изображения QR-кода
`render_qr`	string	Изображение QR-кода в формате base64

Получение шаблона QR-кода по ID

URL

Метод: GET

Production: https://api.pay.kvell.group/v1/qr-templates/{qr_template_id}
Stage: https://api.pay.stage.kvell.group/v1/qr-templates/{qr_template_id}

Параметры пути

Название	Тип данных	Обязательно	Описание
`qr_template_id`	integer	Да	ID шаблона

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

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

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

sha256({X-Api-Key}{qr_template_id}{secret_key})

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

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

200: Success404: Not found422: Validation error

{
  "id": 1,
  "remote_template_id": "BSQR00000XXXXXX",
  "description": null,
  "amount": 10000,
  "start_date": "2024-01-01T00:00:00",
  "end_date": "2024-12-31T23:59:59",
  "payload": "https://qr.nspk.ru/BSQR00000XXXXXX",
  "name": "Оплата в кассе",
  "currency": "RUB",
  "qr_width": 50,
  "qr_height": 50,
  "render_qr": "iVBORw0KGgoAAAANSUhEUgAA..."
}

{
  "errors": [
    {
      "message": "string",
      "code": 0
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "code": 0
    }
  ]
}