Кабинет и API-ключ

Кабинет мерчанта — рабочее место, где вы видите сделки и баланс, забираете API-ключ и задаёте параметры интеграции. Всё, что настраивается здесь, действует по умолчанию для всех сделок; часть значений можно переопределить в теле конкретного запроса.

Регистрация и вход

Для регистрации в системе требуется специальный код приглашения. Запросите его у персонального менеджера по согласованному каналу связи. После получения кода откройте страницу регистрации: https://portal.cashwell.io

При создании аккаунта сохраните:

• пароль от учётной записи;
• ключ и резервные коды мультифакторной аутентификации (MFA).

Опасно

Доступ к кабинету восстанавливается только через персонального менеджера. Потерянный ключ MFA без резервных кодов означает блокировку доступа до ручной проверки.

Где взять API-ключ

1. Войдите в кабинет.
2. Откройте Профиль → API интеграция.
3. Скопируйте значение поля API Ключ.

Этот ключ решает две задачи сразу: им авторизуются ваши запросы к API (заголовок X-Secure-Key) и им же подписываются webhook-уведомления, которые платформа отправляет вам. Поэтому он должен храниться только на вашем сервере — не в мобильном приложении, не в браузерном коде и не в репозитории.

Если ключ скомпрометирован, запросите ротацию у менеджера: до замены старый ключ продолжает подписывать уведомления.

Параметры интеграции

На той же странице Профиль → API интеграция настраиваются три параметра.

Параметр	Что делает
Callback url	Адрес, куда уходят webhook-уведомления. Можно переопределить для отдельной сделки полем callbackUrl в теле запроса
Окно рандомизации суммы сделки	Допуск в 0–50 единиц фиата, в пределах которого платформа может сдвинуть сумму, чтобы одновременные платежи на один реквизит различались
Время ожидания для завершения оплаты сделки	Сколько минут у клиента есть на оплату Pay-In сделки. Значение приходит в ответе как paymentLifetime; по его истечении сделка уходит в canceled с cancelReason: "TIMEOUT"

Callback url можно задать и через API — см. Настройки кабинета. Значение времени ожидания задаётся на нашей стороне: если текущее окно вам не подходит, изменение согласуется с менеджером.

Разделы кабинета

Раздел	Что внутри
Дэшборд	Сводка по обороту и количеству операций за выбранный период
Сделки	Все Pay-In и Pay-Out операции с фильтрами по статусу и датам
Мэтчинг	Matching-заявки и сделки, которыми они закрываются
Выгрузки	Выписки и отчёты в CSV/XLSX для бухгалтерии
История операций	Все изменения баланса кабинета с указанием причины
Выводы	Вывод средств с баланса кабинета
Ставки	Действующие ставки и лимиты по каждому методу
Callback вызовы	История отправленных вам webhook-запросов: тело, код ответа, число попыток

Совет

Раздел Callback вызовы — первое место, куда стоит заглянуть, если вам кажется, что уведомления не приходят. Там видно, отдал ли ваш сервер 200 и сколько попыток доставки уже сделано.

Дальше

• Подпись запросов — как авторизовать запросы и проверять подпись уведомлений
• IP Whitelist — какие адреса передать до начала работы
• Быстрый старт — первая сделка от ключа до финального статуса