incust Команды api · 3 4. Логин на терминале Для тестовых...

1

Incust Команды API

1. Общая информация

Web API шлюз: Адрес: https://webservice.incust.com/api Метод: POST Формат: XML Тестовые терминалы: 380501111111 / 0000 - бонусный 380502222222 / 0000 - скидочный Тестовые карточки: 380671111111 / 0000 380672222222 / 0000 Команды терминала (приложение продавца)

Проверка связи

Отправить продавцу СМС с паролем

Логин на терминале

Запрос карточки

Продажа

Отмена продажи

Итоговый отчёт и список операций на терминале

Отправить клиенту СМС с одноразовым паролем на трату бонусов

Отправить клиенту СМС с чеком

Запрос списка товарных позиций

Привязка дополнительных кодов к карте

Запрос списка клиентских счетов

Начисление на клиентский счет

Резервирование по клиентскому счету

Списание с клиентского счета

Отмена операции с клиентским счетом

Запрос номера карты заказа

Запрос информации о покупателе с Дисплея

Передача на Дисплей информации о чеке

Получение последнего сгенерированного номера карты Команды карты (приложение клиента)

Отправить клиенту СМС с паролем

Логин на карте

Итоги по карте

Список операций на карте

Список торговых точек

Связаться с нами

Рекомендовать другу

Профиль клиента

Изменить профиль клиента

2. Проверка связи

Проверка связи и работоспособности шлюза API. Запрос: GET: https://webservice.incust.com/api/ping POST:

Поле Значение Описание

https://incustapi.azurewebsites.net/api

https://webservice.incust.com/api/ping

2

cmd ping Код команды.

Пример: <root> <cmd>ping</cmd> </root> Или просто «ping», без xml тегов. Ответ:


cmd ping Код команды.

status 0000 Код статуса. 0000 – успешно.

statusdesc Ok Описание статуса или текст ошибки.

message pong Сообщение для экрана.

Пример: <root> <cmd>ping</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <responsemsg>pong</responsemsg> </root>

3. Отправить продавцу СМС с паролем

Для тестовых номеров смс не отправляется, используется пароль «0000»: 380501111111 – бонусный терминал 380502222222 – скидочный терминал Запрос:


cmd sendsmsterminalpassword Код команды.

serial 42229713F... Уникальный идентификатор терминала

appversion 1.09.2 Версия приложения

phone 380501111111 Номер телефона на который установлен терминал.

Пример: <root> <cmd>sendsmsterminalpassword</cmd> <serial>42229713F5F956A47D6C845DB74B6891</serial> <appversion>1.09.2</appversion> <phone>380501111111</phone> </root> Ответ:


cmd sendsmsterminalpassword Код команды.



message СМС с паролем отправлено на телефон +380501111111

Сообщение для экрана.

Пример: <root> <cmd>sendsmsterminalpassword</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <message>СМС с паролем отправлено на телефон +380501111111</message> </root>

3

4. Логин на терминале

Для тестовых номеров используется пароль «0000»: 380501111111 – бонусный терминал 380502222222 – скидочный терминал Запрос:


cmd loginterminal Код команды.



language Ru-ru Язык приложения

googlemessagesregid

APA91bHUdb... Идентификатор клиента для google сообщений


password 0000 Пароль терминала.

Пример: <root> <cmd>loginterminal</cmd> <serial>42229713F5F956A47D6C845DB74B6891</serial> <appversion>1.09.2</appversion> <language>Ru-ru</language> <googlemessagesregid>APA91bHUdbIH6D55y9F6Z6yARmS07b3iusNV7w6gFEm10cnn0Mi2L6jmHPIY1ngr7cOH7PqeEU9cYUJWiAQx8USthGDnk8Hfhug0RkgwPC9qXt9-GEFLqtmxcZWYCP2q4H80OrCORGfPywjJK4sys2u54ScHjy9nwQ</googlemessagesregid> <phone>380501111111</phone> <password>0000</password> </root> Ответ:


cmd loginterminal Код команды.



merchantgroup Кофейня на Колёсах Название торговой группы

merchantsubgroup СПД Парамонов В.К. Название торговой подгруппы

merchantname АА 2345 ВЕ Название торговой точки

basicrate 5 Базовая процентная ставка (для оффлайн операций), в процентах.

terminaltype B B – бонуc, D – скидка.

Пример: <root> <cmd>loginterminal</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <merchantgroup>Кофейня на Колёсах</merchantgroup> <merchantsubgroup>СПД Парамонов В.К.</merchantsubgroup> <merchantname>АА 2345 ВЕ</merchantname> <terminalphone>380501111111</terminalphone> <terminalname>Сергей Федоренко</terminalname> <basicrate>5</basicrate> <terminaltype>B</terminaltype> </root>

5. Запрос карточки на терминале

По номеру телефона\карточки получает информацию с сервера. Тестовые номера: 380671111111, номер карты TD111111 380672222222, номер карты TD222222 Запрос:

4


cmd cardinfo Код команды.





cardphone 380671111111 Номер телефона карточки.

cardnumber 111111 Номер/код карточки.

cardemail [email protected] Email карточки.

Пример: <root> <cmd>cardinfo</cmd> <serial>42229713F5F956A47D6C845DB74B6891</serial> <appversion>1.09.2</appversion> <phone>380501111111</phone> <password>0000</password> <cardphone>380671111111</cardphone> </root> или <root> <cmd>cardinfo</cmd> <serial>42229713F5F956A47D6C845DB74B6891</serial> <appversion>1.09.2</appversion> <phone>380501111111</phone> <password>0000</password> <cardnumber>111111</ cardnumber > </root> или <root> <cmd>cardinfo</cmd> <serial>42229713F5F956A47D6C845DB74B6891</serial> <appversion>1.09.2</appversion> <phone>380501111111</phone> <password>0000</password> <cardemail>[email protected]</ cardemail > </root> Ответ:


cmd cardinfo Код команды.




cardamountspent 180.00 Сумма покупок по карте.

cardbonuses 340.50 Баланс бонусов на карточке.

cardrate 10 Базовая процентная ставка бонусов или скидки в процентах.

message

При сумме покупок 300 грн. ваша бонусная ставка будет увеличена до 20%!

Сообщение владельцу карты.

Пример: <root> <cmd>cardinfo</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <cardphone>380671111111</cardphone> <cardamountspent>180.00</cardamountspent>

5

<cardbonuses>340.50</cardbonuses> <cardrate>10</cardrate> <message>При сумме покупок 300 грн. ваша бонусная ставка будет увеличена до 20%!</message> </root>

6. Отправить покупателю СМС с одноразовым паролем на трату бонусов

Для тестовых номеров смс не отправляется, используется пароль «0000»: 380671111111 380672222222 Запрос:


cmd sendsmscardotppassword Код команды.






Пример: <root> <cmd>sendsmscardotppassword</cmd> <serial>42229713F5F956A47D6C845DB74B6891</serial> <appversion>1.09.2</appversion> <phone>380501111111</phone> <password>0000</password> <cardphone>380671111111</cardphone> </root> Ответ:


cmd sendsmscardotppassword Код команды.



message

СМС с одноразовым паролем на трату бонусов отправлен на телефон клиента +380671111111


Пример: <root> <cmd>sendsmsterminalpassword</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <message>СМС с одноразовым паролем на трату бонусов отправлен на телефон клиента +380671111111</message> </root>

7. Продажа

Запрос:


cmd transaction Код команды.

6



cardotppassword 0000

Одноразовый пароль клиента на трату бонусов. Пусто для терминалов, у кооторых проверка паролем не требуется.

amount 25.50 Сумма продажи

bonusesredeemed 15.50 Сумма оплаты бонусами

bonusesearned 0.00 Сумма начисленных бонусов. Если 0, то система сама сумму.

comment Kasa refno 764523 Комментарий к операции

stock ... Список товаров в продаже, если продажа без передачи списка товаров, данное поле можно исключить.

onlineflag 1 Операция происходит в режиме: 1 - онлайн или 0- оффлайн

skipsms 0 Отправлять ли информационное СМС покупателю: 0 - отправлять, 1 - не отправлять

Пример: <root> <cmd>transaction</cmd> <serial>42229713F5F956A47D6C845DB74B6891</serial> <appversion>1.09.2</appversion> <phone>380501111111</phone> <password>0000</password> <cardphone>380671111111</cardphone> <cardotppassword>0000</cardotppassword> <amount>25.50</amount> <bonusesredeemed>15.50</bonusesredeemed> <bonusesearned>0.00</bonusesearned> <comment> Kasa refno 764523</comment> <skipsms>0</skipsms> </root> Ответ:


cmd transaction Код команды.



transactionid 234 Номер транзакции.

transactiondate 2015-02-01 10:20:50 Дата транзакции





amounttopay 10.00 Сумма к оплате наличными

bonusesearned 1.00 Сумма заработанных бонусов

message

Поздравляем, это была ваша 100 покупка! Дарим вам купон на 40 грн. Код купона: 045623. Действителен до 30.10.2015.


Пример: <root> <cmd>transaction</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <transactionid>234</transactionid> <transactiondate>2015-02-01T10:20:50</transactiondate> <cardphone>380671111111</cardphone> <cardbonuses>325.00</cardbonuses>

7

<amount>25.50</amount> <bonusesredeemed>15.50</bonusesredeemed> <amounttopay>10.00</amounttopay> <bonusesearned>1.00</bonusesearned> <message>Поздравляем, это была ваша 100 покупка! Дарим вам купон на 40 грн. Код купона: 045623. Действителен до 30.10.2015.</message> </root> Передача списка товаров в продаже Список товаров передается в поле stock.


item

id 1 Идентификатор товарной позиции.

quantity 2 Количество

price 15.80 Цена

amount 0000 Сумма по товару

Пример: <root> <cmd>transaction</cmd> <serial>-</serial> <appversion>webapp</appversion> <phone>380671111111</phone> <password>0000</password> <cardphone>380671111111</cardphone> <cardotppassword /> <amount>600</amount> <bonusesredeemed>0</bonusesredeemed> <comment> </comment> <stock> <item> <id>1</id> <quantity>2</quantity> <price>15</price> <amount>30</amount> </item> <item> <id>2</id> <quantity>1</quantity> <price>34</price> <amount>34</amount> </item> </stock> <onlineflag>1</onlineflag> </root>

8. Отмена продажи

Если продажа уже была отменена, то вернётся заполненная информация об отмене. Запрос:


cmd transactioncancel Код команды.






transactionid 234 Номер транзакции, которую необходимо

8

отменить.

Пример: <root> <cmd>transactioncancel</cmd> <serial>42229713F5F956A47D6C845DB74B6891</serial> <appversion>1.09.2</appversion> <phone>380501111111</phone> <password>0000</password> <cardphone>380671111111</cardphone> <transactionid>234</transactionid> </root> Ответ:


cmd transactioncancel Код команды.



transactionid 235 Номер транзакции отмены.




amount -25.50 Сумма продажи к отмене

bonusesredeemed -15.50 Сумма оплаты бонусами к отмене

amounttopay -10.00 Сумма к оплате наличными к отмене

bonusesearned -1.00 Сумма заработанных бонусов к отмене

message Сообщение владельцу карты.

Пример: <root> <cmd>transactioncancel</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <transactionid>235</transactionid> <transactiondate>2015-02-01T10:20:50</transactiondate> <cardphone>380671111111</cardphone> <cardbonuses>340.50</cardbonuses> <amount>-25.50</amount> <bonusesredeemed>-15.50</bonusesredeemed> <amounttopay>-10.00</amounttopay> <bonusesearned>-1.00</bonusesearned> <message></message> </root>

9. Итоговый отчёт и список операций на терминале

Итоги и список операций за текущее число. Запрос:


cmd transactionslistterminal Код команды.





datefrom 2015-06-12 00:00:00 Дата с

dateto 2015-06-12 23:59:59.999 Дата по

Пример: <root> <cmd>transactionslistterminal</cmd> <serial>42229713F5F956A47D6C845DB74B6891</serial> <appversion>1.09.2</appversion>

9

<phone>380501111111</phone> <password>0000</password> <datefrom>2015-06-12 00:00:00</datefrom> <dateto>2015-06-12 23:59:59.999</dateto> </root> Ответ:


cmd transactionslistterminal Код команды.



total

qty 8 Кол-во операций

amount 430.00 Итого продажи

bonusesredeemed -2.00 Итого оплаты бонусами или скидка

amounttopay 428.00 Итого к оплате наличными

bonusesearned 45.60 Итого заработанных бонусов

transactions



cardphone ***1111 Номер телефона карточки


bonusesredeemed -15.50 Сумма оплаты бонусами или скидка

amounttopay 10.00 Сумма к оплате наличными


Пример: <root> <cmd>transactionslistterminal</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <total> <qty>10</qty> <amount>430.00</amount> <bonusesredeemed>-2.00</bonusesredeemed> <amounttopay>428.00</amounttopay> <bonusesearned>45.60</bonusesearned> </total> <transactions> <transaction> <transactionid>1619</transactionid> <transactiondate>2015-06-10 10:08:33</transactiondate> <cardphone>***1111</cardphone> <amount>-33.00</amount> <bonusesredeemed>3.67</bonusesredeemed> <amounttopay>-29.33</amounttopay> <bonusesearned>-5.87</bonusesearned> <transactioncancelid>1618</transactioncancelid> </transaction> <transaction> <transactionid>1618</transactionid> <transactiondate>2015-06-10 10:07:24</transactiondate> <cardphone>***1111</cardphone> <amount>33.00</amount> <bonusesredeemed>-3.67</bonusesredeemed> <amounttopay>29.33</amounttopay> <bonusesearned>5.87</bonusesearned> <transactioncancelid>1619</transactioncancelid> </transaction> </transactions> </root>

10

10. Запрос списка товарных позиций

Возвращает список товарных позиций. Запрос:


cmd stocklistterminal Код команды.





Password 0000 Пароль терминала.

Пример: <root> <cmd>stocklistterminal</cmd> <serial>42229713F5F956A47D6C845DB74B6891</serial> <appversion>1.09.2</appversion> <language>Ru-ru</language> <phone>380501111111</phone> <password>0000</password> </root> Ответ:


cmd stocklistterminal Код команды.



stock


title Кофе американо Наименование товарной позиции

externalcode Кофе американо Код позиции в учетной системе клиента

ratetype Кофе американо Тип скидки: - D - скидка - B - начисление бонуса

valuetype Кофе американо Тип значения: - P - процент от стоимости - A - абсолютное значение

value Кофе американо Значение скидки или бонуса

Пример: <root> <cmd>stocklistterminal</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <stock> <item> <id>111</id> <title>Кофе американо</title> <externalcode>1236-76</externalcode> <ratetype>D</ratetype> <valuetype>P</valuetype> <value>10.00</value> </item> <item> <id>222</id> <title>Кофе лате</title> <externalcode>33876-14</externalcode> <ratetype>B</ratetype>

11

<valuetype>A</valuetype> <value>5.00</value> </item> </stock> </root>

11. Привязка дополнительных кодов к карте

Привязка к номеру телефона\карточки дополнительных номеров карт. Запрос:


cmd addcardnumber Код команды.






cardnumber 111111 Номер/код карточки, который необходимо добавить.

confirmedphone 0

Признак того, что телефон подтвержден. 0 - телефон не подтвержден, возможно только лишь начисление бонусов 1 - телефон подтвержден и с карточки можно списывать бонусы По умолчанию (и в случае, если параметр пустой или отсутствует) устанавливается в 1 - подтвержден.

Пример: <root> <cmd>addcardnumber</cmd> <phone>380501111111</phone> <password>0000</password> <cardphone>380501111111</cardphone> <cardnumber>T501111111</cardnumber> <confirmedphone>0</confirmedphone> </root> Ответ:


cmd addcardnumber Код команды.


statusdesc Операция успешна... Описание статуса или текст ошибки.

Пример: <root> <cmd>addcardnumber</cmd> <status>0000</status> <statusdesc>Операция успешна...</statusdesc> </root>

12. Запрос списка клиентских счетов

По номеру телефона\карточки получает информацию с сервера о клиентских счетах и остатках на них. Запрос:


cmd cardspecialaccounts Код команды.

12



phone 380501111111 Номер телефона на который установлен терминал

password 0000 Пароль терминала

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

cardnumber 111111 Номер/код карточки

Пример: <root> <cmd> cardspecialaccounts </cmd> <phone>380501111111</phone> <password>0000</password> <cardphone>380501111111</cardphone> </root> или <root> <cmd> cardspecialaccounts </cmd> <phone>380501111111</phone> <password>0000</password> <cardnumber>T501111111</cardnumber> </root> Ответ:


cmd cardspecialaccounts Код команды.


statusdesc Ok Описание статуса или текст ошибки

account

id 111AAA Идентификатор клиентского счета

baseid 111-000 Идентификатор базового счета

title Бензин АИ98 Наименование счета

amount 100.35 Остаток на счету

Пример: <root> <cmd> cardspecialaccounts </cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <accounts> <account> <id>111AAA</id> <baseid>111-000</baseid> <title> Бензин АИ98</title> <amount>100.35</amount> </account> <account> <id>222BBB</id> <baseid>222-000</baseid> <title> Бензин АИ95</title> <amount>50.00</amount> </account> </accounts> </root>

13. Начисление на клиентский счет

Начисление на клиентский счет.

13

Запрос:


cmd specialaccountrefill Код команды







accountid 111AAA Идентификатор клиентского счета

amount 30.00 Сумма пополнения

Пример: <root> <cmd>specialaccountrefill</cmd> <phone>380501111111</phone> <password>0000</password> <cardphone>380501111111</cardphone> <accountid>111AAA</accountid> <amount>30.00</amount> </root> или <root> <cmd>specialaccountrefill</cmd> <phone>380501111111</phone> <password>0000</password> <cardnumber>T501111111</cardnumber> <accountid>111AAA</accountid> <amount>30.00</amount> </root> Ответ:


cmd specialaccountrefill Код команды.



transactionid 111-222-56789 Идентификатор транзакции

Пример: <root> <cmd>specialaccountrefill</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <transactionid>111-222-56789</transactionid> </root>

14. Резервирование по клиентскому счету

Резервирование средств на клиентском счету. Все не подтвержденные резервы автоматически аннулируются по прошествию 24 часов. Запрос:


cmd specialaccountreserv Код команды

14





amount 30.00 Сумма пополнения

Пример: <root> <cmd>specialaccountreserv</cmd> <phone>380501111111</phone> <password>0000</password> <cardphone>380501111111</cardphone> <accountid>111AAA</accountid> <amount>30.00</amount> </root> или <root> <cmd>specialaccountreserv</cmd> <phone>380501111111</phone> <password>0000</password> <cardnumber>T501111111</cardnumber> <accountid>111AAA</accountid> <amount>30.00</amount> </root> Ответ:


cmd specialaccountreserv Код команды.




Пример: <root> <cmd>specialaccountreserv</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <transactionid>111-222-56789</transactionid> </root>

15. Списание с клиентского счета

Списание средств на клиентском счету. Запрос:


cmd specialaccountredeem Код команды







cardotppassword 0000

Одноразовый пароль клиента на списание (пусто для терминалов, у кооторых проверка паролем не требуется)

15

amount 30.00 Сумма списания

reservid 111-222-56789 Идентификатор резерва (пусто, если списание без предварительного резервирования)

Пример: <root> <cmd>specialaccountredeem</cmd> <phone>380501111111</phone> <password>0000</password> <cardphone>380501111111</cardphone> <cardotppassword>0000</cardotppassword> <accountid>111AAA</accountid> <amount>30.00</amount> </root> или <root> <cmd>specialaccountredeem</cmd> <phone>380501111111</phone> <password>0000</password> <cardnumber>T501111111</cardnumber> <accountid>111AAA</accountid> <amount>30.00</amount> <reservid>111-222-56789</reservid> </root> Ответ:


cmd specialaccountredeem Код команды.




Пример: <root> <cmd>specialaccountredeem</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <transactionid>111-222-56789</transactionid> </root>

16. Отмена операции с клиентским счетом

Отмена операций начисления, резервирования и списания средств с клиентского счета. Запрос:


cmd specialaccountcancel Код команды






Пример: <root> <cmd>specialaccountcancel</cmd> <phone>380501111111</phone> <password>0000</password>

16

<transactionid>111-222-56789</transactionid> </root> Ответ:


cmd specialaccountcancel Код команды.



Пример: <root> <cmd>specialaccountcancel</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> </root>

17. Запрос номера карты заказа

Запрос карты заказа с сервера. Тестовые номера: 380671111111 380672222222 Запрос:


cmd cardtemporarycode Код команды.







redeembonuses 1 Тип карты заказа: 0 - только начисление, 1 - начисление и списание.

Пример: <root> <cmd>cardtemporarycode</cmd> <phone>380501111111</phone> <password>0000</password> <cardphone>380501111111</cardphone> <redeembonuses>0</redeembonuses> </root> или <root> <cmd>cardtemporarycode</cmd> <phone>380501111111</phone> <password>0000</password> <cardnumber>111111</cardnumber> <redeembonuses>0</redeembonuses> </root> Ответ:


cmd cardtemporarycode Код команды.



temporarycode 294-849 Номер телефона карточки.

redeembonuses 1 Тип карты заказа: 0 - только начисление, 1 - начисление и списание.

17

message

На гостя был отправлен код карты заказа в виде СМС. Данный код позволяет не только начислить, но и списать боусы. Попросите гостя продиктовать код.

Сообщение.

Пример: <root> <cmd>cardtemporarycode</cmd> <status>0000</status> <statusdesc>Операция успешна...</statusdesc> <temporarycode>294-849</temporarycode> <redeembonuses>0</redeembonuses> <cardbonuses>24087.37</cardbonuses> <message /> </root> или <root> <cmd>cardtemporarycode</cmd> <status>0000</status> <statusdesc>Операция успешна...</statusdesc> <temporarycode /> <redeembonuses>1</redeembonuses> <cardbonuses>24087.37</cardbonuses> <message>На гостя был отправлен код карты заказа в виде СМС. Данный код позволяет не только начислить, но и списать боусы. Попросите гостя продиктовать код.</message> </root>

18. Запрос информации о покупателе с Дисплея

Запрос информации о покупателе с Дисплея. Запрос:


cmd displaycardinfo Код команды.





Пример: <root> <cmd>displaycardinfo</cmd> <serial>42229713F5F956A47D6C845DB74B6891</serial> <appversion>1.09.2</appversion> <phone>380501111111</phone> <password>0000</password> </root> Ответ:


cmd displaycardinfo Код команды.

status 0000 Код статуса. 0000 – успешно, 0001 - на Дисплее не введены данные о покупателе.



cardotppassword 0000 Одноразовый пароль клиента на трату бонусов.

cardamountspent 180.00 Сумма покупок по карте.

18


cardrate 10 Базовая процентная ставка бонусов или скидки в процентах.

message

При сумме покупок 300 грн. ваша бонусная ставка будет увеличена до 20%!


Пример: <root> <cmd>displaycardinfo</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <cardphone>380671111111</cardphone> <cardotppassword>0000</cardotppassword> <cardamountspent>180.00</cardamountspent> <cardbonuses>340.50</cardbonuses> <cardrate>10</cardrate> <message>При сумме покупок 300 грн. ваша бонусная ставка будет увеличена до 20%!</message> </root>

19. Передача на Дисплей информации о чеке

Передача с терминала на Дисплей информации о чеке: итоговая стоимость, сумма к оплате, последний введенный товар. Запрос:


cmd displaytransaction Код команды.








bonusesearned 0.00 Сумма начисленных бонусов. Если 0, то система сама сумму.

comment Kasa refno 764523 Комментарий к операции

stock ... Последний введенный товар, если продажа без товаров или завершение продажи, данное поле можно исключить.

Товар передается в поле stock.


item


quantity 2 Количество

price 15.80 Цена

amount 0000 Сумма по товару

Пример: <root> <cmd>displaytransaction</cmd> <phone>380671111111</phone> <password>0000</password> <cardphone>380671111111</cardphone> <amount>600</amount> <bonusesredeemed>0</bonusesredeemed> <comment> </comment> <stock>

19

<item> <id>1</id> <quantity>2</quantity> <price>15</price> <amount>30</amount> </item> </stock> </root> Ответ:


cmd displaytransaction Код команды.



Пример: <root> <cmd>displaytransaction</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> </root>

20. Получение последнего сгенерированного номера карты

Запрос терминалом последнего сгенерированного номера карты с сервера. Запрос:


cmd getlastcardtemporarycode Код команды.





timedelta 5 Время, за которое производится поиск номера карты (минуты)

Пример: <root> <cmd>getlastcardtemporarycode</cmd> <phone>380501111111</phone> <password>0000</password> <timedelta>5</timedelta> </root> Ответ:


cmd getlastcardtemporarycode Код команды.




temporarycode 765809 Код карточки.

redeembonuses 1 Тип карты: 0 - только начисление, 1 - начисление и списание.

message Сообщение.

Пример: <root> <cmd>getlastcardtemporarycode</cmd> <status>0000</status> <statusdesc>Операция успешна...</statusdesc> <cardphone>380501111111</cardphone> <temporarycode>765809</temporarycode>

20

<redeembonuses>1</redeembonuses> <message /> </root>

21. Отправить покупателю СМС с чеком

Отправка покупателю по СМС текста с данными о его операции. Планируется в следующих версиях.

22. Отправить клиенту СМС с паролем

СМС пока не отправляется. Запрос:


cmd sendsmscardpassword Код команды.




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

Пример: <root> <cmd>sendsmscardpassword</cmd> <serial>42229713F5F956A47D6C845DB74B6891</serial> <appversion>1.09.2</appversion> <language>Ru-ru</language> <phone>380671111111</phone> </root> Ответ:


cmd sendsmscardpassword Код команды.



message СМС с паролем отправлено на телефон +380671111111


Пример: <root> <cmd>sendsmscardpassword</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <message>СМС с паролем отправлено на телефон +380671111111</message> </root>

23. Логин на карте

Запрос:


cmd logincard Код команды.

serial 42229713F... Уникальный идентификатор телефона



googlemessagesregid

APA91bHUdb... Идентификатор клиента для google сообщений

phone 380671111111 Номер телефона карты клиента.

password 0000 Пароль.

21

Пример: <root> <cmd>logincard</cmd> <serial>42229713F5F956A47D6C845DB74B6891</serial> <appversion>1.09.2</appversion> <language>Ru-ru</language> <googlemessagesregid> APA91bHUdbIH6D55y9F6Z6yARmS07b3iusNV7w6gFEm10cnn0Mi2L6jmHPIY1ngr7cOH7PqeEU9cYUJWiAQx8USthGDnk8Hfhug0RkgwPC9qXt9-GEFLqtmxcZWYCP2q4H80OrCORGfPywjJK4sys2u54ScHjy9nwQ</googlemessagesregid> <phone>380671111111</phone> <password>0000</password> </root> Ответ:


cmd logincard Код команды.



phone 380671111111 Номер телефона карточки.

bonuses 120.50 Баланс бонусов на карточке.

amountspent 3250.70 Сумма покупок по карте.

amountsaved 570.00 Сумма экономии (бонусов, скидок).

Пример: <root> <cmd>logincard</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <phone>380671111111</cardphone> <bonuses>120.50</cardbonuses> <amountspent>3250.70</amountspent> <amountsaved>570.00</amountsaved> </root>

24. Итоги по карте

Запрос:


cmd totalscard Код команды.



phone 380671111111 Номер телефона карты клиента.


Пример: <root> <cmd>totalscard</cmd> <serial>42229713F5F956A47D6C845DB74B6891</serial> <appversion>1.09.2</appversion> <phone>380671111111</phone> <password>0000</password> </root> Ответ:





message ... HTML кдированное сообщение для показа на экране клиента

22

Пример: <root> <cmd>totalscard</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <message> <html> <body> <img src=http://incust.com/ua/img/logo.png> <a href=http://incust.com>www.incust.com</a> Ваши бонусы Кофейня на колёсах: 200.00 грн. Lucky Pizza: 120.00 грн. </body> </html> </message> </root> В следующих версиях будет также сделан ответ в xml формате. Ответ:





merchantgroupname Кофейня на Колёсах Название торговой группы

rate 10 Процентная ставка бонусов или скидки в процентах

bonuses 120.50 Баланс бонусов на карточке.

amountspent 1200.70 Сумма покупок по карте.

amountsaved 570.00 Сумма экономии (бонусов, скидок).

Пример: <root> <cmd>totalscard</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <merchantgroups> <merchantgroup> <merchantgroupname>Кофе на колёсах</transactionid> <rate>20</rate> <bonuses>120.50</bonuses> <amountspent>1200.70</amountspent> <amountsaved>570.70</amountsaved> </merchantgroup> <merchantgroup> <merchantgroupname>Lucky Pizza</transactionid> <rate>40</rate> <bonuses>0</bonuses> <amountspent>2400.70</amountspent> <amountsaved>960.00</amountsaved> </merchantgroup> </root>

25. Список операций на карте

Запрос:


cmd transactionslistcard Код команды.

23


Пример: <root> <cmd>transactionslistcard</cmd> <serial>42229713F5F956A47D6C845DB74B6891</serial> <appversion>1.09.2</appversion> <phone>380671111111</phone> <password>0000</password> </root> Ответ:






Пример: <root> <cmd>transactionslistcard</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <message> <html> <body> <img src=http://incust.com/ua/img/logo.png> <a href=http://incust.com>www.incust.com</a> История покупок 2015-04-01 15:34:40 Кофейня на колёсах: 10.00 грн. 2015-04-02 13:10:20 Lucky Pizza: 5.00 грн. </body> </html> </message> </root> В следующих версиях будет также сделан ответ в xml формате.







merchantname Кофейня на Колёсах Название торговой сети.


bonusesredeemed 15.50 Сумма оплаты бонусами или скидка


торговец сумма оплата.б скидка/бонусы к оплате экономия % Колёса 100.00 10.00 9.00 90.00 10% Pizza 400.00 80.00 320.00 40% Пример: <root> <cmd>transactionslistcard</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <transactions> <transaction> <transactionid>2</transactionid> <transactiondate>2015-02-01T10:20:50</transactiondate>

24

<cardphone>***1111</cardphone> <amount>-100.00</amount> <bonusesredeemed>-10.00</bonusesredeemed> <bonusesearned>-18.00</bonusesearned> </transaction> <transaction> <transactionid>1</transactionid> <transactiondate>2015-02-01T10:20:50</transactiondate> <cardphone>***1111</cardphone> <amount>100.00</amount> <bonusesredeemed>10.00</bonusesredeemed> <bonusesearned>18.00</bonusesearned> </transaction> </transactions> </root>

26. Список торговых точек

Запрос:


cmd merchantslist Код команды.





Пример: <root> <cmd>merchantslist</cmd> <serial>42229713F5F956A47D6C845DB74B6891</serial> <appversion>1.09.2</appversion> <phone>380671111111</phone> <password>0000</password> </root> Ответ:


cmd merchantslist Код команды.




Пример: <root> <cmd>merchantslist</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <message> <html> <body> <img src=http://incust.com/ua/img/logo.png> <a href=http://incust.com>www.incust.com</a> Торговые точки Кофейня на колёсах, Киев Lucky Pizza, Киев </body> </html> </message> </root>

25

27. Связаться с нами

Запрос:


cmd contactus Код команды.



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

password 0000 Пароль

message Перезвоните мне... Сообщение

Пример: <root> <cmd>contactus</cmd> <serial>42229713F5F956A47D6C845DB74B6891</serial> <appversion>1.09.2</appversion> <phone>380671111111</phone> <password>0000</password> <message>Перезвоните мне</message> </root> Ответ:


cmd contactus Код команды.



message Сообщение доставлено Сообщение владельцу карты.

Пример: <root> <cmd>contactus</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <message>Сообщение доставлено</message> </root>

28. Профиль клиента

Запрос:


cmd accountinfo Код команды.





Пример: <root> <cmd>accountinfo</cmd> <serial>42229713F5F956A47D6C845DB74B6891</serial> <appversion>1.09.2</appversion> <phone>380671111111</phone> <password>0000</password> </root> Ответ:


cmd accountinfo Код команды.

26

Пример: <root> <cmd>accountinfo</cmd> <status>0000</status> <statusdesc>Ok</statusdesc> <message> <html> <body> <img src=http://incust.com/ua/img/logo.png> <a href=http://incust.com>www.incust.com</a> Мой профиль Планируется в следующей версии... </body> </html> </message> </root>

29. Изменить профиль клиента

Планируется в следующих версиях. accountupdate

incust Команды api · 3 4. Логин на терминале Для тестовых...

Documents