Регистрация транзакции

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

           

POST

/organization/transaction/add

 

Заголовки

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

Входной JSON

{

  "card_id":"Card_1",

// Идентификатор карты. Если переданная карта связана с мастер-картой, изменится баланс мастер-карты.

  "time":  1502209370817,

// Универсальное время

  "type":  0,

// Тип транзакции. 0 - начисление, 1 - списание.

  "sum":  15,

// Сумма баллов

  "author":"Иван Сидорович",

// Автор операции

  "description":"Продажа в новом магазине",

// Дополнительное описание

  "doc_id":"doc_id_1",

// Идентификатор документа во внешней системе

  "doc_type":  0,

// Вид документа во внешней системе

  "kkm_id":"kkm_id_1",

// [Необязательный]. Идентификатор кассы

  "shop_id":"kkm_id_1"

// Идентификатор магазина,

  "discount_id":"discount_id_1",

// [Необязательный]. Идентификатор скидки, если транзакция выполняется для отложенного начисления/списания по акции

  "check_activity_counter":true,

// [Необязательный]. Признак проверки активности. Если настроено ограничение на количество операций в течение суток, при установленном признаке транзакция будет расцениваться как активность по карте и увеличит счетчик операций. При достижении ограничения - метод вернет ошибку.

 

  "invalidate_period":  0,

// [Необязательный]. Дней до сгорания баллов.

// Если не передан берется из настроек организации

 

  "activation_period":  0,

// [Необязательный]. Дней до активации баллов.

// Если не передан берется из настроек организации

 

"activation_base_date":  1546749628960,

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

 

"invalidate_base_date":1548028799000

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

 

}

 

Выходной JSON

{
  "id"     : "DF3C7F90-FB62-483E-B23E-E21162CB5AFF",

// Идентификатор транзакции

  "time"   : 1502209649747,

// Время транзакции

  "code"   : 0,

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

}

Получить журнал транзакций

GET

/organization/transaction

 

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

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

doc_id // Строка

 

//[Необязательный]. Идентификатор карты

card_id // Строка

 

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

shop_id // Строка

 

//[Необязательный]. Идентификатор кассы

kkm_id // Строка

 

//[Необязательный]. Получение доп информации о транзакции

receive_cheque_data // Булево

 

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

date_from // Число, unixtime в миллисекундах 1538057266000

 

//[Необязательный]. Дата до которой получить выборку

date_to // Число, unixtime в миллисекундах 1538057266000

 

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

page

 

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

per_page

 

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

calculate_count

Заголовки

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

Выходной JSON

{

  "code":  0,

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

   "transactions":     

      [

        {

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

      "row_number":      1,

 

// Идентификатор транзакции

      "id":"FAC75CEC-EADD-435B-93F8-8BFCEDCCC6C6",

 

// Идентификатор карты по которой совершена транзакция

      "card_id":"e499a024-3962-4a31-a93b-b11e6b8c5b55",

 

// Идентификатор мастер карты (при накоплениях по нескольким картам)

      "mastercard_id":"e499a024-3962-4a31-a93b-b11e6b8c5b55",

 

// Время свершения транзакции в миллисекундах, универсальное

      "time":      1539073397200,

 

// Сумма тразакции

      "sum":10,

 

// Тип транзакции. 0 - внесение, 1 - изъятие

      "type":      1,

 

// Автор транзакции

      "author":"админ",

 

// Описание транзакции

      "description":"Оплата бонусами / начисление баллов",

 

// Идентификатор документа, по которому совершена транзакция

      "doc_id":"efa36c95-cb9d-11e8-a520-54a05079c2b5",

 

// Идентификатор кассы ккм по которой была транзакция

      "kkm_id":"b6aa0ebd-0566-11e7-8aac-54a05079c2b5",

 

// Идентификатор магазина

      "shop_id":"3406f49e-8b35-11e8-a718-54a05079c2b5",

 

// Тип документа. Для классификации со стороны клиента

      "doc_type":      0,

 

// Дата сгорания баллов

      "invalidate_period":      253370764800000,

 

// Дата активации баллов

      "activation_period":      1539073397200,

 

// Скидка по которой совершена транзакция

      "discount_id":""

        }     

      ],

 

// Пагинация

  "pagination": 

      {

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

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

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

         "pages"   :    1528   // Всего страниц

     }

}