Iiko (Айко) 9.x

Инструкция для плагина PayKeeperSBP в IIKO

Требования.

• Версия IIKOх.

Коротко о возможностях.

• Приём полной или частичной оплаты несколькими способами: QR-код с выводом на экран Покупателя, QR-код в пречеке, Активная метка, mPOS-терминал, отправка счёта на Email.
• Передача данных корзины в соответствии с требованиями 54-ФЗ.
• Инициирование возврата.
• Автоматическое добавление оплаты в заказ.
• Поддержка автоматического удаления предоплаченных платежей с указанием исключений для платёжных систем.
• Возможность настраивать расположение, размер и заголовок QR-кода.

Особенности.

• Перед использованием боевых настроек оплаты необходимо в обязательном порядке проверить все возможные сценарии оплаты на тестовом режиме личного кабинета PayKeeper для проверки верной настройки плагина.

План инструкции.

1. Сценарий работы платёжного плагина PayKeeper.
2. Установка плагина PayKeeper.
3. Настройка плагина PayKeeper и ЛК PayKeeper.
4. Добавление внешней оплаты в iikoOffice.
5. Работа с плагином PayKeeper.

1. Сценарии работы платёжного плагина PayKeeper.

1.1. Оплата при типе обслуживания БАНКЕТ, РЕЗЕРВ (в зале).

1.1.1. Посетитель сообщает о желании оплатить заказ.

1.1.2. Официант предоставляет Посетителю QR-код для сканирования несколькими способами: напечатанный в iikoFront пречек, экран Покупателя, Активная метка. Либо принимает оплату через mPOS­-терминал.

1.1.3. Посетитель сканирует QR-код, подносит телефон к Активной метке или к mPOS-терминалу и производит оплату. Для возможности бесконтактной оплаты у Покупателя должно иметься платёжное устройство с технологией NFC: телефон с привязанной картой через приложение Mir pay или подобные, стикер с чипом NFC и привязанной картой.

1.1.3. Посетитель сканирует QR-код или подносит к Активной метке (mPOS-терминалу) платёжное устройство (смартфон, NFC-стикер, бесконтактную банковскую карту) и производит оплату.

• Смартфон с настроенным платёжным сервисом (Mir Pay и прочие или приложение банка с функцией бесконтактной оплаты). В сервисе должна быть добавлена банковская карта.
• Банковская карта с чипом NFC (бесконтактная карта).
• NFC-стикер (платёжная наклейка), к которому заранее привязана банковская карта через приложение банка-эмитента.

1.1.4. В iikoFront автоматически добавляется оплата в заказ. В зависимости от настроек заказ закрывается автоматически или Оператором.

1.2. Оплата при типе обслуживания ДОСТАВКА (самовывоз, курьер).

1.2.1. Продавец создаёт заказ от Покупателя в iikoFront. При постоплате начинает готовить.

1.2.2. Оператор терминала (Курьер) предоставляет Покупателю QR-код для сканирования несколькими способами: QR-код на экране смарт-кассы, QR-код в накладной, Активная метка. Либо принимает оплату через mPOS­-терминал.

1.2.3. Покупатель сканирует QR-код, подносит телефон к Активной метке или к mPOS-терминалу и производит оплату.

1.2.4. В iikoFront автоматически добавляется оплата в заказ. В зависимости от настроек заказ закрывается автоматически или Оператором.

2. Установка плагина PayKeeper.

2.1. Скачайте актуальную версию плагина в базе знаний.

2.2. Распакуйте содержимое архива. При распаковке должна появится папка «Resto.Front.Api.PayKeeperSbp.V9Preview4».

2.3. Папку «Resto.Front.Api.PayKeeperSbp.V9Preview4» перенесите в папку плагинов iikoFront. Для Windows это папка по пути «C:\Program Files\iiko\iikoRMS\Front.Net\Plugins\». При этом необходимо убедиться, что в папке плагинов не имеется других папок от PayKeeper, чтобы не было конфликта.

3. Настройка плагина PayKeeper и ЛК PayKeeper.

3.1. Перейдите в папку плагина «Resto.Front.Plugin. PayKeeperSbp.V9Preview4» и откройте файл «Resto.Front.Api.PayKeeperSbp.dll.config» в текстовом редакторе.

3.2. Найдите тег «userSettings», внутри которого в каждом теге «setting» с именем «name» укажите свое значение в теге «value» по описанию и примерам.

Параметры для настройки PayKeeper:

PAYKEEPER_LK_URL. Обязательный параметр. Ссылка на личный кабинет PayKeeper, которую вам выдали при подключении. Пример: https://mysite.server.paykeeper.ru. У вас будет своя ссылка.
PAYKEEPER_LK_USER. Обязательный параметр. Имя пользователя с правами админа из личного кабинета PayKeeper (раздел НАСТРОЙКИ, подраздел ДОСТУП В ЛИЧНЫЙ КАБИНЕТ). Пример: admin.
PAYKEEPER_LK_PASS. Обязательный параметр. Пароль указанного выше пользователя с правами админа из личного кабинета PayKeeper.
psType. Обязательный параметр. Данный параметр заполняется только в том случае, если необходимо принимать платежи по СБП. Необходимо указывать только типы платёжных систем по СБП, например, sbp_default.
transferCart. Включает (True) или отключает (False) передачу корзины. Если необходимо, чтобы в PayKeeper передавались позиции заказа, укажите True. По умолчанию True.

Параметры для настройки iikoFront:

iikoUserPin. Обязательный параметр. Пин-код для входа в iikoFront. Пример: 1111. Требуется для выполнения внутренних операций. Если его указать неверно, плагин не будет работать должным образом.

Параметры для настройки режимов работы (можно включить только один из них):

qrPrintInPrecheck. Включает (True) или отключает (False) печать QR-кода в пречеке (накладной). Если включено, то при событии печати пречека (накладной) в нём будет печататься QR-код. Система запустит ожидание оплаты. Нельзя включать совместно с activeTag, qrOnCustomerScreen и showPluginButton. По умолчанию False.
activeTag. Включает (True) или отключает (False) оплату по активной метке. Если включено, то в процессе оплаты будет активирована метка. Система запустит ожидание оплаты. Нельзя включать совместно с qrPrintInPrecheck, qrOnCustomerScreen и showPluginButton. По умолчанию False.
qrOnCustomerScreen. Включает (True) или отключает (False) показ QR-кода на экране Покупателя. Если включено, то в процессе оплаты будет показан QR-код на экране Покупателя. Нельзя включать совместно с qrPrintInPrecheck, activeTag и showPluginButton. По умолчанию True.
showPluginButton. Включает (True) или отключает (False) показ кнопки плагина на экране редактирования заказа или оплаты. Если включено, то кнопка плагина будет показана. Кнопка плагина имеет опцию отправки счёта на оплату по Email. Нельзя включать совместно с qrOnCustomerScreen, qrPrintInPrecheck и activeTag По умолчанию False.

Параметры для настройки режима qrPrintInPrecheck:

requestsTimeOut. Время периодичности запросов в секундах. С данной периодичностью происходит проверка состояния заказов. По умолчанию 30.
removePrepays. Управляет удалением существующих платежей перед добавлением нового. Работает только для опции qrPrintInPrecheck. Если указано True, система удаляет все платежи, не относящиеся к принудительным типам, и добавляет новый платёж. Если False, система либо изменяет сумму существующего платежа, либо добавляет новый, не удаляя старые. Это обеспечивает гибкость в обработке платежей и интеграции с PayKeeper. По умолчанию True.
transportApiKey.  Необязательный параметр. API-ключ для интеграции IIkoCloud. Нужен для опции closeDeliveryOrder. Получите API-ключ по инструкции https://ru.iiko.help/articles/#!api-documentations/connect-to-iiko-cloud.
transportOrganisationId.  Необязательный параметр. Идентификатор организации в iikoCloud. Нужен для опции closeDeliveryOrder. Пример: f718ea7f-8e0d-4adb-2fee-f6dc44d15150
closeDeliveryOrder. Управляет автоматическим закрытием заказов на доставку через интеграцию с внешним API в iikoCloud. Работает только для опции qrPrintInPrecheck. Если параметр включен (True), система инициализирует клиент API и отправляет запросы на закрытие заказов после оплаты. Если параметр отключен (False), эта функциональность не используется. Это обеспечивает гибкость в управлении заказами на доставку и интеграции с транспортными службами. По умолчанию False.
paidOrder. Управляет автоматическим проведением сохранённой оплаты в заказе. Работает только для опции qrPrintInPrecheck. При значении True делает заказ оплаченным и закрывает заказ при полном покрытии стоимости заказа суммой оплаты. Не работает для типа обслуживания БАНКЕТ. Если указано False, то при автоматическом сохранении оплаты в заказе просто всплывает уведомление об этом. По умолчанию True.
handleAllOrdersTypes. Генерировать QR-код для всех типов заказов. Работает только для опции qrPrintInPrecheck. Если указать False, то QR-код будет генерироваться только для типов доставки. Допустимые значения: True, False. По умолчанию: False.
forcedPaymentsTypesIds. Необязательный параметр. Список идентификаторов типов способов оплат, которые должны быть исключены из обработки (например, принудительные или системные способы оплаты). Работает только для опции qrPrintInPrecheck. При указании идентификаторов таких способов оплат, они не учитываются при обработке заказа. По умолчанию указано одно значение: 00000000-0000-0000-0000-000000000000. Чтобы вставить второе, нужно после закрывающего тега </string> вставить еще одно значение <string>здесь идентификатор</string>.

Параметры для настройки режима activeTag:

activeTagCheckIntervalequests. Интервал запросов статуса платежа при оплате Активной меткой в секундах. Пример: 3. По умолчанию 3.
activeTagShowPaymentResult. Включает (True) или отключает (False) показ результата успешной оплаты при оплате Активной меткой. Если включено, то при оплате Активной меткой будет дополнительно всплывать окно с информацией об успешной оплате. По умолчанию False.
qrcId. Идентификатор QR-кода. Работает только для опции ActiveTag. Укажите ID QR-кода на Активной метке. Например, AS10004V2H2HFH8B8H7RAVJ17PSTS1L1. По умолчанию AS10004V2H2HFH8B8H7RAVJ17PSTS1L1.

Параметры для настройки режима qrOnCustomerScreen:

printOnReceiptPrinter. Включает (True) или отключает (False) печать QR-кода на отдельном квиточке при способе оплаты с показом QR-кода на экране Покупателя. Работает только для опции qrOnCustomerScreen. По умолчанию False.
printOnPrecheque. Включает (True) или отключает (False) печать QR-кода на отдельном квиточке. Работает только для опции qrOnCustomerScreen. По умолчанию False.
qrDisplayType. Тип экрана, на котором следует отображать QR-код. Работает только для опции qrOnCustomerScreen. 0 – отключено, 1 – Telemetron, 2 – CustomerScreenWeb, 3 – Mertech, 4 – R-Call. По умолчанию 0.
qrDisplayCom. COM порт, к которому подключен дисплей. Например, COM6. По умолчанию пусто.
customerQrType. Тип системы оплаты. Работает только для опции qrOnCustomerScreen. В теме экрана Покупателя должен быть добавлен элемент, соответствующий способу оплаты. Необходимо убедиться в том, что они соответствуют друг другу, иначе QR-код не отобразится. По умолчанию SampleQR. В большинстве случаев менять не нужно.
customerQrUrl. Локальный адрес и порт веб-сервера, запускаемый на iikoFront и обслуживающий страницу с QR-кодом для оплаты. Работает только для опции qrOnCustomerScreen. По умолчанию http://localhost:9150. В большинстве случаев менять не нужно.
qrTimeout. Таймаут ожидания оплаты по QR-коду. Работает только для опции qrOnCustomerScreen. Указывается время в формате «чч:мм:сс», за которое Покупатель должен успеть отсканировать QR-код и оплатить. По умолчанию 00:03:00.
hideAdvertise. Скрытие промо материалов. Скрывает (True) или показывает (False) промо материалы из IIKO. По умолчанию True.

Параметры для настройки оформления (отображения) QR-кода:

qrTextBefore. Текст до QR-кода. По умолчанию «Оплата по QR-коду».
qrSizeBefore. Размер шрифта текста до QR-кода. Обычно используют f0 (обычный, стандартный) и f1 (полужирный, выделенный). По умолчанию f0.
qrTextAfter. Текст после QR-кода. По умолчанию «Спасибо!».
qrSizeAfter. Размер шрифта текста после QR-кода. Обычно используют f0 (обычный, стандартный) и f1 (полужирный, выделенный). По умолчанию f0.
qrLocation. Позиция QR-кода в пречеке (накладной). По умолчанию: BeforeHeader. Допустимые значения:

• AfterFooter — в конце чека.
• AfterHeader — после заголовка (включая данные, имя официанта и прочее) и перед данными чека.
• BeforeFooter — после данных чека (после суммирования результатов).
• BeforeHeader — перед заголовком (в самом начале чека).

qrSize. Размер QR-кода. Допустимые значения: small, medium, large, extra-large. По умолчанию: small.
qrCorrection. Уровень коррекции ошибок QR-кода. Допустимые значения: low, medium, quartile, high. По умолчанию: high.

Пример содержимого конфигурационного файла:

3.3. Для настройки личного кабинета PayKeeper перейдите по ссылке личного кабинета и откройте раздел «Настройки».

3.4. Далее откройте вкладку «Получение информации о платежах» и в поле «Способ получения уведомления о платежах» выберите «На электронную почту». В поле «Электронные адреса для уведомлений» укажите электронные адреса почт, куда будут приходить уведомления об успешной оплате. Нажмите кнопку «Сохранить».

4. Добавление внешней оплаты в iikoOffice.

4.1. Запустите программу iikoOffice.

4.2. В разделе меню РОЗНИЧНЫЕ ПРОДАЖИ выберите пункт ТИПЫ ОПЛАТ.

4.3. Нажмите кнопку ДОБАВИТЬ и заполните поля (рисунок 4.3):

Наименование. Укажите, например, PayKeeperSbp.
Тип. Выберите ВНЕШНИЙ ТИП ОПЛАТЫ.
Название в чеке. Укажите, например, PayKeeperSbp.
Запрещать вводить вручную. Уберите галочку, чтобы сумма оплаты формировалась автоматически.
Можно комбинировать с другими типами оплаты. При необходимости принимать оплату частично (например, часть наличными, часть по карте) поставьте галочку. В иных случаях галочку необходимо убрать.
Применять для всех категорий блюд. Выберите нужную категорию, либо оставьте пустым, чтобы применять ко всем.
Печатать товарный чек. Поставьте галочку при необходимости.
Открывать денежный ящик. Можно убрать галочку, поскольку при таком способе оплаты данное действие не требуется.
Устанавливать точную сумму. Поставьте галочку, если необходимо автоматически вносить сумму заказа при оплате. Полезно, например, для оплаты заказа одним или несколькими ваучерами.
Может приниматься извне. Данная опция не будет доступна.
Безналичный тип. Выберите из списка PayKeeperSbp.
Счет выручки. Выберите нужное.
Счет поступления денег. Выберите нужное.
Является фискальным. Поставьте галочку при необходимости.

Нажмите кнопку «Сохранить» для завершения.

5. Работа с плагином PayKeeper.

5.1. При запуске iikoFront появится сообщение об успешном запуске плагина PayKeeperSbp.

Дальнейшие действия в зависимости от режима работы плагина.

5.2. Режим qrPrintInPrecheck (при работе с кнопками ПРЕЧЕК или НАКЛАДНАЯ).

5.2.1. При обслуживании официантом в зале. Создаём заказ и переходим в него. Выбираем тип заказа, если он не указывается автоматически (рисунок 5.2.1. п.1). Добавляем гостя и позиции заказа. Нажимаем ПРЕЧЕК (рисунок 5.2.1. п.2). Пречек печатается с QR-кодом. В этот момент создается счёт на оплату в кабинете PayKeeper. Инициируется периодическая проверка статуса платежа до момента оплаты по QR-коду. После успешной оплаты в заказе будет автоматически сохранена оплата PayKeeper.

5.2.2. При обслуживании заказа на доставку или самовывоз. Создаём заказ и переходим в него. Добавляем гостя и позиции заказа. Начинаем готовить заказ. После завершения готовки нажимаем ПРИГОТОВЛЕН (рисунок 5.2.2. п.1). После этого автоматически или при нажатии на кнопку «Накладная» (рисунок 5.2.2. п.2) печатается накладная с QR-кодом. В этот момент создается счёт на оплату в кабинете PayKeeper. Инициируется периодическая проверка статуса платежа до момента оплаты по QR-коду. После успешной оплаты в заказ будет добавлена оплата PayKeeper. Заказ будет закрыт автоматически при определённых настройках.

5.3. Режим activeTag (при работе с Активной меткой).

5.3.1. При обслуживании официантом в зале или самовывоз. Оформляем заказ со всеми необходимыми манипуляциями с ним и переходим в него. В зависимости от обслуживания переходим в оплату заказа по кнопке «КАССА» или «ППЛАТЕЖИ». На экране оплаты заказа нажмите «БАНКОВСКИЕ КАРТЫ» и выберите «PayKeeperSbp» (рисунок 5.3.1.).

5.3.2. Нажимаем кнопку «ОПЛАТИТЬ». Появится окно ожидания оплаты с обратным отсчётом времени (рисунок 5.3.2). За это время метка будет активна. В случае окончания времени ожидания метка будет деактивирована и при необходимости нужно снова нажать кнопку «ОПЛАТИТЬ».

5.3.3. После оплаты Покупателем по Активной метке заказ будет зачислен в заказ автоматически. Если опция настройки плагина activeTagShowPaymentResult выключена, то после успешной оплаты окно закроется автоматически. В ином случае появится окно с уведомлением об успешной оплате, в котором нужно будет нажать кнопку закрытия для продолжения.

5.4. Режим qrOnCustomerScreen (при работе с QR-кодом на экране Покупателя).

5.4.1. При обслуживании официантом в зале или самовывоз. Оформляем заказ со всеми необходимыми манипуляциями с ним и переходим в него. В зависимости от обслуживания переходим в оплату заказа по кнопке «КАССА» или «ППЛАТЕЖИ». На экране оплаты заказа нажмите «БАНКОВСКИЕ КАРТЫ» и выберите «PayKeeperSbp» и нажмите кнопку «ОПЛАТИТЬ». Готовый для сканирования QR-код появится на экране Покупателя. После успешной оплаты в заказ будет добавлен платёж.

5.5. Режим showPluginButton (при работе с кнопкой плагина).

5.5.1. При работе с удалённым Покупателем в онлайне оформляем заказ со всеми необходимыми манипуляциями с ним и переходим в него. Нажимаем внизу кнопку «PAYKEEPERSBP» (рисунок 5.5.1 пункт 1). Появится окно с опциями, в котором выбираем опцию «Отправить счёт по Email» (рисунок 5.5.1 пункт 2).

5.5.2. После выбора опции будет создан счёт на оплату в личном кабинете PayKeeper. В случае если у добавленного в заказ Покупателя указана почта, то на неё будет проведена попытка отправки счёта на оплату. На экране появится окно со ссылкой на оплату и с результатом отправки её по Email (рисунок 5.5.2).

Оставьте заявку

Менеджер перезвонит вам и расскажет про детали подключения

Контактное лицо

Контактный телефон

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

Электронная почта

Адрес сайта

---

Соглашаюсь с обработкой персональных данных Отправить