Метод: Пополнение баланса пользователя

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

URL

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

Описание

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

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

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

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

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

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

{
  "idExternal": "dkfsa124ksad",
  "sum": "10000.00",
  "comment’": "Подарок на Новый Год",
  "deadline": "12.01.2025"
}

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

Параметр	Тип	Описание	Обязательный	Шифрование
`Authorization`	string	Уникальный токен аутентификации.	Да	Нет
`idExternal`	string	Внешний идентификатор пользователя. До 30 символов.	Да	Да
`sum`	string	Сумма пополнения.	Да	Да
`comment`	string	Комментарий к транзакции. До 128 символов.	Нет	Да
`deadline`	string	Срок, до которого действительны баллы. До 10 символов, в формате ДД.ММ.ГГГГ. Еслин е указано, то неограниченный срок жизни.	Нет	Да

Срок жизни баллов (deadline) возможно использовать только если функция активирована на платформе, в ином случае срок жизни не ограничен.

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

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

{
  "status": "OK",
  "idExternal": "skjbsvb8fb3fiw"
}

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

Параметр	Тип	Описание
`status`	string	Статус
`idExternal`	string	Внешний идентификатор пользователя (если не был передан)

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

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

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

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

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

Статус	Описание
`INVALID_FIELDS`	Некорректное поле. Поле не соответствует требованиям.
`USER_NOT_FOUND`	Пользователь с данным внешним идентификатором не существует в системе.
`EXPIRATION_DATE_ NOT_ACTIVATED`	Услуга по сгоранию баллов не активирована на платформе.
`TOKEN_ERROR`	Токен не найден.