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

Transferno предоставляет REST MerchantAPI (OpenAPI 3.1) для приёма платежей, выплат и управления счетами. Полная спецификация и Swagger UI доступны по адресу https://transferno.tech/docs, OpenAPI-схема — https://transferno.tech/openapi.json. Все запросы выполняются по HTTPS с авторизацией по API-токену мерчанта, выданному в личном кабинете.

В личном кабинете на странице настроек мерчанта можно указать адрес для отправки вебхуков. Вебхуки отправляются POST-запросом с content-type application/json и всегда имеют структуру: { "event": "Название события", "data": JSON структура объекта }

Используемые заголовки запроса: • x-api-timestamp — время отправки вебхука в миллисекундах (UTC); • x-api-signature-sha256 — сигнатура данных вебхука. Формат строки для генерации сигнатуры: timestamp={timestamp}&event={event}&id={id}&status={status} В качестве ключа используется API-токен мерчанта (HMAC-SHA256).

В заголовке x-api-signature передаётся HMAC-SHA256 от сериализованного JSON-тела запроса (sort_keys=True, без отступов, без экранирования не-ASCII символов), ключ — API-токен мерчанта. Версия 1 устарела и будет удалена после завершения переходного периода — используйте версию 2.

Поддерживаются 4 события: • deposit.created — создан счёт на приём; • deposit.updated — счёт на приём обновлён; • payout.created — создана заявка на выплату; • payout.updated — заявка на выплату обновлена. Для событий приёма в data передаётся объект Invoice, для выплат — объект Payout.

−11 — открыт диспут −10 — истёк срок оплаты −1 — счёт отменён 0 — счёт создан 1 — клиент нажал «счёт оплачен» 2 — счёт частично оплачен 10 — счёт оплачен

−11 — открыт диспут −10 — заявка отменена 0 — заявка в обработке 10 — средства отправлены

Инструменты: • GET /api/tools_in — список доступных инструментов на приём; • GET /api/tools_out — список доступных инструментов на вывод. Аккаунт: • GET /api/me — информация об аккаунте. Транзакции: • GET /api/transactions — список транзакций. Счета (Invoices): • GET /api/invoices — список всех счетов; • GET /api/invoice/{invoice_id} — счёт по id; • GET /api/invoice/custom_id/{custom_id} — счёт по custom_id; • POST /api/invoice — выставить счёт; • POST /api/invoice/edit/amount — изменить сумму счёта; • POST /api/invoice/edit/status — изменить статус счёта на «клиент нажал я оплатил»; • POST /api/invoice/cancel/{invoice_id} — отменить выставленный счёт; • POST /api/invoices/card_charge — списание с карты; • POST /api/invoice/upload/proof — загрузить чек. Выплаты (Payouts): • GET /api/payouts — список всех выплат; • GET /api/payout/{payout_id} — выплата по id; • GET /api/payout/custom_id/{custom_id} — выплата по custom_id; • POST /api/payout — создание выплаты. Коды ошибок: • GET /api/list — список кодов ошибок. Диспуты: • POST /api/dispute — создание диспута. Полный список методов, схем (Invoice, Payout, Merchant, Dispute и др.) и интерактивный Swagger UI — на https://transferno.tech/docs.