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

# Introdução

> Documentação da API pague.dev

## Bem-vindo

A API pague.dev permite integrar o processamento de pagamentos em suas aplicações. Esta documentação cobre todos os endpoints disponíveis para gerenciar clientes, projetos, cobranças, transações e pagamentos PIX.

## URL Base

Todas as requisições devem ser feitas para:

```
https://api.pague.dev/v1
```

## Autenticação

Todos os endpoints requerem autenticação usando chaves de API. Inclua suas credenciais nos headers da requisição:

```json theme={null}
{
  "X-API-Key": "sua-api-key"
}
```

## Permissões

Cada chave de API possui permissões granulares que determinam quais endpoints ela pode acessar. As permissões são atribuídas no momento da criação da chave.

### Permissões disponíveis

| Permissão          | Descrição                                   |
| ------------------ | ------------------------------------------- |
| `FULL_ACCESS`      | Acesso completo a todos os endpoints da API |
| `PIX:WRITE`        | Criar cobranças PIX                         |
| `CUSTOMER:WRITE`   | Criar clientes                              |
| `CUSTOMER:READ`    | Listar e buscar clientes                    |
| `PROJECT:WRITE`    | Criar projetos                              |
| `PROJECT:READ`     | Listar e buscar projetos                    |
| `CHARGE:WRITE`     | Criar cobranças (links de pagamento)        |
| `CHARGE:READ`      | Listar e buscar cobranças                   |
| `TRANSACTION:READ` | Buscar transações                           |
| `WITHDRAWAL:WRITE` | Criar saques via PIX                        |
| `METRICS:READ`     | Obter métricas de receita                   |
| `ACCOUNT:READ`     | Visualizar dados da conta e saldo           |

<Note>
  A permissão `FULL_ACCESS` concede acesso a todos os endpoints, equivalente a possuir todas as permissões listadas acima.
</Note>

### Restrição por IP

Chaves com permissão `FULL_ACCESS` ou `WITHDRAWAL:WRITE` **exigem** a configuração de IPs permitidos. Requisições originadas de IPs não autorizados serão rejeitadas com erro `403 Forbidden`.

Essa restrição existe para proteger operações sensíveis como saques e acesso irrestrito à API.

## Recursos Disponíveis

<CardGroup cols={2}>
  <Card title="PIX" icon="qrcode" href="/api-reference/pix/create">
    Criar cobranças PIX
  </Card>

  <Card title="Webhooks" icon="bell" href="/api-reference/webhooks">
    Receber notificações de eventos
  </Card>

  <Card title="Clientes" icon="users" href="/api-reference/customers/create">
    Gerenciar seus clientes
  </Card>

  <Card title="Projetos" icon="folder" href="/api-reference/projects/create">
    Organizar pagamentos por projeto
  </Card>

  <Card title="Cobranças" icon="credit-card" href="/api-reference/charges/create">
    Criar e gerenciar cobranças
  </Card>

  <Card title="Transações" icon="receipt" href="/api-reference/transactions/get">
    Visualizar detalhes de transações
  </Card>

  <Card title="Conta" icon="building" href="/api-reference/account/get">
    Consultar dados da conta e saldo
  </Card>
</CardGroup>

## SDKs e Ferramentas

<CardGroup cols={2}>
  <Card title="SDK" icon="code" href="/sdk">
    SDKs oficiais para integração
  </Card>

  <Card title="Exemplo Completo" icon="code" href="https://github.com/pague-dev/sdk-example">
    Aplicação React com integração completa
  </Card>
</CardGroup>