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

# Visão Geral

> Referência completa dos endpoints da API da Flare Payments

## Base URL

```
https://api.flarepayments.com/v1
```

## Autenticação

Todas as requisições requerem o header:

```http theme={null}
Authorization: Bearer sk_live_sua_chave_aqui
```

## Endpoints Disponíveis

<CardGroup cols={2}>
  <Card title="POST /v1/charges" icon="plus" href="/api-reference/charges/create-charge">
    Criar uma nova cobrança PIX
  </Card>

  <Card title="GET /v1/charges/{id}" icon="magnifying-glass" href="/api-reference/charges/get-charge">
    Consultar os dados de uma cobrança
  </Card>

  <Card title="GET /v1/charges/{id}/status" icon="circle-check" href="/api-reference/charges/get-charge-status">
    Verificar o status de uma cobrança (polling)
  </Card>

  <Card title="GET /v1/balance" icon="wallet" href="/api-reference/balance/get-balance">
    Consultar saldo disponível e pendente
  </Card>

  <Card title="POST /v1/withdrawals" icon="money-bill-transfer" href="/api-reference/withdrawals/create-withdrawal">
    Solicitar um saque via PIX
  </Card>

  <Card title="GET /v1/transactions" icon="list" href="/api-reference/transactions/list-transactions">
    Listar transações com filtros e paginação
  </Card>
</CardGroup>

## Formato das Respostas

Todas as respostas são em `application/json`. Respostas de sucesso incluem sempre:

* `object` — tipo do recurso retornado
* `livemode: true` — indica ambiente de produção
* Timestamps em formato **ISO 8601**
* Valores monetários em **Reais (BRL)** com campo `_cents` para centavos

## Headers de Segurança

Todas as respostas incluem os seguintes headers:

```http theme={null}
X-Content-Type-Options: nosniff
X-Frame-Options: DENY
Strict-Transport-Security: max-age=63072000; includeSubDomains; preload
Cache-Control: no-store, no-cache, must-revalidate
```

## CORS

A API aceita requisições cross-origin:

```http theme={null}
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: authorization, content-type, x-idempotency-key
Access-Control-Allow-Methods: GET, POST, OPTIONS
```