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

Список транзакций

Метод получения списка транзакций.

URL

Метод: GET

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

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

Название Тип данных Обязательно Описание
page int Да Номер страницы
size int Да Количество элементов на странице
status string Да Статус транзакции
date_from string Да Начало периода utc для фильтрации в формате 2024-05-21T10:39:53.764540Z
date_to string Да Конец периода utc для фильтрации в формате 2024-05-22T10:39:53.764540Z

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

Название</div
 Тип данных Обязательно Описание
X-Api-Key string Да Уникальный идентификатор магазина
X-Request-Id string Да ID запроса в формате uuid4. Пример: e72ebb15-58d4-496d-891d-00c806f0fdf2
X-Signature string Да Подпись

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

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

sha256({x-api-key}{x-request-id}{secret_key})

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

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

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

{
  "items": [
    {
      "id": "string",
      "description": "string",
      "transaction": "string",
      "amount": 0,
      "commission": 0,
      "inner_commission": 0,
      "status": "string",
      "created_at": "2025-02-27T15:40:25.904Z",
      "instrument": "string",
      "extra_data": {},
      "payment": {},
      "payout": {
        "card_mask": "411111**1111"
      }
    }
  ],
  "total": 0,
  "page": 0,
  "size": 0,
  "pages": 0
}

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

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

Название Тип данных Описание
id string ID транзакции в системе
status string Статус транзакции
transaction string Уникальный номер транзакции на стороне мерчанта
amount integer Сумма в копейках
description string Описание к транзакции
created_at string Дата создания транзакции по UTC
instrument string Способ оплаты: card - карта, sbp - СБП
commission integer Внешняя комиссия в копейках
inner_commission integer Внутренняя комиссия в копейках
extra_data json Дополнительная информация
payment json Дополнительная информация о платеже
payout json Дополнительная информация о выплате

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

Название Описание
new Новая транзакция
processing Транзакция обрабатывается
canceled Транзакция отклонена
completed Транзакция выполнена
refunded Транзакция возвращена
part_refunded Транзакция частично возвращена
reversed Транзакция отменена
part_reversed Транзакция частично отменена