Consulta de Boleto Híbrido

Possibilita aos nossos clientes realizarem as consultas dos seus boletos híbridos emitidos.

Por meio da API, será possível obter detalhes como a situação atual do Boleto Híbrido, datas de vencimento e os dados complementares dos boletos híbridos.

Com esta transparência, nossos clientes terão uma jornada otimizada.

As consultas serão realizadas por meio de dois métodos:

Obtenção de boletos híbridos a partir de sua situação

Solicitamos os campos:

Campo	Descrição	Formato	Obrigatório
Situação	Permite informar a situação desejada para buscar o boleto híbrido, conforme tabela Situação do Boleto Híbrido	Texto	Não

Exemplo de resposta:

Campo	Descrição	Formato
ID	Identificador único da transação	Texto (UUID)
Situação	Situação atual da transação, conforme tabela Situação do Boleto Híbrido	Texto
Data de Vencimento	Data em que a cobrança deve ser paga	AAAA-MM-DD
Valor	Valor total da cobrança	Numérico com até 2 casas decimais
Documento do Pagador	Documento de identificação do pagador	Número
Nome do Pagador	Nome completo do pagador	Texto

Obtém a relação dos boletos híbridos com base nos filtros informados.

Obtenção de boletos híbridos com base no identificador

Solicitamos os campos:

Campo	Descrição	Formato	Obrigatório
ID	Identificador para recuperação dos detalhes do Boleto Híbrido	Texto (UUID)	Sim

Exemplo de resposta:

Campo	Descrição	Formato
ID	Identificador único da transação	Texto (UUID)
QR Code	Código QR associado à transação	Texto
Linha Digitável	Código de barras no formato de linha digitável	Texto
Código de Barras	Código de barras associado à transação	Texto
Situação	Situação atual da transação, conforme tabela Situação do Boleto Híbrido	Texto
Documento	Documento de identificação do recebedor	Número
Tipo de Documento	Texto	Texto
Nome	Texto	Texto
Agência/Conta	Números da agência e da conta do recebedor	Texto
Nome Fantasia	Nome fantasia do recebedor	Texto
TX ID	Identificador da transação	Texto
Seu Número	Identificação do cliente para a cobrança	Texto
Chave	Chave Pix associada à cobrança	Texto
Valor	Valor total da cobrança	Numérico com até 2 casas decimais
Data de Vencimento	Data em que a cobrança deve ser paga	AAAA-MM-DD
Data Limite Desconto	Data limite para aplicação do desconto	AAAA-MM-DD
Data Limite pós Vencimento	Data limite para pagamento após o vencimento	AAAA-MM-DD
Valor Desconto Fixo	Valor fixo de desconto aplicado sobre o valor	Numérico com até 2 casas decimais
Valor Desconto Percentual	Percentual de desconto aplicado sobre o valor	Numérico com até 2 casas decimais
Valor Desconto Diário	Valor do desconto por dia aplicado sobre o valor	Numérico com até 2 casas decimais
Multa	Detalhes sobre a multa, se houver	objeto
Tipo	Tipo da multa, conforme tabela Tipo de Multa	Texto
Valor	Valor da multa	Numérico com até 2 casas decimais
Juros	Detalhes sobre os juros, se houver	objeto
Tipo	Tipo de juros, conforme tabela Tipo de Juros	Texto
Valor	Valor dos juros	Numérico com até 2 casas decimais
Solicitação Pagador	Descrição livre da solicitação do pagador	Texto
Linha 1	Informação adicional - Linha 1	Texto
Linha 2	Informação adicional - Linha 2	Texto
Linha 3	Informação adicional - Linha 3	Texto
Linha 4	Informação adicional - Linha 4	Texto
CEP	CEP do pagador	Texto
Nome	Nome completo do pagador	Texto
E-mail	Endereço de e-mail do pagador	Texto
Número	Número do endereço do pagador	Texto
Documento	Documento de identificação do pagador	Texto
Telefone	Número de telefone do pagador	Texto
Bairro	Bairro do pagador	Texto
Estado	Estado do pagador	Texto
Cidade	Cidade do pagador	Texto
Logradouro	Logradouro do pagador	Texto
Complemento	Complemento do endereço do pagador	Texto
Tipo de Documento	Tipo de documento de identificação do pagador: `Cpf` ou `Cnpj`	Texto

Obtém as informações detalhadas para o boleto híbrido com base no identificador fornecido.