> For the complete documentation index, see [llms.txt](https://docs.pagou.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pagou.com.br/introducao.md).

# Introdução

Entenda os recursos da API, a confirmação de pagamentos e os requisitos para integrar.

A API pública da Pagou conecta sua aplicação às operações de cobrança por Pix, boleto e cartão de crédito. Ela permite criar e consultar cobranças, acompanhar pagamentos e solicitar as alterações disponíveis para cada modalidade. O split divide valores entre contas Pagou autorizadas. A disponibilidade dos recursos depende da habilitação da conta.

As chamadas utilizam HTTP e JSON, conforme o contrato da operação. A `X-API-KEY` identifica a conta do **lojista**, responsável pela integração.

Esta documentação orienta desenvolvedores e agentes de IA sobre endpoints, campos, exemplos e regras de negócio. Escolha o fluxo na tabela e leia o contrato completo da operação antes de montar a requisição.

## Comece pelo seu objetivo

| Objetivo                        | Guia                                                                                         |
| ------------------------------- | -------------------------------------------------------------------------------------------- |
| Fazer a primeira chamada        | [Primeiros passos em Sandbox](/integracao-com-a-api/primeiros-passos.md)                     |
| Receber por Pix                 | [Meio de pagamento Pix](/integracao-com-a-api/meio-de-pagamento-pix.md)                      |
| Receber por boleto              | [Meio de pagamento boleto](/integracao-com-a-api/meio-de-pagamento-boleto.md)                |
| Receber por cartão              | [Cartão de crédito](/integracao-com-a-api/meio-de-pagamento-cartao-de-credito.md)            |
| Dividir valores                 | [Split de pagamento](/integracao-com-a-api/split-de-pagamento.md)                            |
| Confirmar um pagamento          | [Recebendo webhooks](/integracao-com-a-api/recebendo-webhooks.md)                            |
| Solicitar uma devolução Pix     | [Estornando um QR Code](/integracao-com-a-api/meio-de-pagamento-pix/estornando-um-qrcode.md) |
| Consultar o saldo               | [Consultando saldo](/integracao-com-a-api/consultando-saldo.md)                              |
| Desenvolver com um agente de IA | o índice público em `https://docs.pagou.com.br/llms.txt`                                     |

## O que é uma cobrança confirmada

Uma **cobrança** registra um valor a receber. A **confirmação do pagamento** é a evidência, no estado do recurso ou no evento correspondente, de que o pagamento foi reconhecido naquela modalidade.

O status HTTP informa o resultado da requisição. `201 Created` confirma a criação da cobrança, que pode continuar aguardando pagamento. Para acompanhar o resultado financeiro:

* **Pix e boleto:** use a consulta ou os webhooks documentados. Autentique a notificação e confira a identificação e o valor do pagamento.
* **Cartão de crédito:** diferencie `authorized` (autorização), `captured` (captura) e `settled` (liquidação registrada). Autorização, captura e liquidação são etapas distintas. Consulte os [estados da cobrança](/integracao-com-a-api/meio-de-pagamento-cartao-de-credito/consultando-e-listando-cobrancas.md).

Associe o ID da cobrança ao pedido da sua aplicação e aplique cada confirmação uma única vez. Uma solicitação de cancelamento ou estorno aceita também pode exigir acompanhamento até sua conclusão; confira o estado e o valor efetivamente confirmado.

## Antes de integrar

1. **Prepare o ambiente e a conta.** Comece em Sandbox, utilizando URL e chave do mesmo ambiente. Confira a habilitação dos recursos: cartão exige credenciamento; split exige aprovação, habilitação e recebedores autorizados.
2. **Configure a autenticação no backend.** Obtenha a chave em [Credenciais de acesso](/credenciais-de-acesso.md) e mantenha-a no mecanismo de segredos da aplicação. Veja [Primeiros passos em Sandbox](/integracao-com-a-api/primeiros-passos.md) para URLs, headers e formatos.
3. **Confira o contrato e a recuperação.** Leia campos obrigatórios, tipos, unidades, estados e erros. Pix e boleto usam `amount` em reais; cobranças de cartão usam `value` em centavos inteiros. Para webhooks, prepare HTTPS, validação da assinatura e deduplicação. Defina como investigar respostas inconclusivas antes de repetir uma operação financeira.
4. **Valide o fluxo em Sandbox.** Teste criação, consulta, confirmação, erros e duplicidade. Substitua os dados demonstrativos dos exemplos e siga o suporte à idempotência indicado para cada operação antes de usar produção.

**Para agentes de IA:** use o [índice da documentação](https://docs.pagou.com.br/llms.txt) para localizar o fluxo e leia suas páginas completas, disponíveis também com `.md` ao final da URL. Se faltar informação para decidir a próxima ação financeira, solicite esclarecimento em vez de inferir o contrato.