API YaKassa
Как подключить свою программу к кассе: пробивать чеки, принимать оплату картой, управлять сменой.
Какой способ выбрать
Способов подключения несколько, и выбор зависит от того, где работает ваша программа и есть ли физическая касса.
| Ваш случай | Способ | Что понадобится |
|---|---|---|
| Программа в облаке, в магазине стоит касса с терминалом | Обмен через кассу по HTTP | токен с экрана кассы, интернет у вас и у кассы |
| Программа в том же магазине, в одной сети с кассой | Обмен через кассу по TCP | IP кассы и порт, токен не нужен, интернет для обмена не нужен |
| Физической кассы нет: сайт, обменный пункт, чеки пробивает сервер | Фискализация без кассы, V2 | логин, пароль и kkmID от ЦТО |
| Ваше приложение стоит на том же Android-устройстве, что и касса | Intent | вызов приложения YaKassa |
| Нужно только принять оплату картой, чек не нужен | Оплата без чека | TCP-сервер на кассе и настроенная безналичная оплата |
| Нужно получать в свою программу каждый чек, в том числе пробитый кассиром | Оповещения о чеках | ваша программа в одной сети с кассой |
Для нового подключения с физической кассой берите обмен v4: он даёт оба канала и не зависит от длительности оплаты картой.
Версии
| Версия | Основной метод | Как работает | Состояние |
|---|---|---|---|
| v4 | receipt-v4 | документ принимается, результат забирается отдельным запросом | актуальная |
| V2 | receipt-v2 | чек пробивает сервер, приложение кассы не участвует | актуальная |
| Intent | вызов YAROS_KKM_ACTION | результат возвращается вызвавшему приложению | актуальная |
| Оплата без чека | /payment | только банковская операция, по TCP | актуальная |
| Старый синхронный обмен | receipt | ответ в том же запросе, ожидание ограничено | работает, для новых подключений не брать |
Платежи через /gate/bank | bank | старый метод | снят, отвечает 404 |
С чего начать
- Прочитайте первый чек за пять минут: он покажет весь путь на демо-кассе.
- Посмотрите адреса и общие правила: они одинаковы для всех способов.
- В таблице методов найдите, какие операции есть в выбранном способе.
- Проверьте версии и совместимость: часть возможностей требует свежей кассы.
- Перед выпуском пройдите чек-лист интеграции.