# Payment API

> Створюйте та керуйте сесіями криптовалютних платежів за допомогою Payment API від 2328.io.

Payment API дозволяє створювати платіжні сесії, перенаправляти клієнтів на хостинговий checkout та відстежувати статус платежу.

## Створити платіж

<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` — deeplink Telegram-бота для оплати через Telegram MiniApp.
- `qr` — QR-код депозитної адреси, закодований у base64 (data URI). Присутній, коли адресу вже призначено (коли `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>