API Reference
Log In
API Reference

Consultar boleto

Endpoint de consulta de boletos por ID

Resposta da requisição

VariávelTipoDescrição
idstringId de identificação do boleto.
valueTotalLongValor total do boleto.
valuePayLongValor pago.
valueRefundedLongValor recusado.
barCodestringCódigo de barras.
dueDatestringData de vencimento.
externalReferencestringReferência externa de parceria.
statusstringStatus do boleto. Ex.: PENDING, PAID, CANCELED, ERROR, GENERATED, WAITING.
descriptionstringDescrição do boleto.
urlstringUrl com o pdf do boleto.
createdAtstringData de criação do boleto.
detailsObjectDetalhes do boleto gerado.
paidAtstringData/hora do pagamento do boleto
Language
Click Try It! to start a request and see the response here!