> ## 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.

# Extrato

> Consulte o extrato de pagamentos com paginacao por cursor, filtros por periodo, status e busca por referencia.

O extrato retorna pagamentos da conta em ordem cronologica inversa (mais recentes primeiro), com paginacao por cursor. Ele nao representa um razao financeiro completo e nao inclui saques nem transferencias.

> [!NOTE]
>
> Requer escopo `payments:read`.

## Consultar extrato

Envie `GET /v1/statement` com filtros opcionais de query.

**days** `string`

Periodo em dias: `7`, `30` (padrao) ou `90`.

**status** `string`

Filtro por situacao: `all` (padrao), `pending`, `paid`, `expired`, `refunded`, `unknown`.

**search** `string`

Busca por referencia externa ou identificador do pagamento (ate 100 caracteres).

**cursor** `string`

UUID do cursor da pagina anterior, obtido em `nextCursor`.

```bash curl theme={"theme":"github-dark-default"}
curl "https://api.bunnipay.com.br/v1/statement?days=30&status=paid&search=PEDIDO-123" \
  -H "X-API-Key: SUA_CHAVE"
```

## Resposta paginada

A resposta contem ate 50 itens por pagina.

**data.items** `array` *required*

Lista de pagamentos (maximo 50).

**data.items\[].id** `string` *required*

UUID do pagamento.

**data.items\[].amountCents** `integer` *required*

Valor em centavos de BRL.

**data.items\[].feeCents** `integer` *required*

Tarifa em centavos.

**data.items\[].status** `string` *required*

Situacao do pagamento.

**data.items\[].externalReference** `string`

Referencia externa ou `null`.

**data.items\[].createdAt** `string` *required*

Data/hora de criacao (ISO 8601).

**data.items\[].walletName** `string` *required*

Nome da carteira vinculada.

**data.nextCursor** `string`

Cursor para a proxima pagina, ou `null` se nao houver mais resultados.

## Paginacao por cursor

Para navegar entre paginas:

1. Na primeira requisicao, nao envie `cursor`.
2. Na resposta, verifique `data.nextCursor`.
3. Se `nextCursor` nao for `null`, envie-o no parametro `cursor` da proxima requisicao.
4. Repita ate `nextCursor` ser `null`.

```bash curl theme={"theme":"github-dark-default"}
curl "https://api.bunnipay.com.br/v1/statement?cursor=550e8400-e29b-41d4-a716-446655440005" \
  -H "X-API-Key: SUA_CHAVE"
```

> [!WARNING]
>
> O cursor deve pertencer a mesma conta. Nao misture cursores de contas diferentes.

## Limitacoes

* O extrato inclui **somente pagamentos**; nao representa um razao completo de saques e transferencias.
* Para listagens sem paginacao (ate 100 registros), use `GET /v1/payments`.
* Periodos aceitos: 7, 30 ou 90 dias.


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