# API de pagos

> Crea y gestiona sesiones de pago en criptomonedas con la API de pagos de 2328.io.

La API de pagos te permite crear sesiones de pago, redirigir a los clientes a un checkout alojado y hacer seguimiento del estado del pago.

## Crear pago

<TwoCol>

Crea una sesión de pago y devuelve una URL para que el cliente realice el pago.

### Parámetros de la solicitud

| Campo | Tipo | Requerido | Descripción | Valores |
|-------|------|-----------|-------------|---------|
| `amount` | decimal | sí | Monto del pago en la divisa indicada, p. ej. `100.00` | <InputValue name="amount" type="decimal" example="100.00" /> |
| `currency` | string | sí | Divisa fiat (USD, EUR, RUB, …) o criptomoneda (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 | sí | Tu ID de pedido, p. ej. `ORDER-12345` (hasta 128 caracteres) | <InputValue name="order_id" example="ORDER-12345" /> |
| `to_currency` | string | no | Criptomoneda preseleccionada | <EnumValues name="to_currency" values="USDT,USDC,BTC,ETH,TON,SOL,TRX,BNB,MATIC,XMR" optional /> |
| `network` | string | no\* | Código de red (obligatorio si `to_currency` está definido o si `currency` es una criptomoneda) | <EnumValues name="network" values="TRX-TRC20,ETH-ERC20,BSC-BEP20,TON,SOL,BTC,MATIC,XMR" optional /> |
| `url_return` | string | no | URL de redirección tras el pago, p. ej. `https://your-site.com/return` | <InputValue name="url_return" placeholder="https://your-site.com/return" /> |
| `url_success` | string | no | Alternativa a `url_return` | <InputValue name="url_success" placeholder="https://your-site.com/success" /> |
| `url_callback` | string | no | URL para las notificaciones de webhook, p. ej. `https://your-site.com/webhook` | <InputValue name="url_callback" example="https://your-site.com/webhook" /> |
| `invite_code` | string | no | Código de referido | <InputValue name="invite_code" placeholder="ref_xyz" /> |
| `fee_split` | decimal | no | Porcentaje de la comisión del comerciante que asume el pagador, 0–100 (%). 0 = el comerciante paga todo, 100 = el pagador paga todo. Sobrescribe el ajuste a nivel de proyecto. **Ejemplo: `30`** (el pagador cubre el 30 % de la comisión). | <InputValue name="fee_split" type="decimal" placeholder="30" /> |
| `price_markup` | decimal | no | Recargo o descuento sobre el monto facturado, de −99 a 100 (%). Sobrescribe el ajuste a nivel de proyecto. **Ejemplo: `5`** (+5 %) o `-10` (10 % de descuento). | <InputValue name="price_markup" type="decimal" placeholder="5" /> |
| `description` | string | no | Descripción opcional de la factura (máx. 200 caracteres). Se muestra al pagador en la página de pago. **Ejemplo: `Premium plan — Order #12345`**. | <InputValue name="description" placeholder="Premium plan — Order #12345" /> |
| `ttl_seconds` | int | no | Tiempo de vida de la factura en segundos, de `300` (5 minutos) a `86400` (24 horas). Pasado ese tiempo la factura caduca y ya no puede pagarse. Valor por defecto: `3600` (1 hora). **Ejemplo: `3600`**. | <InputValue name="ttl_seconds" type="integer" placeholder="3600" /> |

### Respuesta

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

- Redirige al cliente a `result.url` para completar el pago.
- `tg_deeplink` — deeplink del bot de Telegram para pagar a través de Telegram MiniApp.
- `qr` — código QR codificado en Base64 (data URI) de la dirección de depósito. Está presente cuando ya se ha asignado una dirección (cuando `network` se define junto con `to_currency`, o cuando `currency` es una criptomoneda); en caso contrario, es `null`.
- `txid`, `payment_amount` — son `null` hasta que el cliente paga. Se completan una vez que la transacción se detecta en la blockchain. Escucha el webhook con `payment_status: paid` para enterarte.
- `exchange_rate` — es `null` cuando la conversión aún no aplica (p. ej., aún no se ha fijado el tipo fiat → cripto). Se completa una vez que se elige una divisa de pago.

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

## Información del pago

<TwoCol>

Obtén el estado actual del pago mediante `uuid` u `order_id`.

### Parámetros de la solicitud

| Campo | Tipo | Requerido | Descripción | Valores |
|-------|------|-----------|-------------|---------|
| `uuid` | string | sí\* | UUID del pago (de `result.uuid` al crearlo) | <InputValue name="uuid" example="abc123-def456-..." /> |
| `order_id` | string | sí\* | Tu ID de pedido | <InputValue name="order_id" placeholder="ORDER-12345" /> |

> **INFO:** Se requiere al menos uno de `uuid` u `order_id`.

<TwoColAside>

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

</TwoColAside>

</TwoCol>

## Lista de pagos

<TwoCol>

Obtén una lista de todos los pagos con filtros y paginación.

### Parámetros de la solicitud

| Campo | Tipo | Requerido | Descripción | Valores |
|-------|------|-----------|-------------|---------|
| `status` | string | no | Filtrar por estado del pago (consulta [References](/docs/references)) | <EnumValues name="status" values="pending,check,paid,underpaid_check,underpaid,overpaid,cancel,aml_lock" optional /> |
| `date_from` | date | no | Fecha de inicio (YYYY-MM-DD), p. ej. `2026-01-01` | <InputValue name="date_from" example="2026-01-01" /> |
| `date_to` | date | no | Fecha de fin (YYYY-MM-DD), p. ej. `2026-01-31` | <InputValue name="date_to" example="2026-01-31" /> |
| `page` | int | no | Número de página, por defecto `1` | <InputValue name="page" type="integer" example="1" /> |
| `per_page` | int | no | Elementos por página, por defecto `15`, máximo `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>