Оценка карт

Раздел описывает метод и параметры для получения информации для оценки количества и суммы поступлений и списаний по карте за указанный период времени.

Структура

Сводка или отчёт по истории транзакций это структура с ключами-датами в формате YYYY-MM (по месяцам).

Каждому месяцу соответствует таблица сводок для конкретных типов транзакций. Если за определённый месяц отсутствуют транзакции, ключ для данного месяца включается в ответ с пустой структурой в качестве значения.

Атрибуты

Name
amount
Type
integer
Description
Сумма транзакций данного типа за месяц в тийинах.
Name
count
Type
integer
Description
Количество транзакций данного типа за месяц.

{
  "2022-11": {
    "DEBIT": {
      "amount": 1301476866,
      "count": 71
    },
    "DEBIT_REVERSAL": {
      "amount": 30000000,
      "count": 1
    },
    "REFILL_FROM_BANK_ACCOUNT": {
      "amount": 1863500164,
      "count": 3
    }
  },
  "2022-12": {
    "DEBIT": {
      "amount": 521476866,
      "count": 52
    }
  },
  "2023-01": {}
}

POST/getSummary

Получение сводки

Возвращает историю транзакций по карте, сгруппированную по месяцу и типу транзакции за запрашиваемый период.

Для кажого месяца и типа в результате предоставляется сумма и количество транзакций.

Параметры

Name
id
Type
string обязательный
Description
Уникальный идентификатор запроса.
Name
token
Type
string обязательный
Description
Токен карты, полученный при токенизации.
Name
from
Type
string обязательный
Description
Месяц начала периода истории в формате YYYY-MM (ISO 8601).
Для карт системы Uzcard должен быть как минимум за два месяца до текущей даты.
Name
to
Type
string обязательный
Description
Месяц окончания периода истории в формате YYYY-MM (ISO 8601). Этот месяц также полностью включается в результат и должен быть раньше текущего месяца.
Интервал запрашиваемого периода не должен превышать один год.

Запрос

POST

/getSummary

{
  "id": "41185257-b3d0-41f3-babd",
  "token": "62d602f4-115d-46ce-a385",
  "from":"2022-11",
  "to": "2023-01"
}

Ответ

{
  "2022-11": {
    "DEBIT": {
      "amount": 1301476866,
      "count": 71
    },
    "DEBIT_REVERSAL": {
      "amount": 30000000,
      "count": 1
    },
    "REFILL_FROM_BANK_ACCOUNT": {
      "amount": 1863500164,
      "count": 3
    }
  },
  "2022-12": {
    "DEBIT": {
      "amount": 521476866,
      "count": 52
    }
  },
  "2023-01": {}
}

Типы транзакций

Значение	Описание
`DEBIT`	Снятие с карты
`CREDIT`	Пополнение карты
`P2P_DEBIT`	Снятие c карты отправителя при переводе между картами
`P2P_CREDIT`	Пополнение карты получателя при переводе между картами
`DEBIT_REVERSAL`	Возврат снятых средств
`CREDIT_REVERSAL`	Возврат пополнения
`P2P_DEBIT_REVERSAL`	Возврат снятых средств при переводе между картами
`P2P_CREDIT_REVERSAL`	Возврат пополнения при переводе между картами
`CASH_IN`	Пополнение карты наличными средствами через банкомат
`CASH_OUT`	Снятие наличных средств с карты через банкомат
`REFILL_FROM_BANK_ACCOUNT`	Пополнение карты с банковского счёта