Разработчикам

API и интеграция за один день

Документация, песочница и готовые SDK — всё, чтобы провести первую транзакцию ещё до конца рабочего дня. Честные статусы, предсказуемые ответы и живые примеры кода.

Версия API — v2024-11-01 Средний ответ — 38 мс Лимит — 600 req/мин
Sandbox

Мгновенный доступ к тестовому окружению

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

Тестовые ключи

Пары sk_test_… и pk_test_… выдаются мгновенно. Раздельные лимиты и отдельный баланс, чтобы не мешать реальной кассе.

Получить ключ

Фиктивные карты и СБП

Готовые номера карт, коды СБП и кошельки для успешных, отклонённых и удержанных сценариев. Тестируйте отказоустойчивость без реальных денег.

Список тестовых реквизитов

Локальные вебхуки

Клиент cobalflow-cli listen пробрасывает события на 127.0.0.1:8080. Подключайте обработчик и смотрите статусы транзакций в реальном времени.

Как работает CLI
Среда

Песочница — как продакшен, только без денег

0 ₽
Стоимость доступа к тестовому окружению
60 сек
От регистрации до первого успешного платежа
100%
Совпадение моделей ответа с продакшеном
24/7
Доступность тестовых эндпоинтов
API Reference

Структура эндпоинтов и вебхуков

Единая базовая точка https://api.cobalflow.ru/v1. Все методы принимают и отдают JSON, используют Bearer-токен и возвращают предсказуемую структуру ошибок.

Payouts

POST /v1/payouts — создание выгрузки, GET /v1/payouts/{id} — статус, POST /v1/payouts/{id}/cancel — отмена. Батчи до 10 000 операций.

Схема объекта payout

Charges

POST /v1/charges — приём оплаты картой или СБП, POST /v1/charges/{id}/refund — полный и частичный возврат. Единая модель ответа для всех методов.

Схема объекта charge

Казначейство и отчёты

GET /v1/balance — остатки, GET /v1/statements?from=&to= — выгрузка за период, POST /v1/splits — разделение выручки между участниками.

Параметры отчётов
Быстрый старт

Первый запрос за минуту

Минимальный пример создания выгрузки. Ответ содержит идентификатор и статус, по которому можно подписаться на вебхук.

bash · curlPOST /v1/payouts
curl -X POST https://api.cobalflow.ru/v1/payouts \
  -H "Authorization: Bearer sk_test_51Kx9a2BcD3eF4g" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 12400,
    "currency": "RUB",
    "method": "bank_card",
    "recipient": "4081750000000000000",
    "description": "Выплата за проект #482"
  }'
ОтветHTTP 201 · 41 мс
{
  "id": "payout_8f3a2b71",
  "object": "payout",
  "status": "processing",
  "amount": 12400,
  "currency": "RUB",
  "created": "2024-11-12T09:41:07Z"
}
SDKs

Официальные библиотеки для Node.js, Python и Go

Клиенты с авто-ретраями, тайпизацией и типизированными объектами. Установите пакет — и не думайте про подписи, кодировку и повторные попытки.

Node.js

npm i @cobalflow/node · версия 3.4.1. Полная поддержка TypeScript и async/await, строгие типы для всех объектов.

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

Python

pip install cobalflow · версия 2.1.0. Синхронный и асинхронный клиент, пейджинг и контекст-менеджеры для транзакций.

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

Go

go get github.com/cobalflow/cobalflow-go · версия v1.8.2. Нативные ошибки, канты для потоков выгрузок и безвнешние зависимости.

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

Статусы транзакций в реальном времени

Подписывайтесь на события и получайте мгновенные уведомления о смене статуса платежа. Каждый вебхук защищён подписью X-Cobalflow-Signature, которую легко проверить.

События

payout.succeeded, payout.failed, charge.refunded. Отправляем до 5 попыток с экспоненциальной задержкой до 24 часов.

Справочник событий

Проверка подписи

Сверьте HMAC-SHA256 из заголовка X-Cobalflow-Signature с телом запроса. Секрет вебхука хранится в панели и не передаётся в код.

Пример проверки

Доставка и повтор

Ответьте 2xx в течение 10 секунд, иначе событие повторится. Дашборд показывает историю попыток и позволяет отправить событие повторно.

Мониторинг доставки
Подписки

Управляйте вебхуками через API

Создавайте, редактируйте и отключайте подписки программно. Методы работают одинаково в песочнице и в продакшене.

bash · curlPOST /v1/webhooks
curl -X POST https://api.cobalflow.ru/v1/webhooks \
  -H "Authorization: Bearer sk_test_51Kx9a2BcD3eF4g" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://ваш-сервер.рф/hooks/cobalflow",
    "events": ["payout.succeeded", "charge.refunded"]
  }'
ОтветHTTP 201 · 36 мс
{
  "id": "wh_4d91c0aa",
  "object": "webhook_endpoint",
  "url": "https://ваш-сервер.рф/hooks/cobalflow",
  "events": ["payout.succeeded", "charge.refunded"],
  "secret": "whsec_aB3x9QzT7vLmN4p"
}

Проведите первый платёж в песочнице

Бесплатный доступ, тестовые ключи и поддержка на связи. Откройте справочник, выберите SDK и запустите первый запрос ещё до конца дня.

Вопросы

Что спрашивают разработчики

Модели объектов, коды ответов и структура вебхуков полностью совпадают. Разница только в том, что в песочнице деньги не списываются, а лимиты и баланс изолированы.

Официальные библиотеки доступны для Node.js, Python и Go. Для остальных языков работает стандартный REST API и готовые примеры на curl.