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

Froddy стоит перед выплатой, принимает один запрос и возвращает allow, hold или block до движения денег.

Froddy — слой контроля перед выплатой для автоматизированных выплат. Он помогает остановить дубли, сломанные лимиты и ошибки payout-логики до отправки денег. Финальное действие остаётся за вашей системой.

Что делает Froddy

Проверяет запрос до отправки выплаты
Возвращает один из вердиктов: allow, hold, block
Помогает находить дубли, ошибки правил и сбои логики
Оставляет единый журнал решений до движения денег

Чего Froddy не делает

не отправляет деньги
не является банком, PSP или payout rail
не заменяет KYC/AML
не является полной антифрод-системой

Как это работает

Ваша система отправляет запрос в Froddy перед выплатой.
Froddy проверяет правила и контекст запроса.
В ответ вы получаете allow, hold или block.
Финальное действие — отправить выплату, поставить её на hold или остановить — остаётся на вашей стороне.

Что передавать в запросе

Передавайте только данные, которые нужны для принятия решения. По умолчанию Froddy не требует сырые персональные данные. Во многих сценариях достаточно хешированных или псевдонимизированных идентификаторов, а также технических и бизнес-полей, которые помогают проверить дубли, лимиты и правила.

Обычно достаточно передать:

идентификатор выплаты или перевода
идентификатор пользователя, аккаунта или партнёра
сумму и валюту
маршрут, способ или тип назначения
метаданные, важные для проверки правил
ключ идемпотентности или внешний идентификатор
время события и связанный контекст

Какие вердикты возвращает API

allow — запрос можно пропускать дальше
hold — запрос нужно остановить для дополнительной проверки или ручного решения
block — запрос нужно отклонить

Используйте этот набор вердиктов последовательно во всей интеграции.

Быстрый старт

Откройте демо и посмотрите формат запроса и ответа.
Создайте аккаунт и начните с демо.
Подключите один pre-payout вызов перед отправкой денег.
Обработайте allow, hold или block на своей стороне.
При необходимости подключите webhook-уведомления.

Endpoint и доступ

Запросы отправляются методом POST на /v1/evaluate. Аутентификация — через заголовок X-API-Key с вашим API-ключом. Для демо-тенанта ключ не требуется. Эндпоинт идемпотентен: повторный запрос с тем же event_id вернёт исходное решение без повторной оценки.

Какие поля обязательны минимально

Обязательные поля: event_id, entity_id, amount. Остальные поля опциональны и имеют дефолты: currency — USD, event_type — payout, timestamp — текущее время UTC, metadata — пустой объект. Timestamp не должен отличаться от текущего времени более чем на 24 часа.

Пример запроса

{
  "event_id": "po_20260306_001",
  "entity_id": "usr_9f1c2a7b",
  "amount": 15000,
  "currency": "RUB",
  "timestamp": "2026-03-06T10:15:00Z",
  "metadata": {
    "partner_id": "partner_42",
    "route": "manual_payout"
  }
}

Пример ответа

{
  "event_id": "po_20260306_001",
  "verdict": "hold",
  "rule_id": "R-CEIL",
  "reason": "Single tx $15,000.00 exceeds hold threshold $10,000.00",
  "evaluated_at": "2026-03-06T10:15:01Z"
}

Ошибки и обработка ответа

400 — невалидный запрос (например, timestamp отличается от текущего времени более чем на 24 часа)
401 — отсутствует или невалидный X-API-Key
429 — превышен rate limit; повторите запрос через несколько секунд

Уведомления

Froddy поддерживает webhook-first сценарий для уведомлений о событиях и изменениях, связанных с обработкой запросов. Используйте webhook как основной публичный способ получать такие сигналы.

Webhook: что учитывать

Вебхук срабатывает только при вердиктах hold и block. Доставка best-effort, повторных попыток нет. Payload содержит: event_id, verdict, rule_id, reason, amount, entity_id, evaluated_at. Адрес задаётся через PUT /v1/webhook с телом {"url": "https://..."}.

Данные и журнал решений

Froddy помогает строить журнал решений до движения денег. По умолчанию можно работать без сырых персональных данных, используя хешированные или псевдонимизированные идентификаторы. Это упрощает data minimization и аудит payout-решений.

Если вам нужны DPA или описание обработки данных, свяжитесь с нами.

Что дальше

Демо Начать бесплатно Контакты