Метод: Списание баллов у участника

Метод служит для списания баллов у участника платформы.

---

URL:

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

---

Описание: Метод служит для списания баллов у участника платформы.

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

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

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

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

"Authorization: Bearer 1jijdsaohdiadibbcsanco……"

"Content-Type: application/json"

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

---

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

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

---

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

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

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

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

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

---

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

{
  "status": "USER_NOT_FOUND",
  "message: " User not found in the system ".
}

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

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

---

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

Значение поля "status"	Значение поля "message"	Описание	Сценарий возникновения ошибки
USER_NOT_FOUND	User not found in the system	Участник не найден	Участник с запрашиваемым idExternal не найден в системе
EXPIRATION_DATE_NOT_ACTIVATED	Points expiration date is not activated	Услуга по сгоранию баллов не активирована на платформе	Если партнер прислал заполненное поле при не активированной услуге сгорание баллов на платформе.
INVALID_FIELDS	The fields are uncorrected: sum, comment, secret.	Некорректное поле. Поле не соответствует требованиям. Для secret: поле не расшифровано или прислан ключ, которым нельзя расшифровать данные.	1) Система не может расшифровать ключ в поле secret; 2) Ключом невозможно расшифровать поля; 3) Поле не соответствует ограничениям. Проверяется каждое отдельно, в сообщение передается только конкретное поле или поля.
INSUFFICIENT_FUNDS	Insufficient funds to complete the operation	Недостаточно баллов на балансе пользователя
FORBIDDEN		Доступ запрещен.	Выключена функция у партнера
TOKEN_ERROR	Token error	Токен не найден	Токен не прошел валидацию
NOT_VALID_IP_PARTNER	Partner IP is not correct	IP партнера не корректен	Запрос прислан не с разрешенного IP адреса (не из белого списка)