Skip to main content
GET
/
charges
/
{chargeId}
Consultar Cobrança
curl --request GET \
  --url https://api.example.com/charges/{chargeId} \
  --header 'Authorization: <authorization>'
{
  "id": "ch_flare_dc7dc11b7f984d2886d2b429",
  "object": "charge",
  "amount": 10.00,
  "amount_cents": 1000,
  "currency": "BRL",
  "method": "pix",
  "status": "paid",
  "description": "Pedido #1234",
  "customer": {
    "name": "João Silva",
    "email": "joao@email.com",
    "document": "12345678900"
  },
  "pix": {
    "qr_code": "...",
    "copy_paste": "00020101021226...",
    "payment_link": "https://..."
  },
  "fee": {
    "amount": 0.50,
    "net_amount": 9.50
  },
  "created_at": "2026-03-05T18:14:48.552Z",
  "paid_at": "2026-03-05T18:16:22.000Z",
  "expires_at": "2026-03-05T19:14:48.549Z",
  "metadata": {},
  "livemode": true
}

Descrição

Retorna os dados completos de uma cobrança, incluindo status, dados do cliente, PIX e taxas.

Parâmetros de Path

chargeId
string
required
ID da cobrança. Aceita formato ch_flare_xxx, UUID completo ou ID parcial

Headers

Authorization
string
required
Bearer token de autenticação. Formato: Bearer flare_xxx

Exemplo de Requisição

curl https://api.flarepayments.com/v1/charges/ch_flare_dc7dc11b7f984d2886d2b429 \
  -H "Authorization: Bearer flare_sua_chave_aqui"

Resposta 200 OK

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
status
string
Status: pending, paid, expired, failed
customer
object
Dados do cliente
pix
object
Dados do PIX
fee
object
Dados da taxa
{
  "id": "ch_flare_dc7dc11b7f984d2886d2b429",
  "object": "charge",
  "amount": 10.00,
  "amount_cents": 1000,
  "currency": "BRL",
  "method": "pix",
  "status": "paid",
  "description": "Pedido #1234",
  "customer": {
    "name": "João Silva",
    "email": "joao@email.com",
    "document": "12345678900"
  },
  "pix": {
    "qr_code": "...",
    "copy_paste": "00020101021226...",
    "payment_link": "https://..."
  },
  "fee": {
    "amount": 0.50,
    "net_amount": 9.50
  },
  "created_at": "2026-03-05T18:14:48.552Z",
  "paid_at": "2026-03-05T18:16:22.000Z",
  "expires_at": "2026-03-05T19:14:48.549Z",
  "metadata": {},
  "livemode": true
}

Erros

StatusCódigoDescrição
400missing_idID da cobrança não informado
404charge_not_foundCobrança não encontrada
401unauthorizedHeader Authorization ausente