Skip to main content
GET
Consultar Cobrança

Visão Geral

Retorna uma cobrança da sua conta pelo uuid. Use para acompanhar o status de um pagamento — especialmente num checkout transparente, enquanto o cliente ainda não pagou o PIX ou o boleto.
Para saber de um pagamento assim que ele acontece, prefira webhooks em vez de ficar consultando este endpoint em loop.

Headers

string
required
Sua chave de API (Bearer sk_live_...)

Path Parameters

string
required
UUID da cobrança, devolvido na criação

Exemplo de Requisição

Resposta de Sucesso (200 OK)

Bandeira e últimos 4 dígitos do cartão só vêm na resposta da criação. Numa consulta posterior o bloco card volta com os campos nulos.

Status possíveis

O status é um valor estável e amigável — o mesmo para PIX, boleto e cartão. Você pode ramificar com segurança nele (if (charge.status === 'paid')); ele não muda se trocarmos de adquirente por trás.
Aja em paid. É o único status que garante que o dinheiro entrou. authorized (cartão) ainda não é captura, e refund_pending significa que a devolução foi pedida mas ainda não caiu na conta do cliente.

Erros