PATCH /customer/{phoneNumber}/balance

Изменение бонусного баланса Клиента. Начисление и списание бонусов.

Запрос

Параметры адресной строки (URI parameters)

ПолеОписаниеТипОбязательное
phoneNumber

string

Required

Тело запроса (объект PatchCustomerBalance )

ПолеОписаниеТипОбязательное
amount

Количество бонусов. Если положительное, тогда бонусы начисляются. Если отрицательное - списываются

decimal

Да

transactionType

Тип начисления/списания бонусов. Если не задано, тогда по умолчанию принимает значения Debit_Manual или Credit_Manual (в зависимости от знака параметра Amount)

CustomerBalanceTransactionType
activatedInDays

Через сколько дней активировать начисляемые бонусы. По умолчанию = 0 (активируются немедленно)

int
burnsInDays

Через сколько дней сгорят бонусы после активации. По умолчанию = 365

int

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

application/json, text/json

Sample:
{
  "amount": 1.0,
  "transactionType": 0,
  "activatedInDays": 2,
  "burnsInDays": 3
}

Ответ

Тело ответа ( объект PatchCustomerBalanceResult )

ПолеОписаниеТипОбязательное
phoneNumber

Номер телефона клиента

string

Да

cardNumber

Номер карты клиента

string

Да

amount

Количество бонусов. Если положительное, тогда бонусы начисляются. Если отрицательное - списываются

decimal

Да

activatedInDays

Через сколько дней активировать начисляемые бонусы. По умолчанию = 0 (активируются немедленно)

int
burnsInDays

Через сколько дней сгорят бонусы после активации. По умолчанию = 365

int
activeBonusBalance

Количество активных бонусов на счету

decimal
inactiveBonusBalance

Количество неактивных бонусов на счету

decimal
level

Уровень реферальной программы по которой начислились бонусы. Уровень 0 означает, что бонусы начислены покупателю

int
transactionType

Тип транзакции

CustomerBalanceTransactionType

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

application/json, text/json

Sample:
{
  "phoneNumber": "sample string 1",
  "cardNumber": "sample string 2",
  "amount": 3.0,
  "activatedInDays": 1,
  "burnsInDays": 1,
  "activeBonusBalance": 4.0,
  "inactiveBonusBalance": 5.0,
  "level": 6,
  "transactionType": 0
}