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

api/wallet/statement - Получение выписки по операциям Кошелька

  • HTTP‑метод: POST
  • URL: /api/wallet/statement
  • Форма взаимодействия: Сервер-сервер
  • Формат тела запроса: application/json
  • Назначение: получение выписки по операциям Кошелька.

URL

1
https://gateway-docs.wallet.kvell.group/api/wallet/statement

1
/api/wallet/statement

Структура запроса

Поле Тип Обяз. Описание
terminal str ✔ Уникальный идентификатор учетной записи ТСП в ПЦ.
wallet_public_id str ✔ Уникальный идентификатор Кошелька.
signature str ✔ Цифровая подпись запроса. Алгоритм расчёта — см. Формирование подписи.
Необязательные параметры
start str Дата начала периода выписки в формате yyyy.MM.ddTHH:mm:ss.
end str Дата окончания периода выписки в формате yyyy.MM.ddTHH:mm:ss.
count int Количество операций для возврата в выписке (максимум 500). (по умолчанию 100)

Структура ответа

Поле Тип Обяз. Описание
statement_row list[StatementRowResponseDTO] ✔ Массив записей выписки.

Вложенный объект statement_row (StatementRowResponseDTO)

Поле Тип Обяз. Описание
order_id int ✔ Идентификатор заказа в ПЦ. Пример: 1009982
order_status str ✔ Статус заказа. Пример: REGISTERED
client_id str Идентификатор пользователя ТСП. Пример: test
tx_id int ✔ Идентификатор операции. Пример: 5587788
tx_created_at str ✔ Дата и время операции. Пример: 2024.01.28 00:23:19
tx_type str ✔ Тип операции. Пример: P2PTRANSFER
type str Тип операции (например, Payout). Пример: Payout
ref str ✔ Идентификатор Кошелька. Пример: zzz
pan2 str Маскированный номер карты получателя. Пример: 557072******5300
amount int ✔ Сумма операции. Пример: 100
currency int Валюта операции. Пример: 643
fee int Комиссия. Пример: 100
balance_before int Баланс до операции. Пример: 69668732
balance_after int Баланс после операции. Пример: 69667632
tx_approval_code str ✔ Код авторизации. Пример: 122004

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

{
    "statement_row": [
        {
            "order_id": 1009982,
            "order_status": "REGISTERED",
            "client_id": "test",
            "tx_id": 5587788,
            "tx_created_at": "2024.01.28 00:23:19",
            "tx_type": "P2PTRANSFER",
            "type": "Payout",
            "ref": "zzz",
            "pan2": "557072******5300",
            "amount": 100,
            "currency": 643,
            "fee": 100,
            "balance_before": 69668732,
            "balance_after": 69667632,
            "tx_approval_code": "122004"
        }
    ]
}

{
    "error_code": "TERMINAL_NOT_FOUND",
    "technical_message": "Terminal not found",
    "timestamp": 1751976000,
    "details": null,
    "request_id": "b3b3c1f0-4b3a-4f3a-9b1a-1234567890ab"
}

Примечания

  • При получении запроса ПЦ проверяет:
  • Правильность расчета подписи и корректность параметров запроса;
  • Наличие wallet_public_id по указанному терминалу;
  • Если указаны и start, и end, ПЦ проверяет, что start не позже end — иначе возвращается ошибка валидации поля start ("the start date cannot be greater than the end date").