Метод: Запрос баланса пользователя
Метод служит для запроса баланса пользователя на платформе promotivation.
URL
POST {домен}/api/v2/user/balance
Описание
Метод служит для запроса баланса пользователя на платформе promotivation.
Структура запроса
Пример запроса
Формат запроса:
POST {домен}/api/v2/user/balance
"Authorization: Bearer 1jijdsaohdiadibbcsanco……"
"Content-Type: application/json"
{
"idExternal": "dkfsa124ksad",
}
Параметры запроса
| Параметр | Тип | Описание | Обязательный | Шифрование |
|---|---|---|---|---|
Authorization |
string | Уникальный токен аутентификации | Да | Нет |
idExternal |
string | Внешний идентификатор пользователя | Да | Да |
Структура ответа
Пример успешного ответа
{
"status": "OK",
"userBalance": "10520.5000"
}
Параметры успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
status |
string | Статус запроса |
userBalance |
string | Баланс пользователя |
Пример ответа с ошибкой
{
"status": "USER_NOT_FOUND",
"message: " User not found in the system".
}
Параметры ответа с ошибками
| Параметр | Тип | Описание |
|---|---|---|
status |
string | Статус ошибки |
message |
string | Информационное сообщение |
Возможные ошибки
| Статус | Описание |
|---|---|
USER_NOT_FOUND |
Пользователь не найден |
TOKEN_ERROR |
Токен не найден |