# Referências

> Códigos de rede, mapeamentos moeda-rede e valores de status de pagamento usados em toda a API da 2328.io.

Esta página lista todos os valores de referência utilizados nas requisições e respostas da API.

## Códigos de rede

Estes códigos são utilizados sempre que houver um campo `network`:

| Código | Rede |
|--------|------|
| `TRX-TRC20` | Tron TRC-20 |
| `BSC-BEP20` | BNB Smart Chain |
| `ETH-ERC20` | Ethereum (ERC-20) |
| `AVAX-C` | Avalanche C-Chain |
| `POL-MATIC` | Polygon (Matic) |
| `TON` | TON |
| `BTC` | Bitcoin |
| `LTC` | Litecoin |
| `DASH` | Dash |
| `SOL` | Solana |
| `DOGE` | Dogecoin |

## Mapeamento moeda-rede

Cada moeda está disponível apenas em um subconjunto de redes. Use esta tabela para escolher uma combinação válida:

| Moeda | Redes permitidas |
|-------|------------------|
| `USDT` | TRX-TRC20, BSC-BEP20, ETH-ERC20, AVAX-C, POL-MATIC, TON, SOL |
| `USDC` | BSC-BEP20, ETH-ERC20, AVAX-C, POL-MATIC, SOL |
| `BTC` | BTC |
| `ETH` | ETH-ERC20 |
| `BNB` | BSC-BEP20 |
| `TRX` | TRX-TRC20 |
| `LTC` | LTC |
| `DASH` | DASH |
| `TON` | TON |
| `AVAX` | AVAX-C |
| `POL` | POL-MATIC |
| `SOL` | SOL |
| `DOGE` | DOGE |

## Status de pagamento

O campo `payment_status` em pagamentos e o filtro de `/v1/payment/list` aceita os seguintes valores:

| Status | Descrição |
|--------|-----------|
| `pending` | Criado, aguardando inicialização |
| `check` | Aguardando pagamento do cliente |
| `paid` | Pago com sucesso |
| `underpaid_check` | Pago a menor (pode ser complementado) |
| `underpaid` | Pago a menor |
| `overpaid` | Pago a maior (creditado) |
| `cancel` | Cancelado / expirado |
| `aml_lock` | Transação bloqueada por AML |

> **INFO:** Ao monitorar um pagamento bem-sucedido, você deve tratar tanto `paid` quanto `overpaid` como estados de sucesso e creditar o pedido do cliente.

## Status de saque

O campo `status` em `/v1/payout` e `/v1/payout/status/{uuid}` assume um destes valores:

| Status | Descrição |
|--------|-----------|
| `pending` | Criado, aguardando processamento |
| `completed` | Concluído com sucesso — `txid` está definido |
| `failed` | Erro de envio — veja `error_type` |
| `cancelled` | Cancelado |

## Tipos de erro de saque

Quando um saque tem `status = failed`, o campo `error_type` descreve o motivo:

| Código | Descrição |
|--------|-----------|
| `aml_risk` | Saque bloqueado pelas verificações de risco AML (endereço do destinatário sinalizado como de alto risco) |