Подключение к API
Кошелёк Pay API
Документация перемещена
Информация на этой странице не обновляется и может быть устаревшей. Наиболее полная и актуальная версия документации для разработчиков доступна по новому адресу:
Провайдером API выступает сервер Кошелька. Потребителями API являются кассовое ПО и узлы ЦОД ТСП.
Параметры подключения
Партнёру (ТСП) передаются следующие параметры для подключения к Кошелёк Pay API:
Параметр | Описание |
---|---|
Login | Имя пользователя для авторизации запросов API (используется HTTP Basic Authentication). |
Password | Пароль для авторизации запросов API. |
API Base URL (test) | URL для тестового подключения: https://api-test.koshelek.app/<partner-name> |
API Base URL (production) | URL для промышленного подключения: https://api.koshelek.app/<partner-name> |
API Base URL уникален для каждого партнёра. Например, для партнёра с именем name
Base URL будет выглядеть так:
API Base URL (test): https://api-test.koshelek.app/name
API Base URL (production): https://api.koshelek.app/name
В информационном обмене с партнёром (ТСП) используется ряд параметров, идентифицирующих ТСП. Параметры перечислены в таблице ниже. Цветом обозначены параметры, передаваемые в случае, если оплата осуществляется через Систему быстрых платежей (СБП):
Параметр | Контекст | Описание |
---|---|---|
| Общий |
|
| Общий |
|
Stores: | Общий |
|
| Общий, если у кассы есть онлайн-хост |
|
| Общий, если у кассы есть онлайн-хост |
|
Terminals: | Общий |
|
| СБП |
|
| СБП |
|
| СБП |
|
| СБП |
|
| СБП |
|
| СБП |
|
| Общий, если у кассы есть онлайн-хост | URL, используемый кассой для приёма статуса транзакции от сервера Кошелёк Pay. |
Авторизация запросов
Взаимодействие осуществляется по протоколу HTTPS. Для авторизации запросов к Pay API необходимо использовать HTTP Basic Authentication (RFC 7617). Данные для авторизации запросов передаются в HTTP-заголовке Authorization
.
Используемая версия протокола TLS — не ниже 1.2.
Требования к кодировкам
Как в запросах, так и в ответах используется кодировка UTF-8.
Формат и структура сообщений
Все методы API ожидают тип данных в заголовке: Content-Type: application/json
и возвращают тело ответа в формате "application/json"
.
Last updated