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

> ## Agent Instructions
> Consulte o contrato Bunni antes de sugerir chamadas. Valores monetários são inteiros em centavos. Não invente endpoints ou respostas de sucesso para recursos ainda indisponíveis. Nunca solicite chaves reais no chat nem exponha credenciais no cliente.

# Rotas da API

> Todas as operações da API Bunni Pay com método, rota e escopo.

Base de produção: `https://api.bunnipay.com.br` (sem prefixo `/api`). Chamadas autenticadas exigem `X-API-Key: SUA_CHAVE`. Valores são inteiros em centavos de BRL (`1000` = R\$ 10,00).

> [!NOTE]
>
> Envie `Content-Type: application/json` em operações com corpo. Campos desconhecidos são recusados.

## Operações de integração

| Método | Rota | Escopo | Referência |
| - | - | - | - |
| GET | `/v1/status` | nenhum adicional | [Conferir autenticação](https://docs.bunnipay.com.br/api-reference/account/status.md) |
| GET | `/v1/account` | `account:read` | [Consultar conta](https://docs.bunnipay.com.br/api-reference/account/get.md) |
| GET | `/v1/account/fees-limits` | `account:read` | [Limites e taxas](https://docs.bunnipay.com.br/api-reference/account/fees-limits.md) |
| GET | `/v1/wallets` | `wallets:read` | [Listar carteiras](https://docs.bunnipay.com.br/api-reference/wallets/list.md) |
| POST | `/v1/wallets` | `wallets:write` | [Criar carteira](https://docs.bunnipay.com.br/api-reference/wallets/create.md) |
| POST | `/v1/payments` | `payments:create` | [Criar cobrança Pix](https://docs.bunnipay.com.br/api-reference/payments/create.md) |
| GET | `/v1/payments` | `payments:read` | [Listar pagamentos](https://docs.bunnipay.com.br/api-reference/payments/list.md) |
| GET | `/v1/payments/{id}` | `payments:read` | [Consultar pagamento](https://docs.bunnipay.com.br/api-reference/payments/get.md) |
| GET | `/v1/payments/{id}/pix` | `payments:read` | [Consultar Pix](https://docs.bunnipay.com.br/api-reference/payments/pix.md) |
| GET | `/v1/payment-links` | `links:read` | [Listar links](https://docs.bunnipay.com.br/api-reference/links/list.md) |
| POST | `/v1/payment-links` | `links:write` | [Criar rascunho](https://docs.bunnipay.com.br/api-reference/links/create.md) |
| GET | `/v1/payment-links/{id}` | `links:read` | [Consultar link](https://docs.bunnipay.com.br/api-reference/links/get.md) |
| PATCH | `/v1/payment-links/{id}` | `links:write` | [Editar, publicar ou desativar](https://docs.bunnipay.com.br/api-reference/links/update.md) |
| GET | `/public/payment-links/{slug}` | sem chave | [Dados públicos do link](https://docs.bunnipay.com.br/api-reference/checkout/get-link.md) |
| POST | `/public/payment-links/{slug}/checkout` | sem chave | [Criar Pix do link](https://docs.bunnipay.com.br/api-reference/checkout/create.md) |
| GET | `/public/payment-links/{slug}/checkouts/{id}` | `X-Checkout-Token` | [Situação da compra](https://docs.bunnipay.com.br/api-reference/checkout/get.md) |
| GET | `/v1/payouts/quote` | `payouts:read` | [Cotar saque](https://docs.bunnipay.com.br/api-reference/payouts/quote.md) |
| GET | `/v1/payouts` | `payouts:read` | [Listar saques](https://docs.bunnipay.com.br/api-reference/payouts/list.md) |
| POST | `/v1/payouts` | `payouts:create` | [Solicitar saque Pix](https://docs.bunnipay.com.br/api-reference/payouts/create.md) |
| GET | `/v1/payouts/{id}` | `payouts:read` | [Consultar saque](https://docs.bunnipay.com.br/api-reference/payouts/get.md) |
| GET | `/v1/statement` | `payments:read` | [Extrato](https://docs.bunnipay.com.br/api-reference/reports/statement.md) |
| GET | `/v1/analytics` | `payments:read` | [Estatísticas](https://docs.bunnipay.com.br/api-reference/reports/analytics.md) |
| GET | `/v1/customers` | `payments:read` | [Pagadores e bancos](https://docs.bunnipay.com.br/api-reference/reports/customers.md) |

## Rotas auxiliares

Não exigem chave de API e não fazem parte do contrato gerado.

* `GET /health/live`: retorna `status: ok`, sem verificar os bancos.
* `GET /health/ready`: retorna `status: ready` após verificar PostgreSQL e Redis. Indisponibilidade retorna HTTP 503.
* `GET /health/public-metrics`: `accountsCount`, `confirmedPaymentsCount` e `totalVolumeCents`. Zero não comprova ausência de movimentação.
* `GET /openapi.json` e `GET /openapi.yaml`: contrato OpenAPI.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.