Получение баланса балльного счёта

Описание

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

URL-адрес

Метод: POST

https://example.com/api/v1.1/loyalty/account/balance

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abc123def456"	Да	API-токен
loyalty_program_id	int	123	Да	Идентификатор программы лояльности
points_currency_iid	int	1	Нет	Внутренний идентификатор типа баллов
points_currency_eid	string	"starts"	Нет	Внешний идентификатор типа баллов (например, "starts")
matching	string	"email"	Да	Способ поиска профиля: email, phone, profile_id, custom
field_name	string	"user_id"	Да, если matching = custom	Название пользовательского поля для поиска
field_value	string / int	123456	Да, если matching = custom	Значение пользовательского поля
email	string	"user@example.com"	Да, если matching = email	Email участника
phone	string	"+1234567890"	Да, если matching = phone	Телефон участника в международном формате
profile_id	string	"profile123"	Да, если matching = profile_id	Идентификатор профиля

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

JSON

{
  "token": "abc123def456",
  "loyalty_program_id": 123,
  "points_currency_eid": "starts",
  "matching": "email",
  "email": "user@example.com"
}

XML

<xml>
  <token>abc123def456</token>
  <loyalty_program_id>123</loyalty_program_id>
  <points_currency_eid>starts</points_currency_eid>
  <matching>email</matching>
  <email>user@example.com</email>
</xml>

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

JSON

{
  "error": 0,
  "error_text": "Successful operation",
  "data": {
    "total_balance": "1000.00",
    "active_balance": "800.50"
  }
}

XML

<xml>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <data>
    <total_balance>1000.00</total_balance>
    <active_balance>800.50</active_balance>
  </data>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
total_balance	string	Общее количество баллов на балльном счёте (в строковом формате)
active_balance	string	Количество активных баллов на балльном счёте (в строковом формате)