Документация HighHelp

HighHelp — платежный шлюз, который позволяет принимать и отправлять платежи через H2H API и платежный виджет HighHelp. Эта документация предназначена для разработчиков и инженеров, которые интегрируют HighHelp в свои сервисы.

Возможности HighHelp

С помощью API и платежного виджета вы можете:

создавать P2P-платежи и выплаты;
выполнять e-commerce-оплаты по картам;
получать информацию о заявках и их статусах;
запрашивать баланс кассы;
получать служебные данные (списки банков, методы оплаты и т.п.).

Общая модель сущностей (касса, платеж, операция, виджет, личный кабинет и т.д.) описана в разделе Основные понятия.

Как устроена документация

Документация организована по типовым задачам интеграции.

Начало работы
- Перед началом работы — предварительные требования, роли, доступ к кабинету мерчанта.
- Быстрый старт — минимальный сценарий первого платежа через H2H API.
Интеграция по API (H2H)
- Обзор API — основные возможности и ограничения API, список поддерживаемых методов.
- Аутентификация и подпись — как получать ключи, формировать заголовки и подпись запроса.
- Обзор H2H-интеграции — общая схема работы через H2H, типовой жизненный цикл платежа.
Интеграция через виджет (H2C)
- Обзор виджета — что такое виджет, когда его использовать вместо H2H.
- Порядок интеграции виджета — шаги для подключения виджета на стороне мерчанта.
- Настройка виджета — настройка внешнего вида и поведения платежного виджета под сценарии мерчанта.
Справочники
- Коды валют и Коды стран — списки поддерживаемых валют и стран.
- Коды языков — языки интерфейса виджета.
- Типы платежей и Методы оплаты (H2H) / Методы виджета — справочник по типам и методам.
- Коды статусов — статусы заявок и описания ошибок.
- Глоссарий — термины, использующиеся в документации.
Примеры интеграции
- Обзор примеров интеграции — как устроены примеры и как их запускать.
- пример интеграции на PHP и пример интеграции на JavaScript — готовый код для H2H-сценариев.

С чего начать

Рекомендуемый порядок для первого запуска интеграции:

Ознакомиться с Перед началом работы и подготовить доступ к кабинету мерчанта.
Настроить ключи и заголовки по инструкции в Аутентификация и подпись.
Выполнить первый тестовый платеж по шагам из Быстрый старт.
Определить сценарий интеграции:
- H2H API — см. Обзор H2H-интеграции;
- платежный виджет HighHelp — см. Обзор виджета.