Skip to content

Метод: Запрос информации о транзакциях пользователя платформы

Метод служит для запроса информации о транзакциях пользователя на платформе promotivation.

URL

 POST {домен}/api/v2/user/transactions

Описание

Метод служит для запроса информации о транзакциях пользователя на платформе promotivation.

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

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

Формат запроса:

POST {домен}/api/v2/user/transactions

"Authorization: Bearer 1jijdsaohdiadibbcsanco……"
"Content-Type: application/json"

{
  "idExternal": "dkfsa124ksad",
  "quantity": "40",
  "offset": "10"
}

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

Параметр Тип Описание Обязательный Шифрование
Authorization string Уникальный токен аутентификации Да Нет
idExternal string Внешний идентификатор пользователя Да Да
quantity int Количество запрашиваемых транзакций. По-умолчанию 50 шт. Допустимое количество от 1 до 1000. Нет Да
offset int Смещение. По-умолчанию начиная с последней. Допустимое количество от 1 до 1000. Нет Да

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

Пример успешного ответа

{
    "userTransactions": [
    {
            "date": "04.12.2023 07:18:40",
            "typeTransaction": "payment",
            "status": "in progress",
            "typeReward": "moneyTransfer",
            "rewardComment": "",
            "sum": "5220,10"
    },
…
    {
            " date": "06.12.2023 07:18:40",
            "typeTransaction": "payment",
            "status": "in progress",
            "typeReward": "moneyTransfer",
            "rewardComment": "",
            "sum":"10020,00№
    }]
}

Параметры успешного ответа

Параметр Тип Описание
userTransactions string Массив транзакций пользователя.
date string Дата и время, в формате 04.12.2023 07:18:40
typeTransaction string Тип транзакции: - payment - списание; - refill - пополнение
status string Статус операции. (список статусов)
typeReward string Тип вознаграждения (список вознаграждений )
rewardComment string Тип карт (список карт)
sum string Сумма транзакции

Пример ответа с ошибкой

{
  "status": "INVALID_FIELDS",
  "message: " The fields are uncorrected quantity, offset ".
}

Параметры ответа с ошибками

Параметр Тип Описание
status string Статус ошибки
message string Информационное сообщение

Возможные ошибки

Статус Описание
INVALID_FIELDS Некорректное поле. Поле не соответствует требованиям.
USER_NOT_FOUND Пользователь не найден
NO_TRANSACTIONS_FOUND Транзакции не найдены
TOKEN_ERROR Токен не найден