Уровни карт

Для градации карт в зависимости от накоплений пользователя предусмотрены уровни карт. С помощью них можно накладывать ограничения по оплате чеков, количеству операций и прочее, так же их можно использовать как условие скидок.

 

Добавить уровень

При выполнении метода проверяется уникальность штрихового кода карты.

POST

/organization/card_level/add

  

Заголовки

token // Токен доступа выданный при авторизации

 

Входной JSON

{

   "id":  "",

//[Необязательный]. Идентификатор уровня карты. Если не передан - генерируется сервисом.

   "name": "",

// Наименование уровня

   "order": 0,

// Порядок следования. 0 - первый уровень, далее просматриваются большие - в зависимости от текущего уровня карты и суммы накоплений

   "accum_level": 0,

// Сумма накоплений, при достижении которой уровень становится доступным для перехода

   "reset_card_accum": false,

// Сбрасывать сумму накопления при переходе на новый уровень

   "max_payment_percent": 0,

// Максимальный процент при оплате чека, влияет на функцию post balance

   "activity_restriction_period": 0,

// Период количества операций - за какой период количество операций не должно превышать указанное в параметре activity_restriction_count

// 0 - Нет контроля

// 1 - День

// 2 - Неделя

// 3 - Месяц

// 4 - Квартал

// 5 - Год

// Если количество операций будет превышено - карта будет временно заблокирована

   "activity_restriction_count": 0,

// Допустимое количество операций

   "inactivity_bonus_erase_period": 0,

// Дней не активности по карте до сгорания всех бонусов

 

Выходной JSON

{
"code": 0,
"message": "Операция выполнена",
"id": "eeaedde5-5c71-4a7a-bc2d-5e04bdb8671e" //Идентификатор созданного уровня
}

 

 

Изменить уровень

 

POST

/organization/card_level/{id}

  

Параметры URI

id // Идентификатор существующего уровня

 

Заголовки

token // Токен доступа выданный при авторизации

 

Входной JSON

{

   "name": "",

// Наименование уровня

   "order": 0,

// Порядок следования. 0 - первый уровень, далее просматриваются большие - в зависимости от текущего уровня карты и суммы накоплений

   "accum_level": 0,

// Сумма накоплений, при достижении которой уровень становится доступным для перехода

   "reset_card_accum": false,

// Сбрасывать сумму накопления при переходе на новый уровень

   "max_payment_percent": 0,

// Максимальный процент при оплате чека, влияет на функцию post balance

   "activity_restriction_period": 0,

// Период количества операций - за какой период количество операций не должно превышать указанное в параметре activity_restriction_count

// 0 - Нет контроля

// 1 - День

// 2 - Неделя

// 3 - Месяц

// 4 - Квартал

// 5 - Год

   "activity_restriction_count": 0,

// Допустимое количество операций

   "inactivity_bonus_erase_period": 0,

// Дней не активности по карте до сгорания всех бонусов

 

Выходной JSON

{
"code": 0,
"message": "Операция выполнена",
}

 

 

Удалить уровень

POST

/organization/card_level/{id}/delete

  

Параметры URI

id // Идентификатор существующего уровня

 

Заголовки

token // Токен доступа выданный при авторизации

 

Входной JSON

{

}

 

Выходной JSON

{
    "code": 0,

         "message": "Операция выполнена"
}

 

Получить список уровней

GET

/organization/card_level

  

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

page //[Необязательный]. Номер страницы которую нужно получить

per_page //[Необязательный]. Количество строк на страницу

calculate_count //[Необязательный]. Булево, возвращать расчет пагинации или нет

 

Заголовки

token // Токен доступа выданный при авторизации

 

Выходной JSON

{
       "code": 0,
       "message": "Операция выполнена",


       "card_level":[ // Список уровней
       {

   "row_number": 1,

// Номер строки

   "id": "",

// Идентификатор уровня

   "name": "",

// Наименование уровня

   "order": 0,

// Порядок следования. 0 - первый уровень, далее просматриваются большие - в зависимости от текущего уровня карты и суммы накоплений

   "accum_level": 0,

// Сумма накоплений, при достижении которой уровень становится доступным для перехода

   "reset_card_accum": false,

// Сбрасывать сумму накопления при переходе на новый уровень

   "max_payment_percent": 0,

// Максимальный процент при оплате чека, влияет на функцию post balance

   "activity_restriction_period": 0,

// Период количества операций - за какой период количество операций не должно превышать указанное в параметре activity_restriction_count

// 0 - Нет контроля

// 1 - День

// 2 - Неделя

// 3 - Месяц

// 4 - Квартал

// 5 - Год

   "activity_restriction_count": 0,

// Допустимое количество операций

   "inactivity_bonus_erase_period": 0,

// Дней не активности по карте до сгорания всех бонусов

},...

      ],

 

     "pagination": 

       {

         "per_page":    10,    // Количество строк на страницу

         "page"    :    1,     // Номер текущей страницы

         "items"   :    15275, // Всего записей, если calculate_count=true

         "pages"   :    1528   // Всего страниц, если calculate_count=true

      }
}

 

 

 

 

Наверх