Контакт-центр 8 (800) 775-37-51 бесплатно по России
Москва +7 (800) 775-37-51
Санкт-Петербург +7 (812) 385-75-57

Iiko (Айко) 7.x-9.x

Инструкция по установке и использованию плагина PayKeeper для iiko (Айко) 7.x-9.x

 

Требования.

  • Версия IIKO 7.х – 9.х.

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

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

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

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

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

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

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

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

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

1.1.2. Официант печатает в iikoFront пречек с QR-кодом для оплаты.

1.1.3. Посетитель сканирует QR-код и производит оплату, показывая успешное завершение операции.

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

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

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

1.2.2. После завершения готовки заказа в зависимости от настроек в iikoOffice автоматически или при нажатии на кнопку «Накладная» печатается чек с QR-кодом для оплаты.

1.2.3. Покупатель сканирует QR-код и производит оплату, показывая успешное завершение операции.

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

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

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

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

2.3. Папку «Resto.Front.Plugin.PayKeeper» перенесите в папку плагинов iikoFront. Для Windows это папка по пути «C:\Program Files\iiko\iikoRMS\Front.Net\Plugins\».

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

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

3.2. Найдите тег <userSettings>, внутри которого в каждом теге «setting» с именем «name» укажите свое значение в теге «value» по следующему описанию и примерам:
PAYKEEPER_LK_URL. Обязательный параметр. Ссылка на личный кабинет PayKeeper, которую вам выдали при подключении. Пример: https://mysite.server.paykeeper.ru.
PAYKEEPER_LK_SECRET. Обязательный параметр. Секретное слово из личного кабинета PayKeeper. Раздел НАСТРОЙКИ. Подраздел ПОЛУЧЕНИЕ ИНФОРМАЦИИ О ПЛАТЕЖАХ.
PAYKEEPER_LK_USER. Обязательный параметр. Имя пользователя с правами админа из личного кабинета PayKeeper (раздел НАСТРОЙКИ, подраздел ДОСТУП В ЛИЧНЫЙ КАБИНЕТ). . Пример: admin.
PAYKEEPER_LK_PASS. Обязательный параметр. Пароль пользователя с правами админа из личного кабинета PayKeeper.
psType. Необязательный параметр. Данный параметр заполняется только в том случае, если необходимо принимать платежи по СБП. Необходимо указывать только типы платёжных систем по СБП, например, sbp_default. Для приёма оплаты по ИЭ следует очистить и оставить значение пустым.
transferCart. Включает (True) или отключает (False) передачу корзины. Если необходимо, чтобы в PayKeeper передавались позиции заказа, укажите True. По умолчанию True.
transportApiKey.  Необязательный параметр. API-ключ для интеграции iikoCloud. Получите API-ключ по инструкции https://ru.iiko.help/articles/#!api-documentations/connect-to-iiko-cloud.
transportOrganisationId.  Необязательный параметр. Идентификатор организации в iikoCloud. Пример: f718ea7f-8e0d-4adb-2fee-f6dc44d15150
iikoUserPin.  Обязательный параметр. Пин-код для входа в iikoFront. Пример: 1111. Требуется для выполнения внутренних операций. Если его указать неверно, плагин не будет работать должным образом.
requestsTimeOut. Время периодичности запросов в секундах. С данной периодичностью происходит проверка состояния заказов. Пример: 30.
removePrepays. Управляет удалением существующих платежей перед добавлением нового. Если указано True, система удаляет все платежи, не относящиеся к принудительным типам, и добавляет новый платёж. Если False, система либо изменяет сумму существующего платежа, либо добавляет новый, не удаляя старые. Это обеспечивает гибкость в обработке платежей и интеграции с PayKeeper. По умолчанию True.
closeDeliveryOrder. Управляет автоматическим закрытием заказов на доставку через интеграцию с внешним API в iikoCloud. Если параметр включен (True), система инициализирует клиент API и отправляет запросы на закрытие заказов после оплаты. Если параметр отключен (False), эта функциональность не используется. Это обеспечивает гибкость в управлении заказами на доставку и интеграции с транспортными службами. По умолчанию False.
paidOrder. Управляет автоматическим проведением сохранённой оплаты в заказе. При значении True делает заказ оплаченным и закрывает заказ при полном покрытии стоимости заказа суммой оплаты. Не работает для типа обслуживания БАНКЕТ. Если указано False, то при автоматическом сохранении оплаты в заказе просто всплывает уведомление об этом. По умолчанию True.
qrLocation. Позиция QR-кода в чеке. Допустимые значения:

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

qrCaption. Подпись над QR-кодом. Пример: Просканируй QR-код для оплаты.
qrSize. Размер QR-кода. Допустимые значения: small, medium, large, extra-large. По умолчанию: small.
qrCorrection. Уровень коррекции ошибок QR-кода. Допустимые значения: low, medium, quartile, high. По умолчанию: high
handleAllOrdersTypes. Генерировать QR-код для всех типов заказов. Если указать False, то QR-код будет генерироваться только для типов доставки. Допустимые значения: True, False. По умолчанию: False.
forcedPaymentsTypesIds. Необязательный параметр. Список идентификаторов типов способов оплат, которые должны быть исключены из обработки (например, принудительные или системные способы оплаты). При указании идентификаторов таких способов оплат, они не учитываются при обработке заказа. По умолчанию указано одно значение: 00000000-0000-0000-0000-000000000000. Чтобы вставить второе, нужно после </string>  вставить еще одно значение <string>здесь идентификатор</string> .
Пример содержимого конфигурационного файла:

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

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

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

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

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

Рисунок 4.3. Добавление внешней оплаты.

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

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

Сообщение об успешном запуске плагина PayKeeper.

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

Рисунок 5.2. Заказ с типом БАНКЕТ, РЕЗЕРВ.

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

Рисунок 5.3. Заказ с типом ДОСТАВКА.

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

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