# Payment API

> Erstellen und verwalten Sie Kryptowährungs-Zahlungssitzungen mit der 2328.io Payment API.

Mit der Payment API können Sie Zahlungssitzungen erstellen, Kunden auf eine gehostete Checkout-Seite weiterleiten und den Zahlungsstatus verfolgen.

## Zahlung erstellen

<TwoCol>

Erstellt eine Zahlungssitzung und gibt eine URL zurück, unter der der Kunde bezahlen kann.

### Anfrageparameter

| Feld | Typ | Pflicht | Beschreibung | Werte |
|------|-----|---------|--------------|-------|
| `amount` | decimal | ja | Zahlungsbetrag in der Währung, z. B. `100.00` | <InputValue name="amount" type="decimal" example="100.00" /> |
| `currency` | string | ja | Fiat-Währung (USD, EUR, RUB, …) oder Kryptowährung (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 | ja | Ihre Bestell-ID, z. B. `ORDER-12345` (max. 128 Zeichen) | <InputValue name="order_id" example="ORDER-12345" /> |
| `to_currency` | string | nein | Vorausgewählte Kryptowährung | <EnumValues name="to_currency" values="USDT,USDC,BTC,ETH,TON,SOL,TRX,BNB,MATIC,XMR" optional /> |
| `network` | string | nein\* | Netzwerkcode (erforderlich, wenn `to_currency` gesetzt ist oder `currency` eine Kryptowährung ist) | <EnumValues name="network" values="TRX-TRC20,ETH-ERC20,BSC-BEP20,TON,SOL,BTC,MATIC,XMR" optional /> |
| `url_return` | string | nein | Weiterleitungs-URL nach der Zahlung, z. B. `https://your-site.com/return` | <InputValue name="url_return" placeholder="https://your-site.com/return" /> |
| `url_success` | string | nein | Alternative zu `url_return` | <InputValue name="url_success" placeholder="https://your-site.com/success" /> |
| `url_callback` | string | nein | URL für Webhook-Benachrichtigungen, z. B. `https://your-site.com/webhook` | <InputValue name="url_callback" example="https://your-site.com/webhook" /> |
| `invite_code` | string | nein | Empfehlungscode | <InputValue name="invite_code" placeholder="ref_xyz" /> |
| `fee_split` | decimal | nein | Anteil der Händlergebühr, der an den Zahler weitergegeben wird, 0–100 (%). 0 = der Händler trägt sie vollständig, 100 = der Zahler trägt sie vollständig. Überschreibt die Projekteinstellung. **Beispiel: `30`** (der Zahler übernimmt 30 % der Gebühr). | <InputValue name="fee_split" type="decimal" placeholder="30" /> |
| `price_markup` | decimal | nein | Aufschlag oder Rabatt auf den Rechnungsbetrag, −99 bis 100 (%). Überschreibt die Projekteinstellung. **Beispiel: `5`** (+5 %) oder `-10` (10 % Rabatt). | <InputValue name="price_markup" type="decimal" placeholder="5" /> |
| `description` | string | nein | Optionale Rechnungsbeschreibung (max. 200 Zeichen). Wird dem Zahler auf der Zahlungsseite angezeigt. **Beispiel: `Premium plan — Order #12345`**. | <InputValue name="description" placeholder="Premium plan — Order #12345" /> |
| `ttl_seconds` | int | nein | Gültigkeitsdauer der Rechnung in Sekunden, von `300` (5 Minuten) bis `86400` (24 Stunden). Nach Ablauf dieser Zeit verfällt die Rechnung und kann nicht mehr bezahlt werden. Standard: `3600` (1 Stunde). **Beispiel: `3600`**. | <InputValue name="ttl_seconds" type="integer" placeholder="3600" /> |

### Antwort

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

- Leiten Sie den Kunden zu `result.url` weiter, um die Zahlung abzuschließen.
- `tg_deeplink` — Telegram-Bot-Deeplink für die Zahlung über die Telegram MiniApp.
- `qr` — Base64-codierter QR-Code (Data-URI) der Einzahlungsadresse. Vorhanden, wenn bereits eine Adresse zugewiesen wurde (wenn `network` zusammen mit `to_currency` gesetzt ist oder wenn `currency` eine Kryptowährung ist); andernfalls `null`.
- `txid`, `payment_amount` — `null`, bis der Kunde bezahlt. Werden ausgefüllt, sobald die Transaktion on-chain erkannt wird. Lauschen Sie auf den Webhook `payment_status: paid`, um den Zeitpunkt zu erfahren.
- `exchange_rate` — `null`, falls eine Umrechnung noch nicht relevant ist (z. B. wenn der Fiat-zu-Krypto-Kurs noch nicht festgesetzt wurde). Wird gefüllt, sobald eine Zahler-Währung gewählt ist.

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

## Zahlungsinformationen

<TwoCol>

Aktuellen Zahlungsstatus per `uuid` oder `order_id` abrufen.

### Anfrageparameter

| Feld | Typ | Pflicht | Beschreibung | Werte |
|------|-----|---------|--------------|-------|
| `uuid` | string | ja\* | Zahlungs-UUID (aus `result.uuid` bei der Erstellung) | <InputValue name="uuid" example="abc123-def456-..." /> |
| `order_id` | string | ja\* | Ihre Bestell-ID | <InputValue name="order_id" placeholder="ORDER-12345" /> |

> **INFO:** Mindestens eines der Felder `uuid` oder `order_id` ist erforderlich.

<TwoColAside>

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

</TwoColAside>

</TwoCol>

## Zahlungsliste

<TwoCol>

Liste aller Zahlungen mit Filterung und Paginierung abrufen.

### Anfrageparameter

| Feld | Typ | Pflicht | Beschreibung | Werte |
|------|-----|---------|--------------|-------|
| `status` | string | nein | Nach Zahlungsstatus filtern (siehe [References](/docs/references)) | <EnumValues name="status" values="pending,check,paid,underpaid_check,underpaid,overpaid,cancel,aml_lock" optional /> |
| `date_from` | date | nein | Startdatum (YYYY-MM-DD), z. B. `2026-01-01` | <InputValue name="date_from" example="2026-01-01" /> |
| `date_to` | date | nein | Enddatum (YYYY-MM-DD), z. B. `2026-01-31` | <InputValue name="date_to" example="2026-01-31" /> |
| `page` | int | nein | Seitennummer, Standard `1` | <InputValue name="page" type="integer" example="1" /> |
| `per_page` | int | nein | Einträge pro Seite, Standard `15`, max. `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>