HW agent API 2.28.0

Раздел API

Сверка

Сверка за день: каждая оплата и возврат на терминале — с чеком на ту же сумму, итог терминала — с итогом чеков; с выгрузкой ОФД (CSV) — чеки, которых нет в ОФД, и чеки ОФД, пробитые не через агента.

GET/api/v1/reconciliationСверка терминала и ККТ за день
POST/api/v1/reconciliationСверка с выгрузкой ОФД
GET/api/v1/reconciliation/ledgerЖурнал сверки за день

Сверка терминала и ККТ за день#

GET/api/v1/reconciliation

Каждая оплата и возврат на терминале — с чеком на ту же сумму безналичными, итог терминала — с итогом чеков. Данные — журнал сверки агента (чеки и операции по карте через агента). date — день, по умолчанию сегодня

Параметры

ИмяГдеТипОписание
datequerystring date

Ответ 200 application/json

Поля · Report
  • datestring date
  • okboolean
  • errorsinteger int32
  • warningsinteger int32
  • summarySummary
    13 полей · Summary
    • terminalPaymentsTotal
      2 поля · Total
      • countinteger int32
      • suminteger int64
    • terminalRefundsTotal
      2 поля · Total
      • countinteger int32
      • suminteger int64
    • terminalCancelsTotal
      2 поля · Total
      • countinteger int32
      • suminteger int64
    • terminalNetinteger int64
    • receiptsTotal
      2 поля · Total
      • countinteger int32
      • suminteger int64
    • returnsTotal
      2 поля · Total
      • countinteger int32
      • suminteger int64
    • correctionsTotal
      2 поля · Total
      • countinteger int32
      • suminteger int64
    • kktCashinteger int64
    • kktCardinteger int64
    • kktCardNetinteger int64
    • ofdRowsinteger int32
    • ofdSuminteger int64
    • ofdOtherFninteger int32
  • issuesмассив Issue
    8 полей · Issue
    • codestring
    • severitystring
      значения: ERROR WARNING
    • atstring date-time
    • registerinteger int32
    • terminalinteger int32
    • fdinteger int64
    • amountinteger int64
    • messagestring

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl
curl 'http://localhost:7790/api/v1/reconciliation'
curl
curl 'https://cloud.hw-connector.ru/agent/api/v1/reconciliation' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'

Сверка с выгрузкой ОФД#

POST/api/v1/reconciliation

То же плюс выгрузка чеков из личного кабинета ОФД (CSV: номер ФД, сумма, по возможности ФН и дата): чек есть в журнале, но не в ОФД; есть в ОФД, но пробит не через агента; суммы не совпадают

Тело запроса application/json обязательное

Поля · OfdRequest
  • datestring dateобязательное
  • ofdCsvstringобязательное
    от 0
    до 20000000
JSON
{
  "date": "2026-11-01",
  "ofdCsv": "string"
}

Ответ 200 application/json

Поля · Report
  • datestring date
  • okboolean
  • errorsinteger int32
  • warningsinteger int32
  • summarySummary
    13 полей · Summary
    • terminalPaymentsTotal
      2 поля · Total
      • countinteger int32
      • suminteger int64
    • terminalRefundsTotal
      2 поля · Total
      • countinteger int32
      • suminteger int64
    • terminalCancelsTotal
      2 поля · Total
      • countinteger int32
      • suminteger int64
    • terminalNetinteger int64
    • receiptsTotal
      2 поля · Total
      • countinteger int32
      • suminteger int64
    • returnsTotal
      2 поля · Total
      • countinteger int32
      • suminteger int64
    • correctionsTotal
      2 поля · Total
      • countinteger int32
      • suminteger int64
    • kktCashinteger int64
    • kktCardinteger int64
    • kktCardNetinteger int64
    • ofdRowsinteger int32
    • ofdSuminteger int64
    • ofdOtherFninteger int32
  • issuesмассив Issue
    8 полей · Issue
    • codestring
    • severitystring
      значения: ERROR WARNING
    • atstring date-time
    • registerinteger int32
    • terminalinteger int32
    • fdinteger int64
    • amountinteger int64
    • messagestring

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl
curl -X POST 'http://localhost:7790/api/v1/reconciliation' \
  -H 'Content-Type: application/json' \
  --data '{"date":"2026-11-01","ofdCsv":"string"}'
curl
curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/reconciliation' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Content-Type: application/json' \
  --data '{"date":"2026-11-01","ofdCsv":"string"}'

Журнал сверки за день#

GET/api/v1/reconciliation/ledger

Чеки и операции по карте через агента: суммы по видам оплаты, ФД, RRN

Параметры

ИмяГдеТипОписание
datequerystring date

Ответ 200 application/json

Массив · Entry
  • kindstring
  • atstring date-time
  • registerinteger int32
  • terminalinteger int32
  • opstring
  • fdinteger int64
  • fnstring
  • shiftinteger int32
  • totalinteger int64
  • cashinteger int64
  • cardinteger int64
  • otherinteger int64
  • rrnstring
  • authCodestring
  • cardNumberstring

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl
curl 'http://localhost:7790/api/v1/reconciliation/ledger'
curl
curl 'https://cloud.hw-connector.ru/agent/api/v1/reconciliation/ledger' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'