Платежи и выплаты/Payment API

Payment API

Создание и управление крипто-платежами через Payment API 2328.io.

Payment API позволяет создавать платёжные сессии, перенаправлять клиентов на хостед-чекаут и отслеживать статус платежа.

Создать платёж

Создаёт платёжную сессию и возвращает URL для оплаты клиентом.

Параметры запроса

Поле	Тип	Обязательное	Описание
`amount`	decimal	да	Сумма платежа в указанной валюте, например `100.00`
`currency`	string	да	Фиатная валюта (USD, EUR, RUB, …) или криптовалюта (USDT, TRX, BTC, …)
`order_id`	string	да	Ваш ID заказа, например `ORDER-12345` (до 128 символов)
`to_currency`	string	нет	Заранее выбранная криптовалюта
`network`	string	нет*	Код сети (обязателен, если задан `to_currency` или `currency` — криптовалюта)
`url_return`	string	нет	URL для редиректа после оплаты, например `https://your-site.com/return`
`url_success`	string	нет	Альтернатива `url_return`
`url_callback`	string	нет	URL для webhook-уведомлений, например `https://your-site.com/webhook`
`invite_code`	string	нет	Реферальный код
`fee_split`	decimal	нет	Доля комиссии мерчанта, перекладываемая на плательщика, 0–100 (%). 0 = мерчант платит полностью, 100 = плательщик платит полностью. Переопределяет настройку проекта. Пример: `30` (плательщик покрывает 30% комиссии).
`price_markup`	decimal	нет	Наценка или скидка к сумме счёта, от −99 до 100 (%). Переопределяет настройку проекта. Пример: `5` (+5%) или `-10` (скидка 10%).
`description`	string	нет	Опциональное описание счёта (до 200 символов). Отображается плательщику на странице оплаты. Пример: `Premium plan — Order #12345`.
`ttl_seconds`	int	нет	Время жизни счёта в секундах, от `300` (5 минут) до `86400` (24 часов). По истечении этого времени счёт истекает и оплатить его больше нельзя. По умолчанию: `3600` (1 час). Пример: `3600`.

Ответ

JSON

{
  "state": 0,
  "result": {
    "uuid": "abc123-def456-...",
    "order_id": "ORDER-12345",
    "amount": "100.00",
    "currency": "USD",
    "amount_usd": "100.00",
    "exchange_rate": null,
    "url": "https://2328.io/pay/abc123-def456-...",
    "tg_deeplink": "https://t.me/my2328bot?start=pay_abc123-def456-...",
    "expires_at": "2026-01-11T21:00:00Z",
    "created_at": "2026-01-11T20:00:00Z",
    "payer_currency": "USDT",
    "payer_amount": "100.50",
    "network": "TRX-TRC20",
    "address": "TXYZabc123...",
    "payment_status": "check",
    "txid": null,
    "payment_amount": null,
    "qr": "data:image/png;base64,iVBORw0..."
  }
}

Перенаправьте клиента на result.url, чтобы он завершил оплату.
tg_deeplink — диплинк Telegram-бота для оплаты через Telegram MiniApp.
qr — QR-код адреса депозита в формате data URI (Base64). Присутствует, когда адрес уже назначен (когда network задан вместе с to_currency или когда currency — криптовалюта); иначе null.
txid, payment_amount — null, пока клиент не оплатит. Заполняются, как только транзакция обнаружена в блокчейне. Об этом сигнализирует webhook со статусом payment_status: paid.
exchange_rate — null, если конвертация ещё не применима (например, курс фиат → крипто пока не зафиксирован). Заполняется, когда выбрана валюта плательщика.

Credentials

Project UUIDAPI key

RequestPOST/v1/payment

curl -X POST https://api.2328.io/api/v1/payment \
  -H "Content-Type: application/json" \
  -H "User-Agent: MyShop/1.0 (+https://myshop.example)" \
  -H "project: YOUR_PROJECT_UUID" \
  -H "sign: YOUR_HMAC_SIGNATURE"

Response

Click Try it to see the response here.

Информация о платеже

Получение текущего статуса платежа по uuid или order_id.

Параметры запроса

Поле	Тип	Обязательное	Описание	Значения
`uuid`	string	да*	UUID платежа (из `result.uuid` при создании)
`order_id`	string	да*	Ваш ID заказа

Хотя бы одно из полей uuid или order_id обязательно.

RequestPOST/v1/payment/info

curl -X POST https://api.2328.io/api/v1/payment/info \
  -H "Content-Type: application/json" \
  -H "User-Agent: MyShop/1.0 (+https://myshop.example)" \
  -H "project: YOUR_PROJECT_UUID" \
  -H "sign: YOUR_HMAC_SIGNATURE"

Response

Click Try it to see the response here.

Список платежей

Получение списка всех платежей с фильтрацией и пагинацией.

Параметры запроса

Поле	Тип	Обязательное	Описание
`status`	string	нет	Фильтр по статусу платежа (см. References)
`date_from`	date	нет	Начальная дата (YYYY-MM-DD), например `2026-01-01`
`date_to`	date	нет	Конечная дата (YYYY-MM-DD), например `2026-01-31`
`page`	int	нет	Номер страницы, по умолчанию `1`
`per_page`	int	нет	Элементов на странице, по умолчанию `15`, максимум `5000`

RequestPOST/v1/payment/list

curl -X POST https://api.2328.io/api/v1/payment/list \
  -H "Content-Type: application/json" \
  -H "User-Agent: MyShop/1.0 (+https://myshop.example)" \
  -H "project: YOUR_PROJECT_UUID" \
  -H "sign: YOUR_HMAC_SIGNATURE"

Response

Click Try it to see the response here.