# Payment API

> Maak en beheer crypto-betalingssessies met de Payment API van 2328.io.

Met de Payment API kun je betalingssessies aanmaken, klanten doorverwijzen naar een gehoste checkout en de status van betalingen volgen.

## Betaling aanmaken

<TwoCol>

Maakt een betalingssessie aan en geeft een URL terug waarmee de klant kan betalen.

### Verzoekparameters

| Veld | Type | Vereist | Beschrijving | Waarden |
|------|------|---------|--------------|---------|
| `amount` | decimal | ja | Betalingsbedrag in de valuta, bijv. `100.00` | <InputValue name="amount" type="decimal" example="100.00" /> |
| `currency` | string | ja | Fiatvaluta (USD, EUR, RUB, …) of cryptovaluta (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 | Je order-ID, bijv. `ORDER-12345` (max. 128 tekens) | <InputValue name="order_id" example="ORDER-12345" /> |
| `to_currency` | string | nee | Vooraf geselecteerde cryptovaluta | <EnumValues name="to_currency" values="USDT,USDC,BTC,ETH,TON,SOL,TRX,BNB,MATIC,XMR" optional /> |
| `network` | string | nee\* | Netwerkcode (verplicht als `to_currency` is ingesteld of als `currency` een cryptovaluta is) | <EnumValues name="network" values="TRX-TRC20,ETH-ERC20,BSC-BEP20,TON,SOL,BTC,MATIC,XMR" optional /> |
| `url_return` | string | nee | Redirect-URL na betaling, bijv. `https://your-site.com/return` | <InputValue name="url_return" placeholder="https://your-site.com/return" /> |
| `url_success` | string | nee | Alternatief voor `url_return` | <InputValue name="url_success" placeholder="https://your-site.com/success" /> |
| `url_callback` | string | nee | URL voor webhook-meldingen, bijv. `https://your-site.com/webhook` | <InputValue name="url_callback" example="https://your-site.com/webhook" /> |
| `invite_code` | string | nee | Verwijzerscode | <InputValue name="invite_code" placeholder="ref_xyz" /> |
| `fee_split` | decimal | nee | Aandeel van de merchantfee dat aan de betaler wordt doorberekend, 0–100 (%). 0 = merchant betaalt volledig, 100 = betaler betaalt volledig. Overschrijft de project-instelling. **Voorbeeld: `30`** (betaler dekt 30% van de fee). | <InputValue name="fee_split" type="decimal" placeholder="30" /> |
| `price_markup` | decimal | nee | Toeslag of korting op het factuurbedrag, −99 tot 100 (%). Overschrijft de project-instelling. **Voorbeeld: `5`** (+5%) of `-10` (10% korting). | <InputValue name="price_markup" type="decimal" placeholder="5" /> |
| `description` | string | nee | Optionele factuurbeschrijving (max. 200 tekens). Wordt op de betaalpagina aan de betaler getoond. **Voorbeeld: `Premium plan — Order #12345`**. | <InputValue name="description" placeholder="Premium plan — Order #12345" /> |
| `ttl_seconds` | int | nee | Levensduur van de factuur in seconden, van `300` (5 minuten) tot `86400` (24 uur). Daarna vervalt de factuur en kan deze niet meer worden betaald. Standaard: `3600` (1 uur). **Voorbeeld: `3600`**. | <InputValue name="ttl_seconds" type="integer" placeholder="3600" /> |

### Response

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

- Verwijs de klant door naar `result.url` om de betaling te voltooien.
- `tg_deeplink` — Telegram-bot-deeplink voor betaling via de Telegram MiniApp.
- `qr` — base64-gecodeerde QR-code (data URI) van het stortingsadres. Aanwezig wanneer er al een adres is toegewezen (wanneer `network` samen met `to_currency` is ingesteld, of wanneer `currency` een cryptovaluta is); anders `null`.
- `txid`, `payment_amount` — `null` totdat de klant betaalt. Worden ingevuld zodra de transactie on-chain is gedetecteerd. Luister naar de `payment_status: paid`-webhook om te weten wanneer.
- `exchange_rate` — `null` als conversie nog niet van toepassing is (bijv. wisselkoers fiat → crypto is nog niet vastgelegd). Wordt ingevuld zodra een betalersvaluta is gekozen.

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

## Betalingsinformatie

<TwoCol>

Haal de huidige betalingsstatus op met `uuid` of `order_id`.

### Verzoekparameters

| Veld | Type | Vereist | Beschrijving | Waarden |
|------|------|---------|--------------|---------|
| `uuid` | string | ja\* | Payment UUID (uit `result.uuid` bij aanmaken) | <InputValue name="uuid" example="abc123-def456-..." /> |
| `order_id` | string | ja\* | Je order-ID | <InputValue name="order_id" placeholder="ORDER-12345" /> |

> **INFO:** Ten minste één van `uuid` of `order_id` is vereist.

<TwoColAside>

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

</TwoColAside>

</TwoCol>

## Betalingenlijst

<TwoCol>

Haal een lijst van alle betalingen op met filtering en paginering.

### Verzoekparameters

| Veld | Type | Vereist | Beschrijving | Waarden |
|------|------|---------|--------------|---------|
| `status` | string | nee | Filteren op betalingsstatus (zie [References](/docs/references)) | <EnumValues name="status" values="pending,check,paid,underpaid_check,underpaid,overpaid,cancel,aml_lock" optional /> |
| `date_from` | date | nee | Begindatum (YYYY-MM-DD), bijv. `2026-01-01` | <InputValue name="date_from" example="2026-01-01" /> |
| `date_to` | date | nee | Einddatum (YYYY-MM-DD), bijv. `2026-01-31` | <InputValue name="date_to" example="2026-01-31" /> |
| `page` | int | nee | Paginanummer, standaard `1` | <InputValue name="page" type="integer" example="1" /> |
| `per_page` | int | nee | Items per pagina, standaard `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>