# Payment API

> Twórz sesje płatności kryptowalutowych i zarządzaj nimi za pomocą Payment API 2328.io.

Payment API umożliwia tworzenie sesji płatności, przekierowywanie klientów do hostowanego checkoutu oraz śledzenie statusu płatności.

## Utwórz płatność

<TwoCol>

Tworzy sesję płatności i zwraca URL, pod którym klient dokona zapłaty.

### Parametry żądania

| Pole | Typ | Wymagane | Opis | Wartości |
|------|-----|----------|------|----------|
| `amount` | decimal | tak | Kwota płatności w walucie, np. `100.00` | <InputValue name="amount" type="decimal" example="100.00" /> |
| `currency` | string | tak | Waluta fiat (USD, EUR, RUB, …) lub kryptowaluta (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 | tak | Twój identyfikator zamówienia, np. `ORDER-12345` (do 128 znaków) | <InputValue name="order_id" example="ORDER-12345" /> |
| `to_currency` | string | nie | Wstępnie wybrana kryptowaluta | <EnumValues name="to_currency" values="USDT,USDC,BTC,ETH,TON,SOL,TRX,BNB,MATIC,XMR" optional /> |
| `network` | string | nie\* | Kod sieci (wymagany, jeśli ustawione jest `to_currency` lub `currency` jest kryptowalutą) | <EnumValues name="network" values="TRX-TRC20,ETH-ERC20,BSC-BEP20,TON,SOL,BTC,MATIC,XMR" optional /> |
| `url_return` | string | nie | URL przekierowania po płatności, np. `https://your-site.com/return` | <InputValue name="url_return" placeholder="https://your-site.com/return" /> |
| `url_success` | string | nie | Alternatywa dla `url_return` | <InputValue name="url_success" placeholder="https://your-site.com/success" /> |
| `url_callback` | string | nie | URL powiadomień webhook, np. `https://your-site.com/webhook` | <InputValue name="url_callback" example="https://your-site.com/webhook" /> |
| `invite_code` | string | nie | Kod osoby polecającej | <InputValue name="invite_code" placeholder="ref_xyz" /> |
| `fee_split` | decimal | nie | Udział opłaty sprzedawcy przekazywany płacącemu, 0–100 (%). 0 = sprzedawca pokrywa w całości, 100 = płacący pokrywa w całości. Nadpisuje ustawienie projektowe. **Przykład: `30`** (płacący pokrywa 30% opłaty). | <InputValue name="fee_split" type="decimal" placeholder="30" /> |
| `price_markup` | decimal | nie | Narzut lub rabat na kwotę faktury, od −99 do 100 (%). Nadpisuje ustawienie projektowe. **Przykład: `5`** (+5%) lub `-10` (10% rabatu). | <InputValue name="price_markup" type="decimal" placeholder="5" /> |
| `description` | string | nie | Opcjonalny opis faktury (maks. 200 znaków). Wyświetlany płacącemu na stronie płatności. **Przykład: `Premium plan — Order #12345`**. | <InputValue name="description" placeholder="Premium plan — Order #12345" /> |
| `ttl_seconds` | int | nie | Czas życia faktury w sekundach, od `300` (5 minut) do `86400` (24 godzin). Po tym czasie faktura wygasa i nie można jej opłacić. Domyślnie: `3600` (1 godzina). **Przykład: `3600`**. | <InputValue name="ttl_seconds" type="integer" placeholder="3600" /> |

### Odpowiedź

```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..."
  }
}
```

- Aby dokończyć płatność, przekieruj klienta pod `result.url`.
- `tg_deeplink` — deeplink bota Telegram do płatności przez Telegram MiniApp.
- `qr` — kod QR (data URI) zakodowany w base64, prezentujący adres depozytowy. Obecny, gdy adres jest już przypisany (gdy `network` jest ustawione razem z `to_currency` lub gdy `currency` jest kryptowalutą); w przeciwnym razie `null`.
- `txid`, `payment_amount` — `null`, dopóki klient nie zapłaci. Wypełniane po wykryciu transakcji w sieci. Aby wiedzieć, kiedy to nastąpi, nasłuchuj webhooka `payment_status: paid`.
- `exchange_rate` — `null`, jeśli przeliczenie jeszcze nie ma zastosowania (np. kurs fiat → krypto nie został zablokowany). Wypełniane po wybraniu waluty płacącego.

<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>

## Informacje o płatności

<TwoCol>

Pobierz aktualny status płatności po `uuid` lub `order_id`.

### Parametry żądania

| Pole | Typ | Wymagane | Opis | Wartości |
|------|-----|----------|------|----------|
| `uuid` | string | tak\* | UUID płatności (z pola `result.uuid` przy tworzeniu) | <InputValue name="uuid" example="abc123-def456-..." /> |
| `order_id` | string | tak\* | Twój identyfikator zamówienia | <InputValue name="order_id" placeholder="ORDER-12345" /> |

> **INFO:** Wymagany jest co najmniej jeden z parametrów `uuid` lub `order_id`.

<TwoColAside>

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

</TwoColAside>

</TwoCol>

## Lista płatności

<TwoCol>

Pobierz listę wszystkich płatności z możliwością filtrowania i paginacji.

### Parametry żądania

| Pole | Typ | Wymagane | Opis | Wartości |
|------|-----|----------|------|----------|
| `status` | string | nie | Filtruj według statusu płatności (zobacz [References](/docs/references)) | <EnumValues name="status" values="pending,check,paid,underpaid_check,underpaid,overpaid,cancel,aml_lock" optional /> |
| `date_from` | date | nie | Data początkowa (YYYY-MM-DD), np. `2026-01-01` | <InputValue name="date_from" example="2026-01-01" /> |
| `date_to` | date | nie | Data końcowa (YYYY-MM-DD), np. `2026-01-31` | <InputValue name="date_to" example="2026-01-31" /> |
| `page` | int | nie | Numer strony, domyślnie `1` | <InputValue name="page" type="integer" example="1" /> |
| `per_page` | int | nie | Liczba elementów na stronę, domyślnie `15`, maks. `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>