# Payment API

> Skapa och hantera betalningssessioner för kryptovalutor med 2328.io Payment API.

Payment API:et låter dig skapa betalningssessioner, omdirigera kunder till en värdbaserad kassa och spåra betalningsstatus.

## Skapa betalning

<TwoCol>

Skapar en betalningssession och returnerar en URL där kunden kan betala.

### Parametrar i förfrågan

| Fält | Typ | Obligatoriskt | Beskrivning | Värden |
|-------|------|----------|-------------|--------|
| `amount` | decimal | ja | Betalningsbelopp i den angivna valutan, t.ex. `100.00` | <InputValue name="amount" type="decimal" example="100.00" /> |
| `currency` | string | ja | Fiatvaluta (USD, EUR, RUB, …) eller kryptovaluta (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 | Ditt order-ID, t.ex. `ORDER-12345` (upp till 128 tecken) | <InputValue name="order_id" example="ORDER-12345" /> |
| `to_currency` | string | nej | Förvald kryptovaluta | <EnumValues name="to_currency" values="USDT,USDC,BTC,ETH,TON,SOL,TRX,BNB,MATIC,XMR" optional /> |
| `network` | string | nej\* | Nätverkskod (krävs om `to_currency` är satt eller `currency` är en kryptovaluta) | <EnumValues name="network" values="TRX-TRC20,ETH-ERC20,BSC-BEP20,TON,SOL,BTC,MATIC,XMR" optional /> |
| `url_return` | string | nej | URL att omdirigera till efter betalning, t.ex. `https://your-site.com/return` | <InputValue name="url_return" placeholder="https://your-site.com/return" /> |
| `url_success` | string | nej | Alternativ till `url_return` | <InputValue name="url_success" placeholder="https://your-site.com/success" /> |
| `url_callback` | string | nej | URL för webhook-notifieringar, t.ex. `https://your-site.com/webhook` | <InputValue name="url_callback" example="https://your-site.com/webhook" /> |
| `invite_code` | string | nej | Hänvisarkod | <InputValue name="invite_code" placeholder="ref_xyz" /> |
| `fee_split` | decimal | nej | Andel av handlaravgiften som skickas vidare till betalaren, 0–100 (%). 0 = handlaren betalar fullt ut, 100 = betalaren betalar fullt ut. Åsidosätter inställningen på projektnivå. **Exempel: `30`** (betalaren täcker 30 % av avgiften). | <InputValue name="fee_split" type="decimal" placeholder="30" /> |
| `price_markup` | decimal | nej | Påslag eller rabatt på fakturabeloppet, −99 till 100 (%). Åsidosätter inställningen på projektnivå. **Exempel: `5`** (+5 %) eller `-10` (10 % rabatt). | <InputValue name="price_markup" type="decimal" placeholder="5" /> |
| `description` | string | nej | Valfri fakturabeskrivning (max 200 tecken). Visas för betalaren på betalningssidan. **Exempel: `Premium plan — Order #12345`**. | <InputValue name="description" placeholder="Premium plan — Order #12345" /> |
| `ttl_seconds` | int | nej | Fakturans livslängd i sekunder, från `300` (5 minuter) till `86400` (24 timmar). Efter denna tid förfaller fakturan och kan inte längre betalas. Standard: `3600` (1 timme). **Exempel: `3600`**. | <InputValue name="ttl_seconds" type="integer" placeholder="3600" /> |

### Svar

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

- Omdirigera kunden till `result.url` för att slutföra betalningen.
- `tg_deeplink` — deeplink till Telegram-bot för betalning via Telegram MiniApp.
- `qr` — Base64-kodad QR-kod (data URI) för inbetalningsadressen. Finns när en adress redan tilldelats (när `network` är satt tillsammans med `to_currency`, eller när `currency` är en kryptovaluta); annars `null`.
- `txid`, `payment_amount` — `null` tills kunden betalar. Fylls i när transaktionen upptäcks on-chain. Lyssna på webhooken `payment_status: paid` för att veta när.
- `exchange_rate` — `null` om konvertering ännu inte är tillämplig (t.ex. om växelkursen fiat → krypto inte har låsts än). Fylls i när en betalningsvaluta valts.

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

## Betalningsinformation

<TwoCol>

Hämta aktuell betalningsstatus med `uuid` eller `order_id`.

### Parametrar i förfrågan

| Fält | Typ | Obligatoriskt | Beskrivning | Värden |
|-------|------|----------|-------------|--------|
| `uuid` | string | ja\* | Betalningens UUID (från `result.uuid` vid skapandet) | <InputValue name="uuid" example="abc123-def456-..." /> |
| `order_id` | string | ja\* | Ditt order-ID | <InputValue name="order_id" placeholder="ORDER-12345" /> |

> **INFO:** Minst en av `uuid` eller `order_id` är obligatorisk.

<TwoColAside>

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

</TwoColAside>

</TwoCol>

## Betalningslista

<TwoCol>

Hämta en lista över alla betalningar med filtrering och paginering.

### Parametrar i förfrågan

| Fält | Typ | Obligatoriskt | Beskrivning | Värden |
|-------|------|----------|-------------|--------|
| `status` | string | nej | Filtrera efter betalningsstatus (se [References](/docs/references)) | <EnumValues name="status" values="pending,check,paid,underpaid_check,underpaid,overpaid,cancel,aml_lock" optional /> |
| `date_from` | date | nej | Startdatum (YYYY-MM-DD), t.ex. `2026-01-01` | <InputValue name="date_from" example="2026-01-01" /> |
| `date_to` | date | nej | Slutdatum (YYYY-MM-DD), t.ex. `2026-01-31` | <InputValue name="date_to" example="2026-01-31" /> |
| `page` | int | nej | Sidnummer, standard `1` | <InputValue name="page" type="integer" example="1" /> |
| `per_page` | int | nej | Antal per sida, 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>