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

Реестр транзакций

Метод используется для формирования и отправки банковской справки в формате pdf на почту.

Во всех запросах необходимо передавать заголовки запроса:

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

При формировании подписи используется secret_key - секретный ключ, который находится в настройках магазина мерчанта.

Запрос на генерацию справки и отправку на почту

Метод: POST

  • Production: https://api.baas.kvell.group/v1/registries/transactions/pdf
  • Stage: https://api.baas.stage.kvell.group/v1/registries/transactions/pdf

Параметры запроса (JSON)

Название
Тип данных Обязательно Описание
email string Да Почта для отправки справки
transactions array[string] Да Список транзакций мерчанта
{
  "email": "example@kvell.ru",
  "transactions": [
    "96bc28ed-37f2-4c5b-95a4-93209b4b2764",
    "ad12a3e3-7e7b-45d9-8045-f4429ac1ed92",
    "e71a9a4c-6d5b-46fa-8b68-3be6121b24c0"
  ]
}

Формирование подписи

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

sha256({x-api-key}{json <тело запроса>}{secret_key})

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

    Успех, нет контента.
{
  "errors": [
    {
        "message": "Заказы не найдены",
        "code": 4
    }
  ]
}