# Payment API

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

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

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

<TwoCol>

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

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

| Поле | Тип | Обязательное | Описание | Значения |
|-------|------|----------|-------------|--------|
| `amount` | decimal | да | Сумма платежа в указанной валюте, например `100.00` | <InputValue name="amount" type="decimal" example="100.00" /> |
| `currency` | string | да | Фиатная валюта (USD, EUR, RUB, …) или криптовалюта (USDT, TRX, BTC, …) | <EnumValues name="currency" values="USD,EUR,RUB,KZT,UAH,UZS,USDT,USDC,BTC,ETH,TON,SOL,TRX,BNB,MATIC,XMR" /> |
| `order_id` | string | да | Ваш ID заказа, например `ORDER-12345` (до 128 символов) | <InputValue name="order_id" example="ORDER-12345" /> |
| `to_currency` | string | нет | Заранее выбранная криптовалюта | <EnumValues name="to_currency" values="USDT,USDC,BTC,ETH,TON,SOL,TRX,BNB,MATIC,XMR" optional /> |
| `network` | string | нет\* | Код сети (обязателен, если задан `to_currency` или `currency` — криптовалюта) | <EnumValues name="network" values="TRX-TRC20,ETH-ERC20,BSC-BEP20,TON,SOL,BTC,MATIC,XMR" optional /> |
| `url_return` | string | нет | URL для редиректа после оплаты, например `https://your-site.com/return` | <InputValue name="url_return" placeholder="https://your-site.com/return" /> |
| `url_success` | string | нет | Альтернатива `url_return` | <InputValue name="url_success" placeholder="https://your-site.com/success" /> |
| `url_callback` | string | нет | URL для webhook-уведомлений, например `https://your-site.com/webhook` | <InputValue name="url_callback" example="https://your-site.com/webhook" /> |
| `invite_code` | string | нет | Реферальный код | <InputValue name="invite_code" placeholder="ref_xyz" /> |
| `fee_split` | decimal | нет | Доля комиссии мерчанта, перекладываемая на плательщика, 0–100 (%). 0 = мерчант платит полностью, 100 = плательщик платит полностью. Переопределяет настройку проекта. **Пример: `30`** (плательщик покрывает 30% комиссии). | <InputValue name="fee_split" type="decimal" placeholder="30" /> |
| `price_markup` | decimal | нет | Наценка или скидка к сумме счёта, от −99 до 100 (%). Переопределяет настройку проекта. **Пример: `5`** (+5%) или `-10` (скидка 10%). | <InputValue name="price_markup" type="decimal" placeholder="5" /> |
| `description` | string | нет | Опциональное описание счёта (до 200 символов). Отображается плательщику на странице оплаты. **Пример: `Premium plan — Order #12345`**. | <InputValue name="description" placeholder="Premium plan — Order #12345" /> |
| `ttl_seconds` | int | нет | Время жизни счёта в секундах, от `300` (5 минут) до `86400` (24 часов). По истечении этого времени счёт истекает и оплатить его больше нельзя. По умолчанию: `3600` (1 час). **Пример: `3600`**. | <InputValue name="ttl_seconds" type="integer" placeholder="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`, если конвертация ещё не применима (например, курс фиат → крипто пока не зафиксирован). Заполняется, когда выбрана валюта плательщика.

<TwoColAside>

<Credentials />

<TryIt endpoint="POST /v1/payment">
  <Param name="amount" type="decimal" required />
  <Param name="currency" type="enum" required values="USD,EUR,RUB,KZT,UAH,UZS,USDT,USDC,BTC,ETH,TON,SOL,TRX,BNB,MATIC,XMR" />
  <Param name="order_id" type="string" required />
  <Param name="to_currency" type="enum" values="USDT,USDC,BTC,ETH,TON,SOL,TRX,BNB,MATIC,XMR" />
  <Param name="network" type="enum" values="TRX-TRC20,ETH-ERC20,BSC-BEP20,TON,SOL,BTC,MATIC,XMR" />
  <Param name="url_return" type="string" />
  <Param name="url_success" type="string" />
  <Param name="url_callback" type="string" />
  <Param name="invite_code" type="string" />
  <Param name="fee_split" type="decimal" />
  <Param name="price_markup" type="decimal" />
  <Param name="description" type="string" />
  <Param name="ttl_seconds" type="integer" />
</TryIt>

</TwoColAside>

</TwoCol>

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

<TwoCol>

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

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

| Поле | Тип | Обязательное | Описание | Значения |
|-------|------|----------|-------------|--------|
| `uuid` | string | да\* | UUID платежа (из `result.uuid` при создании) | <InputValue name="uuid" example="abc123-def456-..." /> |
| `order_id` | string | да\* | Ваш ID заказа | <InputValue name="order_id" placeholder="ORDER-12345" /> |

> **INFO:** Хотя бы одно из полей `uuid` или `order_id` обязательно.

<TwoColAside>

<TryIt endpoint="POST /v1/payment/info">
  <Param name="uuid" type="string" />
  <Param name="order_id" type="string" />
</TryIt>

</TwoColAside>

</TwoCol>

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

<TwoCol>

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

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

| Поле | Тип | Обязательное | Описание | Значения |
|-------|------|----------|-------------|--------|
| `status` | string | нет | Фильтр по статусу платежа (см. [References](/docs/references)) | <EnumValues name="status" values="pending,check,paid,underpaid_check,underpaid,overpaid,cancel,aml_lock" optional /> |
| `date_from` | date | нет | Начальная дата (YYYY-MM-DD), например `2026-01-01` | <InputValue name="date_from" example="2026-01-01" /> |
| `date_to` | date | нет | Конечная дата (YYYY-MM-DD), например `2026-01-31` | <InputValue name="date_to" example="2026-01-31" /> |
| `page` | int | нет | Номер страницы, по умолчанию `1` | <InputValue name="page" type="integer" example="1" /> |
| `per_page` | int | нет | Элементов на странице, по умолчанию `15`, максимум `5000` | <InputValue name="per_page" type="integer" example="15" /> |

<TwoColAside>

<TryIt endpoint="POST /v1/payment/list">
  <Param name="status" type="enum" values="pending,check,paid,underpaid_check,underpaid,overpaid,cancel,aml_lock" />
  <Param name="date_from" type="string" />
  <Param name="date_to" type="string" />
  <Param name="page" type="integer" />
  <Param name="per_page" type="integer" />
</TryIt>

</TwoColAside>

</TwoCol>