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
}

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 sk_live_xxx

Exemplo de Requisição

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

Resposta `200 OK`

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

Show Propriedades

customer.name

string

Nome do cliente

customer.email

string

E-mail do cliente

customer.document

string

CPF/CNPJ do cliente

pix

object

Dados do PIX

Show Propriedades

pix.qr_code

string

QR Code em base64

pix.copy_paste

string

Código copia-e-cola

pix.payment_link

string

Link de pagamento

fee

object

Dados da taxa

Show Propriedades

fee.amount

float

Valor da taxa

fee.net_amount

float

Valor líquido após 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

Status	Código	Descrição
`400`	`missing_id`	ID da cobrança não informado
`404`	`charge_not_found`	Cobrança não encontrada
`401`	`unauthorized`	Header `Authorization` ausente

Criar Cobrança Status da Cobrança

​Descrição

​Parâmetros de Path

​Headers

​Exemplo de Requisição

​Resposta 200 OK

​Erros

Descrição

Parâmetros de Path

Headers

Exemplo de Requisição

Resposta `200 OK`

Erros