Consultar boleto Hibrido

GET https://sandbox.tbanks.com.br/hybrid-bill

Descrição

Esse endpoint permite a consulta de um boleto hibrido previamente criado, sendo possível consultar boletos em diferentes estágios de analise e baixa.

Corpo de Response

Campo	Tipo	Descrição
identifier	UUID	identificador do boleto hibrido
accountIdentifier	UUID	_identificador da conta
dueDate	LocalDate	Data de vencimento do boleto
expirationDaysAfterDueDate	Int	Quantidade em dias para expiração do boleto
urlNotification	String	Url para notificação
yourNumber	Long	Seu número informado na requisição de emissão
emails	Array	Emails para envio do boleto emitido
barCode	LocalDate	Data de vencimento do boleto
digitableLine	String	Linha digitável do boleto
copyAndPaste	String	Cópia do boleto
endDate	LocalDate	Data final do boleto
payer	Object	Dados do pagador
└── name	String	Nome do pagador
└──documentNumber	String	Numero do documento do pagador
└── tradingName	String	Nome fantasia
└── street	String	Rua do pagador
└── district	String	Distrito do pagador
└── city	String	Cidade do pagador
└── state	String	Estado do pagador (Obrigatório inserir apenas UF, exemplo: SP)
└── zipCode	String	CEP do pagador
└── email	String	Email do pagador
additionalInformation	Array	Informações adicionais do boleto
value	BigDecimal	Valor associado ao boleto
discounts	Array	Descontos do boleto/ QrCode
interestType	Enum	Tipo de juros do boleto / QrCode
interestValue	BigDecimal	Porcentagem de juros do boleto
fineType	Enum	Tipo de multa do boleto / QrCode
fineValue	BigDecimal	Porcentagem de multa do boleto/ QrCode
description	String	Descrição do boleto/QrCode
keyValue	String	Valor da chave Pix
status	Int	Dias para baixa automática dos boletos após o vencimento

Valores possíveis para InterestType

Status	Descrição
VALUE_PER_DAY	Valor (dias corridos)
PERCENTAGE_PER_DAY	Porcentagem ao dia

Valores possíveis para fineType

Status	Descrição
FIXED_VALUE	Valor fixo
PERCENTAGE	Percentual

Valores possíveis para o Status do boleto hibrido

Status	Descrição
PENDING	Indica pendencia do mesmo
ISSUED	Indica que o mesmo esta emitido
SETTLED	Indica que o mesmo foi liquidado
PAID	Indica que o mesmo foi pago
OVERDUE	Boleto vencido. Passível de pagamento
CANCELLED	Indica que o mesmo foi cancelado