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 sobre os boletos híbridos com base em filtros previamente informados:


CampoDescriçãoFormatoObrigatório
SituaçãoControle de identificação do Boleto HíbridoStringNão
Data InícioData inicial em que foi realizada a criação do boleto híbrido (Solicitado)StringSim
Data FimData final do range de boletos híbridos a serem consultados (range máximo de 90 dias)StringSim
Documento do PagadorTipo do documento do sacado (usuário pagador)StringNão
Página AtualPaginação a ser retornadaIntergerNão
Quantidade Por PáginaQuantidade de registros por páginaIntergerNão

Exemplo de resposta:

CampoDescriçãoFormato
IDIdentificador único da transaçãoTexto (UUID)
SituaçãoSituação atual da transaçãoTexto
Data de VencimentoData em que a cobrança deve ser pagaAAAA-MM-DD
ValorValor total da cobrançaNumérico com até 2 casas decimais
Documento do PagadorDocumento de identificação do pagadorNúmero
Nome do PagadorNome completo do pagadorTexto
Data de PagamentoData em que o pagamento foi realizado (condicional)“AAAA-MM-DD”
Seu NúmeroID informado no momento da criação do boleto híbridoTexto

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

Obtenção sobre os boletos híbridos com base no identificador do Boleto Híbrido


CampoDescriçãoFormatoObrigatório
IDIdentificador para recuperação dos detalhes do Boleto HíbridoStringSim

Exemplo de resposta:

CampoDescriçãoFormato
IDIdentificador único da transaçãoTexto (UUID)
QR CodeCódigo QR associado à transaçãoTexto
Linha DigitávelCódigo de barras no formato de linha digitávelTexto
Código de BarrasCódigo de barras associado à transaçãoTexto
SituaçãoSituação atual da transaçãoTexto
Dados do Recebedor
DocumentoDocumento de identificação do recebedorNúmero
Tipo de DocumentoTipo de documento de identificação do recebedorTexto
Razão SocialRazão social do recebedorTexto
Agência/ContaNúmeros da agência e da conta do recebedorTexto
Nome FantasiaNome fantasia do recebedorTexto
Dados da Cobrança
TX IDIdentificador da transaçãoTexto
Seu NúmeroIdentificação do cliente para a cobrançaTexto
ChaveChave Pix associada à cobrançaTexto
ValorValor total da cobrançaNumérico com até 2 casas decimais
Data de VencimentoData em que a cobrança deve ser pagaAAAA-MM-DD
Data Limite DescontoData limite para aplicação do descontoAAAA-MM-DD
Data Limite pós VencimentoData limite para pagamento após o vencimentoAAAA-MM-DD
Valor Desconto FixoValor fixo de desconto aplicado sobre o valorNumérico com até 2 casas decimais
Valor Desconto PercentualPercentual de desconto aplicado sobre o valorNumérico com até 2 casas decimais
Valor Desconto DiárioValor do desconto por dia aplicado sobre o valorNumérico com até 2 casas decimais
MultaDetalhes sobre a multa, se houverobjeto
TipoTipo da multaTexto
ValorValor da multaNumérico com até 2 casas decimais
JurosDetalhes sobre os juros, se houverobjeto
TipoTipo de jurosTexto
ValorValor dos jurosNumérico com até 2 casas decimais
Solicitação PagadorDescrição livre da solicitação do pagadorTexto
Linha 1Informação adicional - Linha 1Texto
Linha 2Informação adicional - Linha 2Texto
Linha 3Informação adicional - Linha 3Texto
Linha 4Informação adicional - Linha 4Texto
Dados do Pagador
CEPCEP do pagadorTexto
NomeNome completo do pagadorTexto
E-mailEndereço de e-mail do pagadorTexto
NúmeroNúmero do endereço do pagadorTexto
DocumentoDocumento de identificação do pagadorNúmero
TelefoneNúmero de telefone do pagadorTexto
BairroBairro do pagadorTexto
EstadoEstado do pagadorTexto
CidadeCidade do pagadorTexto
LogradouroLogradouro do pagadorTexto
ComplementoComplemento do endereço do pagadorTexto
Tipo de DocumentoTipo de documento de identificação do pagadorTexto

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