Skip to main content

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.

​
Base URL

https://api.flarepayments.com/v1

​
Autenticação

Todas as requisições requerem o header: 
Authorization: Bearer flare_sua_chave_aqui

​
Endpoints Disponíveis

POST /v1/charges

Criar uma nova cobrança PIX

GET /v1/charges/{id}

Consultar os dados de uma cobrança

GET /v1/charges/{id}/status

Verificar o status de uma cobrança (polling)

GET /v1/balance

Consultar saldo disponível e pendente

POST /v1/withdrawals

Solicitar um saque via PIX

GET /v1/transactions

Listar transações com filtros e paginação

​
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: 
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: 
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: authorization, content-type, x-idempotency-key
Access-Control-Allow-Methods: GET, POST, OPTIONS