Skip to main content
POST
/
charges
Criar Cobrança
curl --request POST \
  --url https://api.example.com/charges \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "amount": 123,
  "description": "<string>",
  "customer": {
    "customer.name": "<string>",
    "customer.email": "<string>",
    "customer.document": "<string>"
  }
}
'
{
  "id": "ch_flare_dc7dc11b7f984d2886d2b429",
  "object": "charge",
  "amount": 10.00,
  "amount_cents": 1000,
  "currency": "BRL",
  "method": "pix",
  "status": "pending",
  "pix": {
    "qr_code": "base64...",
    "copy_paste": "00020101021226...",
    "payment_link": "https://..."
  },
  "expires_at": "2026-03-05T19:14:48.549Z",
  "created_at": "2026-03-05T18:14:48.552Z",
  "livemode": true
}

Descrição

Cria uma nova cobrança PIX. O retorno inclui o QR Code e o código copia-e-cola para apresentar ao cliente.
O campo amount deve ser enviado em centavos (inteiro). Por exemplo, 1000 = R$ 10,00.
Rate Limit: 60 requisições/minuto

Headers

Authorization
string
required
Bearer token de autenticação. Formato: Bearer flare_xxx
Content-Type
string
required
Deve ser application/json
X-Idempotency-Key
string
Chave única para evitar cobranças duplicadas

Body

amount
integer
required
Valor em centavos (ex: 1000 = R$ 10,00)
description
string
Descrição da cobrança
customer
object
Dados do cliente

Exemplo de Requisição

curl -X POST https://api.flarepayments.com/v1/charges \
  -H "Authorization: Bearer flare_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -H "X-Idempotency-Key: pedido-1234" \
  -d '{
    "amount": 1000,
    "description": "Pedido #1234",
    "customer": {
      "name": "João Silva",
      "email": "joao@email.com",
      "document": "12345678900"
    }
  }'

Resposta 201 Created

id
string
ID da cobrança no formato ch_flare_xxx
object
string
Sempre "charge"
amount
float
Valor em Reais
amount_cents
integer
Valor em centavos
currency
string
Moeda (BRL)
method
string
Método de pagamento (pix)
status
string
Status da cobrança: pending, paid, expired, failed
pix
object
Dados do PIX
expires_at
string
Data de expiração (ISO 8601)
created_at
string
Data de criação (ISO 8601)
livemode
boolean
true em produção
{
  "id": "ch_flare_dc7dc11b7f984d2886d2b429",
  "object": "charge",
  "amount": 10.00,
  "amount_cents": 1000,
  "currency": "BRL",
  "method": "pix",
  "status": "pending",
  "pix": {
    "qr_code": "base64...",
    "copy_paste": "00020101021226...",
    "payment_link": "https://..."
  },
  "expires_at": "2026-03-05T19:14:48.549Z",
  "created_at": "2026-03-05T18:14:48.552Z",
  "livemode": true
}

Erros

StatusCódigoDescrição
400invalid_amountamount deve ser um inteiro positivo em centavos
401unauthorizedHeader Authorization ausente
401invalid_api_keyChave de API inválida
429rate_limit_exceededLimite de 60 req/min excedido