README

Paykeeper OpenAPI specs

Все публичные OpenAPI-спеки из paykeeper.stoplight.io, скачанные одним махом чтобы не лезть в Stoplight через браузер.

Обзор

Файл	Проект	Base URL	Paths
api-vyplat.yaml	API выплат (OCT)	https://oct-api.paykeeper.ru/api/	6
applepay.yaml	ApplePay token processing	https://applepay.paykeeper.ru/	4
autoinstaller.yaml	Autoinstaller	https://autoinstall.paykeeper.ru	9
ims-api.paykeeper.ru.yaml	Каталог товаров	https://ims-api.paykeeper.ru/api/v1/	9
lk-paykeeper-vi-mpos.yaml	API ЛК PayKeeper / VI_MPOS	https://{client_name}.server.paykeeper.ru	4
partner-api.yaml	Partner API	https://partner.paykeeper.ru/api	21
paykeeper-app-mpos.yaml	PayKeeper App (mPOS deep links)	paykeeper://mobile.app	7
paykeeper-mirpay.yaml	MirPay	https://mirpay.paykeeper.ru	2
support-api.yaml	Support API	https://support-api2.paykeeper.ru/api/	19
test-project-logs.json	Сервис логов устройств (test project)	https://api.example.com	2

Спеки — детально

API выплат (OCT) — api-vyplat.yaml

Title: OCT API
Summary: API вкладки выплат
Base URL: https://oct-api.paykeeper.ru/api/
Security: JWT

Method	Path	Summary
GET	/info/balance/	10.1. Баланс ТСП
GET	/info/oct/list/	10.2. Список операций
GET	/info/oct/search/	10.3. Поиск операций
GET	/info/oct/bycard/	10.4. Список операций по карте
POST	/change/oct/dopayment/	10.5. Сделать перевод
GET	/export/oct/	10.6. Экспорт списка операций

ApplePay token processing — applepay.yaml

Title: ApplePay token processing
Base URL: https://applepay.paykeeper.ru/

Method	Path	Summary
POST	/opb/applepay/validate	Validate Session
POST	/opb/applepay/do_payment	Make payment
POST	/opb/yandexpay/do_payment/	Выполнить платёж по токену YandexPay
POST	/opb/yandexpay/notify/	Уведомить Яндекс об операции по токену

Autoinstaller — autoinstaller.yaml

Title: AutoInstaller api
Description: AutoInstaller API To use this API, you need to obtain a passcode.
Base URL: https://autoinstall.paykeeper.ru

Method	Path	Summary
POST	/api/requests	Получить список задач на создание ЛК
POST	/api/update_request_status	Обновить статус задачи на создание ЛК
GET	/api/request_config_fiscal	Получить список задач на настройку ЛК
POST	/api/request_config_fiscal	Создать задачу на настройку ЛК
POST	/api/request_config_fiscal/update_status	Обновить статус задачи на настройку ЛК
GET	/api/request_config_fiscal/get_status	Получить статус задачи на настройку ЛК
GET	/api/mpk_system	Получить список mpk систем
POST	/api/mpk_system	Создать mpk систему
GET	/api/mpk_system/show	Получить mpk систему
POST	/api/mpk_system/update	Обновить mpk систему
DELETE	/api/mpk_system/remove	Удалить mpk систему

Каталог товаров — ims-api.paykeeper.ru.yaml

Title: ims-api.paykeeper.ru
Summary: API сервиса каталога товаров
Description: Предоставляет API каталога товаров для личного кабинета и мобильного приложения.
Base URL: https://ims-api.paykeeper.ru/api/v1/
Security: paykeeper_service_token

Method	Path	Summary
GET	/tags/	Список тегов товаров
POST	/tags/	Создать тег
GET	/tag/{id}	Данные о теге
PATCH	/tag/{id}	Изменить тег
DELETE	/tag/{id}	Удалить тег
GET	/products/	Список товаров
POST	/products/	Добавить товар
GET	/product/{id}	Данные товара
PATCH	/product/{id}	Изменить товар
DELETE	/product/{id}	Удалить товар
GET	/item_types/	Типы товаров
GET	/products/search/	Поиск по товарам
POST	/products/import	Импорт
GET	/suppliers	Список поставщиков
POST	/suppliers	Создать поставщика
GET	/supplier/{id}	Данные о поставщике
PATCH	/supplier/{id}	Изменить поставщика
DELETE	/supplier/{id}	Удалить поставщика

API ЛК PayKeeper / VI_MPOS — lk-paykeeper-vi-mpos.yaml

Title: PayKeeper LK v2
Base URL: https://{client_name}.server.paykeeper.ru
Security: token, JWT, basic

Method	Path	Summary
GET	/info/user/settings/	4.1. Запрос настроек текущего пользователя
POST	/change/user/update	5.7 Запрос на изменение существующего пользователя
POST	/change/user/add	5.6. Запрос на добавление пользователя
POST	/{somepath_success}	POST-оповещение об успешном платеже

Partner API — partner-api.yaml

Title: API for partners
Description: Методы, предоставляемые партнёрам PayKeeper
Base URL: https://partner.paykeeper.ru/api
Security: api_token

Method	Path	Summary
GET	/shops	Поиск организаций
POST	/shops/{paykeeper_id}/note	Добавить комментарий к клиенту
POST	/login	Авторизация
POST	/client/add	Добавить организацию
GET	/shops/{paykeeper_id}/documents	Документы, прикреплённые к клиенту
POST	/shops/{paykeeper_id}/documents	Загрузить документ к клиенту
GET	/documents/{document_uuid}	Информация о документе
POST	/documents/{document_uuid}	Изменить атрибуты документа
DELETE	/documents/{document_uuid}	Удалить документ
GET	/shops/{paykeeper_id}/cabinets	Список ЛК PayKeeper у ТСП
GET	/shops/{paykeeper_id}/temp-access	Получить временный доступ к ЛК PayKeeper
GET	/shop/{paykeeper_id}	Информация о ТСП
POST	/shop/{paykeeper_id}/add-tochka-sbp	Добавить аккаунт СПБ Точки
POST	/shops/{paykeeper_id}/add-contact	Добавление контакта для клиента
GET	/reports/alfa-ecom	Поиск организаций для отчета Ecom Alfa
POST	/reports/alfa-ecom/{id}	Добавление акта и даты акта Ecom Alfa
POST	/shops/{paykeeper_id}/secret	Передать секретные аутентификационные данные
GET	/deliveries	Информация о доставках
POST	/deliveries	Добавить доставку
POST	/deliveries/update-status	Обновление статуса доставки
POST	/device/install	Установка оборудования
POST	/device/service	Сервис оборудования
POST	/device/dismantle	Демонтаж оборудования
GET	/device/status	Запрос статуса установки оборудования
GET	/api/shops/{paykeeper_id}/smartcash-access	Получение доступа для ККТ

PayKeeper App (mPOS deep links) — paykeeper-app-mpos.yaml

Title: PayKeeper mPOS payments and payout
Summary: Вызов приложения PayKeeper для приёма платежей или совершения выплат
Description: Приложение PayKeeper может быть вызвано из внешнего приложения для быстрой инициализации приёма платежа или операции выплаты через mpos-терминал или с помощью других способов. Для вызова приложения используются deep link’и. С помощью ссылки [paykeeper://mobile.app/invoice/](../reference/PayKeeper-…
Base URL: paykeeper://mobile.app

Method	Path	Summary
GET	/invoice/	Создание и оплата заказа из внешнего приложения
GET	/your_path_for_payment_result	Возврат в ваше приложение после операции
GET	/refund/	Возврат платежа
GET	/receipt/	Выдача чека
GET	/payout/	Операция выплаты физлицу
GET	/your_path_for_payout_result	Возврат в ваше приложение после выплаты
GET	/payout

MirPay — paykeeper-mirpay.yaml

Title: mirpay.paykeeper.ru API
Description: Инициализация JWT токена для диплинка на платёжной страницы Банка, получение JWE-токена с данными карты от приложения MirPay.
Base URL: https://mirpay.paykeeper.ru

Method	Path	Summary
GET	/mirpay/prepare	1. Сформировать токен JWT для диплинка
PUT	/api/v1/In-Application/merchants/{merchantId}/orders/{orderId}	2. Приём JWE с данными карты

Support API — support-api.yaml

Title: Support API
Description: API вкладки технической поддержки. Для авторизации необходимо передать JWT-токен, предварительно полученный от сервера с PayKepeer с помощью метода GET /info/settings/service-token/?service=support-api.paykeeper.ru. Токен передаётся в заголовке Authorization: Bearer .
Base URL: https://support-api2.paykeeper.ru/api/
Security: API Key

Method	Path	Summary
GET	/tickets	Получить список тикетов
GET	/statuses	Статусы тикетов
GET	/agents	Список назначенных агентов по тикетам
GET	/info/statuses	Возможные статусы тикетов
GET	/info/top_tickets	Топ 20 ТСП с наибольшим количеством тикетов
GET	/version	Для тестирования
GET	/ticket/{ticket_id}/get	Тикет с комментариями
POST	/ticket/create	Создать новый тикет
GET	/ticket/status	Проверка добавления тикета
POST	/ticket/{ticket_id}/comment	Добавить комментарий к тикету
GET	/attachments/{attachment_id}/download	Скачать файл
POST	/ticket/{ticket_id}/solved	Переводит тикет в статус решен, если он не был закрыт
POST	/ticket/{ticket_id}/reopen	Повторно открывает тикет, если он был решен
POST	/ticket/rate	Оценить тикет
GET	/account/{account_id}/get	Получить пользователя по id
POST	/ticket/update/cc	Обновление списка получателей
GET	/accounts	Пользователи связанные с ТСП
GET	/temp_users/{uuid}	Получение временного пользователя по UUID
GET	/suggestionusers	Список возможных участников

Сервис логов устройств (test project) — test-project-logs.json

Title: Сервис загрузки и просмотра лог-файлов устройств
Description: Микросервис позволяет устройствам загружать данные о лог-файле, а сотрудникам техподдержки — просматривать список загруженных логов. * Эндпоинты для сотрудников ТП защищены HTTP Basic. * Эндпоинты для устройств защищены Bearer-токеном (Authorization: Bearer <device_secret_token>). * При от…
Base URL: https://api.example.com
Security: basicAuth, deviceTokenAuth

Method	Path	Summary
GET	/api/logs/view	Просмотр логов устройства
PUT	/api/logs/upload	Загрузка мета-информации о логе устройством