Skip to content

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

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

URL

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

Описание

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

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

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

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

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

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

{
  "dateFrom": "01.11.2023",
  "dateTo": "30.11.2023"
}

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

Параметр Тип Описание Обязательный Шифрование
Authorization string Уникальный токен аутентификации Да Нет
quantity int Дата начала выборки. Формат дд.мм.гггг. Указанная дата, время с 00.00.00 включительно. Да Да
offset int Дата окончания выборки. Формат дд.мм.гггг. Указанная дата, время с 23.59.59 включительно. Да Да

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

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

{
    "partnerTransactions": [
    {      
            "idExternal": "ilfnfwe98fwdn",
            "date": "04.12.2023 07:18:40",
            "typeTransaction": "payment",
            "status": "in progress",
            "typeReward": "moneyTransfer",
            "rewardComment": "",
            "sum": "5220,10"
    },

    {
            "idExternal": "ilfnfwe98fwdn",
            "date": "06.12.2023 07:18:40",
            "typeTransaction": "payment",
            "status": "in progress",
            "typeReward": "moneyTransfer",
            "rewardComment": "",
            "sum":"10020,00"
    }]
}

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

Параметр Тип Описание
userTransactions string Массив транзакций пользователей парнёра
idExternal 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 Токен не найден