Глоссарий
Основные сущности
- Платежный шлюз
-
Платежная платформа HighHelp, которая принимает запросы от систем мерчанта, обрабатывает платежи и переводы, взаимодействует с банками и внешними платежными провайдерами и возвращает результат.
- Мерчант
-
Клиент платежного шлюза — компания или сервис, который интегрируется с API и/или виджетом, чтобы принимать платежи или выполнять переводы.
- Плательщик
-
Конечный пользователь (клиент мерчанта), который инициирует платеж или перевод.
- Получатель
-
Лицо, на счет которого зачисляются средства (в P2P и выплатах может отличаться от мерчанта).
- Платеж
-
Бизнес-сценарий перемещения средств (например, оплата заказа или перевод). В рамках кассы идентифицируется полем
payment_id, заданным мерчантом. - Операция
-
Техническая единица обработки в платежном шлюзе (списание, зачисление, возврат, выплата и т. п.).
- Касса
-
Внутренний расчетный счет мерчанта в платежном шлюзе. В API и оповещениях идентифицируется полем
project_id. Через кассу проходят зачисления, списания и выплаты по операциям. - Баланс кассы
-
Текущий остаток средств на кассе в конкретной валюте. Включает доступную для новых операций сумму и замороженную часть баланса.
- Замороженный баланс
-
Часть баланса кассы, зарезервированная под незавершенные операции (например, авторизации до списания).
- Проект
-
Логическая единица интеграции мерчанта (интернет-магазин, сервис, приложение), привязанная к кассе. Для проекта настраиваются методы оплаты, ключи и URL для оповещений (
merchant_*_callback_url). В API и оповещениях идентифицируется полемproject_id. - Провайдер
-
Внешний платежный партнер (банк, платежная система и т. п.), через которого платежный шлюз проводит операции.
- Заявка
-
Запись об операции или платеже в системе HighHelp. Заявка содержит параметры операции и ее текущий статус. Идентифицируется полем
request_id. - Апелляция
-
Обращение по проведенной операции (спор, запрос уточнения или пересмотра результата), создаваемое и обрабатываемое в системе.
Виджет и личный кабинет
- Платежный виджет
-
Встраиваемая платежная форма HighHelp, отрисовываемая и обслуживаемая на стороне HighHelp. Плательщик вводит данные на платежной странице виджета, а платежные данные отправляются напрямую в платежный шлюз.
- Платежная страница
-
Интерфейс, который видит плательщик при работе с платежным виджетом HighHelp. Допустимо использовать формулировку «платежная страница виджета».
- Личный кабинет мерчанта
-
Веб-интерфейс HighHelp для сотрудников мерчанта. Через личный кабинет можно смотреть балансы и операции, искать платежи, управлять проектами и кассами, настраивать ключи и URL для оповещений.
Продукты
- P2P
-
Переводы между физическими лицами (person-to-person / peer-to-peer), например с карты на карту или со счета на счет, инициируемые через платежный шлюз.
- ECOM
-
Интернет-платежи за товары и услуги мерчанта (e-commerce-сценарий, интернет-эквайринг).
Типы платежей
- Оплата (
payin) -
Тип платежа, при котором денежные средства перечисляются со счета пользователя на счет мерчанта.
- Выплата (
payout) -
Тип платежа, при котором денежные средства перечисляются со счета мерчанта на счет пользователя.
Варианты интеграции
- H2H-интеграция
-
Сервер-к-серверу интеграция (host-to-host), при которой бэкенд мерчанта напрямую вызывает API платежного шлюза. Пользовательский интерфейс оплаты реализуется на стороне мерчанта.
- H2C-интеграция
-
Интеграция с использованием виджета (host-to-client), при которой платежная форма отдается платежным шлюзом, встраивается на сайт или в приложение мерчанта, а платежные данные отправляются напрямую в шлюз.
Идентификаторы и данные
project_id-
Идентификатор кассы мерчанта в системе HighHelp. Передается в каждом запросе и оповещении.
payment_id-
Идентификатор платежа в системе мерчанта. Должен быть уникальным в рамках одной кассы.
request_id-
Идентификатор заявки в системе HighHelp. Генерируется при создании заявки и возвращается в ответах и оповещениях.
Аутентификация и подпись
- Ключи API
-
Набор данных для доступа к API кассы: идентификатор кассы и RSA-ключи, которые используются для формирования подписи запросов.
- Подпись запроса
-
Криптографическая подпись, формируемая на стороне мерчанта по данным запроса и приватному RSA-ключу кассы. Используется для проверки целостности данных и подлинности отправителя на стороне платежного шлюза.
- Метка времени запроса
-
Временная отметка, которая включается в запрос (например, заголовок
x-access-timestamp) и учитывается при проверке подписи для ограничения срока действия запроса и защиты от повторов.
Уведомления
- Оповещение
-
HTTP-оповещение (колбек) от платежного шлюза на сторону мерчанта с уведомлением об изменении статуса платежа или операции (успех, отказ, завершение выплаты и т. п.).
- URL для оповещений
-
Эндпоинт на стороне мерчанта, на который шлюз отправляет оповещения. Адрес задается в настройках проекта или в параметрах конкретной операции (
merchant_callback_url,merchant_success_callback_url,merchant_decline_callback_url).