Skip to main content
GET
Detalhes do Carnê

Visão Geral

Retorna o carnê com todas as parcelas: vencimento, status, linha digitável e PDF do boleto.

Exemplo

Campos de dinheiro

totalScheduled é o que o carnê cobra. totalCollected é o que entrou. Eles divergem quando o banco soma multa ou mora, e por isso totalCollected pode ficar acima de totalScheduled. Não use um no lugar do outro para conciliar.

Parcelas

Cada item de installmentsDetail traz:
number
Posição da parcela, começando em 1.
string
scheduled, due_today, paid, overdue, failed ou canceled.
object
null enquanto a parcela não foi emitida. Parcelas futuras não têm boleto — não mostre um código de barras vazio ao comprador como se fosse pagável.
number
Quantas segundas vias já foram emitidas.