Бонусный баланс

Возвращает бонусный баланс участника программы лояльности.

Сумма сгораемых бонусов вычисляется к дате, которая указана в параметре expire_in.

GET https://api.rees46.ru/loyalty/bonuses/balance

Параметры

Параметр	Обязателен?	Описание
shop_id	Да	API-ключ
shop_secret	Да	Секретный ключ API
identifier	Да	Идентификатор участника программы лояльности
expire_in	Нет	Дата, на которую считаем сгорание бонусов в формате YYYY-MM-DD. Если не указана, то используется дата в 2 недели от текущей даты

Запрос

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

curl https://api.rees46.ru/loyalty/bonuses/balance?shop_id=...&shop_secret=...&identifier=...&expire_in=YYYY-MM-DD

Ответ

Пример ответа сервера:

{
  "success": true,
  "payload": {
    "balance": {
      "active": 123,
      "pending": 456,
      "expiring": 789,
      "expire_in": "2030-12-12"
    }
  }
}

Расшифровка ответа:

Параметр	Описание
success	Запрос выполнен успешно или нет
payload.balance	Объект ответа
payload.balance.active	Количество активных бонусов
payload.balance.pending	Количество бонусов, ожидающих активации
payload.balance.expiring	Количество бонусов, которые скоро сгорят
payload.balance.expire_in	Дата, к которой сгорят бонусы из свойства expiring. Равна now() + expire_in

В случае ошибки ответ будет в формате:

{
  "success": false,
  "payload": {
    "message": "Identifier is not valid"
  }
}