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

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

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

Основные разделы

Базовый URL
https://aeris-psp.net
Формат данных
application/json

API-ключи

Основной ключ создаётся вместе с проектом. В кабинете можно выпустить до четырёх дополнительных ключей. Там же задаются адрес для уведомлений, IP/CIDR серверов и HTTPS-домены виджета. Просмотр ключей и сохранение изменений подтверждаются через Telegram или приложение-аутентификатор.

Settings → API keys
Primary key + up to 4 additional keys

Settings → Webhook and access
Webhook URL → default notification endpoint
API IP → server addresses
Checkout origins → website domains

Авторизация

Каждый запрос подписывается HMAC-SHA256. Timestamp передаётся в Unix-секундах и действует в коротком временном окне. JSON сериализуйте компактно, без пробелов. Для GET используйте пустое тело.

body = compact_json(request_body)
message = body + ":" + unix_timestamp + "++"
signature = hex(hmac_sha256(base64(secret_key), message))

X-API-KEY: <public_key>
X-TIMESTAMP: <unix_seconds>
X-SIGNATURE: <signature>
Создать платёжСБП, SberPay и банковские карты
СБП

Оплата через СБП

Покупатель сканирует QR на компьютере или открывает банковское приложение на смартфоне.

Когда выбиратьОсновной checkout интернет-магазина, когда важны низкое трение и оплата без ввода карты.
  1. Ваш сайт
    Создаёт платёж

    Backend подписывает запрос и сохраняет id операции.

  2. Aeris
    Возвращает payment_url

    URL можно открыть напрямую или передать Payment page/Widget.

  3. Покупатель
    Выбирает банк

    Desktop: сканирует QR. Mobile: открывает приложение банка.

  4. Ваш сайт
    Получает финальный статус

    Заказ выдаётся только после completed из webhook/status API.

Платёжная форма Aeris

Desktop
Заказ 10001

Оплата заказа

9 000 ₽

Demo Store
Способ оплаты

Результат появится на этой странице

Mobile
Заказ 10001

Оплата заказа

9 000 ₽

Demo Store
Способ оплаты

Результат появится на этой странице

Создать выплатуБанковская карта в RUB и USDT в сети TRON
Банковская карта

Выплата на банковскую карту

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

Когда выбиратьВозвраты, вознаграждения и массовые выплаты физическим лицам в России.
  1. Ваш сайт
    Создаёт выплату

    Передаёт сумму, уникальный номер заказа и реквизиты получателя.

  2. Aeris
    Резервирует сумму

    С баланса резервируются выплата и комиссия. Повтор с тем же merchant_order_id не создаёт дубль.

  3. Платёжная сеть
    Обрабатывает перевод

    Первичный pending означает, что запрос принят, но ещё не завершён.

  4. Ваш сайт
    Получает результат

    completed списывает резерв окончательно; failed возвращает всю зарезервированную сумму.

availableсозданиеfrozencompleted → списано
failed → возвращено

Операции

Здесь только чтение общего состояния. Создание платежей и выплат описано в разделах конкретных методов выше.

PAYMENTS

Платежи

Получить одну операцию, реестр с фильтром или XLSX-выгрузку.

GET /api/v1/merchant/transactions/{transaction_id}
GET /api/v1/merchant/transactions?page_number=1&items_per_page=50&status=completed
GET /api/v1/merchant/transactions/export?status=completed
PAYOUTS

Выплаты

Получить одну выплату по локальному или внешнему ID либо список с фильтром по статусу.

GET /api/v1/merchant/payouts/{payout_id}
GET /api/v1/merchant/payouts?page_number=1&items_per_page=50
GET /api/v1/merchant/payouts?page_number=1&items_per_page=50&status=pending
PROJECT

Баланс и время

Проверить доступный и зарезервированный баланс либо синхронизировать timestamp для подписи.

GET /api/v1/merchant/balance
GET /api/v1/merchant/timestamp