> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clearpago.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ClearPago — API Pix

> Documentação oficial da API Pix ClearPago. Integre recebimento, envio, devoluções e webhooks em minutos.

<CardGroup cols={2}>
  <Card title="Quickstart" icon="bolt" href="/getting-started/quickstart">
    Faça sua primeira chamada em menos de 10 minutos.
  </Card>

  <Card title="Autenticação" icon="key" href="/getting-started/authentication">
    Gere e configure seu token Bearer.
  </Card>

  <Card title="Receber Pix (Cash-in)" icon="arrow-down-to-line" href="/guides/receive-pix-cash-in">
    Cobranças com QR Code EMV e notificação de pagamento.
  </Card>

  <Card title="Enviar Pix (Cash-out)" icon="arrow-up-from-line" href="/guides/send-pix-cash-out-key">
    Transferências por chave Pix ou string EMV.
  </Card>

  <Card title="Webhooks" icon="bell" href="/webhooks/clearpago-to-merchant">
    Receba notificações assinadas para cada evento.
  </Card>

  <Card title="Referência da API" icon="code" href="/api-reference/create-cash-in">
    Contratos completos de todos os endpoints.
  </Card>
</CardGroup>

## O que é a ClearPago

A **ClearPago** é a camada de integração Pix entre o seu sistema e o parceiro bancário (BaaS). Você consome apenas a **API REST** e implementa um **endpoint de notificação HTTP**; toda a orquestração com a instituição financeira fica encapsulada na plataforma.

**Base URL (produção):** `https://api.clearpago.com.br`

## O que você pode integrar

<CardGroup cols={2}>
  <Card title="Cobranças Pix" icon="qrcode">
    Gere cobranças com **QR Code EMV** e acompanhe o pagamento em tempo real via webhook.
  </Card>

  <Card title="Envio Pix" icon="paper-plane">
    Envie Pix por **chave** (CPF, CNPJ, e-mail, telefone, EVP) ou **pix copia e cola** (string EMV).
  </Card>

  <Card title="Devoluções" icon="rotate-left">
    Devolva recebimentos parcial ou totalmente em até **89 dias**, com rastreio completo.
  </Card>

  <Card title="Webhooks assinados" icon="shield-check">
    Receba notificações **ECDSA P-256** de cada evento: `pix_cash_in`, `pix_cash_out`, `pix_cash_in_reversal`, `pix_cash_out_reversal`.
  </Card>

  <Card title="Ledger" icon="book-open">
    Consulte lançamentos de crédito e débito por operação confirmada.
  </Card>

  <Card title="Reconciliação" icon="arrows-rotate">
    Resolva estados ambíguos com consulta autoritativa ao parceiro BaaS.
  </Card>
</CardGroup>

## Fluxo de integração

O modelo é **assíncrono**: a criação de recursos responde rapidamente com estado inicial; o estado final chega via **webhook** e, quando necessário, via **reconciliação** automática.

```mermaid theme={null}
flowchart LR
  subgraph seu_sistema[Seu sistema]
    CLI[Cliente HTTP]
    WH_OUT[Endpoint de webhook]
  end
  subgraph clearpago[ClearPago]
    REST[API REST]
    WH_IN[Webhooks de entrada]
    Q[Filas]
    W[Workers / Reconciliação]
    DB[(Ledger)]
    OUT[Outbox de notificações]
  end
  subgraph baas[Parceiro BaaS]
    PIX[Pix]
  end
  CLI --> REST
  REST --> PIX
  PIX --> WH_IN
  WH_IN --> Q
  Q --> W
  W --> DB
  W --> OUT
  OUT --> WH_OUT
```

## Para quem é esta documentação

| Perfil         | Foco principal                                                             |
| -------------- | -------------------------------------------------------------------------- |
| **Engenharia** | Contratos, headers, idempotência, assinaturas, ciclo de vida, erros.       |
| **Produto**    | O que considerar "pago" e "confirmado", prazos regulatórios, devoluções.   |
| **Operações**  | Estados não terminais, reconciliação, monitoramento, suporte a incidentes. |

## Próximos passos

<Steps>
  <Step title="Autentique-se">
    Gere seu token em [Autenticação](/getting-started/authentication) e configure o header `Authorization: Bearer`.
  </Step>

  <Step title="Siga o Quickstart">
    Crie um cash-in, receba o webhook e consulte o status em [Quickstart](/getting-started/quickstart).
  </Step>

  <Step title="Entenda os conceitos">
    Leia [Arquitetura](/core-concepts/architecture), [Ciclo de vida](/core-concepts/transaction-lifecycle) e [Modelo de status](/core-concepts/status-model) antes de ir para produção.
  </Step>

  <Step title="Configure webhooks">
    Registre sua URL e implemente a verificação de assinatura em [Webhooks](/webhooks/clearpago-to-merchant).
  </Step>

  <Step title="Valide com o checklist">
    Revise o [Checklist de primeira integração](/getting-started/first-integration-checklist) e o [Checklist de produção](/go-live/production-checklist).
  </Step>
</Steps>