# API de pagamentos

> Crie e gerencie sessões de pagamento em criptomoedas com a API de pagamentos da 2328.io.

A API de pagamentos permite criar sessões de pagamento, redirecionar clientes para um checkout hospedado e acompanhar o status do pagamento.

## Criar pagamento

<TwoCol>

Cria uma sessão de pagamento e retorna uma URL para o cliente realizar o pagamento.

### Parâmetros da requisição

| Campo | Tipo | Obrigatório | Descrição | Valores |
|-------|------|-------------|-----------|---------|
| `amount` | decimal | sim | Valor do pagamento na moeda informada, ex.: `100.00` | <InputValue name="amount" type="decimal" example="100.00" /> |
| `currency` | string | sim | Moeda fiduciária (USD, EUR, RUB, …) ou criptomoeda (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 | sim | Seu ID de pedido, ex.: `ORDER-12345` (até 128 caracteres) | <InputValue name="order_id" example="ORDER-12345" /> |
| `to_currency` | string | não | Criptomoeda pré-selecionada | <EnumValues name="to_currency" values="USDT,USDC,BTC,ETH,TON,SOL,TRX,BNB,MATIC,XMR" optional /> |
| `network` | string | não\* | Código da rede (obrigatório quando `to_currency` está definido ou `currency` é uma criptomoeda) | <EnumValues name="network" values="TRX-TRC20,ETH-ERC20,BSC-BEP20,TON,SOL,BTC,MATIC,XMR" optional /> |
| `url_return` | string | não | URL de redirecionamento após o pagamento, ex.: `https://your-site.com/return` | <InputValue name="url_return" placeholder="https://your-site.com/return" /> |
| `url_success` | string | não | Alternativa a `url_return` | <InputValue name="url_success" placeholder="https://your-site.com/success" /> |
| `url_callback` | string | não | URL para notificações de webhook, ex.: `https://your-site.com/webhook` | <InputValue name="url_callback" example="https://your-site.com/webhook" /> |
| `invite_code` | string | não | Código do indicador | <InputValue name="invite_code" placeholder="ref_xyz" /> |
| `fee_split` | decimal | não | Parcela da taxa do comerciante repassada ao pagador, 0–100 (%). 0 = comerciante paga integralmente, 100 = pagador paga integralmente. Sobrescreve a configuração do projeto. **Exemplo: `30`** (pagador cobre 30% da taxa). | <InputValue name="fee_split" type="decimal" placeholder="30" /> |
| `price_markup` | decimal | não | Acréscimo ou desconto sobre o valor da fatura, −99 a 100 (%). Sobrescreve a configuração do projeto. **Exemplo: `5`** (+5%) ou `-10` (10% de desconto). | <InputValue name="price_markup" type="decimal" placeholder="5" /> |
| `description` | string | não | Descrição opcional da fatura (máx. 200 caracteres). Exibida ao pagador na página de pagamento. **Exemplo: `Premium plan — Order #12345`**. | <InputValue name="description" placeholder="Premium plan — Order #12345" /> |
| `ttl_seconds` | int | não | Tempo de vida da fatura em segundos, de `300` (5 minutos) a `86400` (24 horas). Após esse período a fatura expira e não pode mais ser paga. Padrão: `3600` (1 hora). **Exemplo: `3600`**. | <InputValue name="ttl_seconds" type="integer" placeholder="3600" /> |

### Resposta

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

- Redirecione o cliente para `result.url` para concluir o pagamento.
- `tg_deeplink` — deeplink do bot do Telegram para pagamento via Telegram MiniApp.
- `qr` — QR code (data URI) do endereço de depósito codificado em base64. Presente quando um endereço já foi atribuído (quando `network` é informado junto com `to_currency`, ou quando `currency` é uma criptomoeda); caso contrário, `null`.
- `txid`, `payment_amount` — `null` até que o cliente pague. Preenchidos assim que a transação é detectada on-chain. Escute o webhook `payment_status: paid` para saber quando.
- `exchange_rate` — `null` se a conversão ainda não se aplica (por exemplo, a taxa fiat → cripto ainda não foi travada). Preenchido assim que a moeda do pagador é definida.

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

## Informações do pagamento

<TwoCol>

Obtenha o status atual de um pagamento por `uuid` ou `order_id`.

### Parâmetros da requisição

| Campo | Tipo | Obrigatório | Descrição | Valores |
|-------|------|-------------|-----------|---------|
| `uuid` | string | sim\* | UUID do pagamento (de `result.uuid` na criação) | <InputValue name="uuid" example="abc123-def456-..." /> |
| `order_id` | string | sim\* | Seu ID de pedido | <InputValue name="order_id" placeholder="ORDER-12345" /> |

> **INFO:** Pelo menos um entre `uuid` e `order_id` é obrigatório.

<TwoColAside>

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

</TwoColAside>

</TwoCol>

## Lista de pagamentos

<TwoCol>

Obtenha uma lista de todos os pagamentos com filtros e paginação.

### Parâmetros da requisição

| Campo | Tipo | Obrigatório | Descrição | Valores |
|-------|------|-------------|-----------|---------|
| `status` | string | não | Filtrar por status do pagamento (veja [References](/docs/references)) | <EnumValues name="status" values="pending,check,paid,underpaid_check,underpaid,overpaid,cancel,aml_lock" optional /> |
| `date_from` | date | não | Data inicial (YYYY-MM-DD), ex.: `2026-01-01` | <InputValue name="date_from" example="2026-01-01" /> |
| `date_to` | date | não | Data final (YYYY-MM-DD), ex.: `2026-01-31` | <InputValue name="date_to" example="2026-01-31" /> |
| `page` | int | não | Número da página, padrão `1` | <InputValue name="page" type="integer" example="1" /> |
| `per_page` | int | não | Itens por página, padrão `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>