Consultar dados de um boleto

Endpoint que permite realizar a consulta dos boletos para pagamento

Path Variable do request

CampoTipo(Tamanho)ObrigatórioDescrição
digitableLineString (47~48)SimLinha digitável do boleto.

Corpo do response

CampoTipoDescrição
identifierUUIDIdentificador do boleto
barCodeStringCódigo de barras do boleto.
digitableLineStringCódigo de barras do boleto. Equivalente ao barCode
recipientNameStringNome do beneficiário do boleto
recipientDocumentNumberStringDocumento do beneficiário
payerDocumentNumberStringDocumento do pagador
payerNameStringNome do pagador
bankNameStringNome do banco emissor do boleto. Obs: para boletos de convênio e tributos este campo não terá valor, portanto será retornado null.
dueDateDateData de vencimento do boleto.
settlementDateDateData de pagamento do boleto.
originalValueDoubleValor do boleto.
amountDoubleValor do boleto abatido o desconto ou acrescido do juros e multa.
discountValueDoubleValor de desconto do boleto. Obs: Já consta no campo amount
interestValueDoubleValor dos juro do boleto. Obs: Já consta no campo amount.
fineValueDoubleValor da multa do boleto. Obs: Já consta no campo amount
minAmountDoubleValor minimo possível ser pago.
maxAmountDoubleValor máximo possível ser pago.
referenceStringCódigo de referência da consulta. Será utilizado no endpoint de pagamento como chave da consulta. Pagar boleto
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!