Consulta de BolePix

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 BolePix, 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:

CampoDescriçãoFormatoObrigatório
SituaçãoPermite informar a situação desejada para buscar o boleto híbrido, conforme tabela Situação do BolePixTextoNão

Exemplo de resposta:

CampoDescriçãoFormato
IDIdentificador único da transaçãoTexto (UUID)
SituaçãoSituação atual da transação, conforme tabela Situação do BolePixTexto
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

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

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

Solicitamos os campos:

CampoDescriçãoFormatoObrigatório
IDIdentificador para recuperação dos detalhes do BolePixTexto (UUID)Sim

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ção, conforme tabela Situação BolepixTexto
DocumentoDocumento de identificação do recebedorNúmero
Tipo de DocumentoTextoTexto
NomeTextoTexto
Agência/ContaNúmeros da agência e da conta do recebedorTexto
Nome FantasiaNome fantasia do recebedorTexto
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 multa, conforme tabela Tipo de MultaTexto
ValorValor da multaNumérico com até 2 casas decimais
JurosDetalhes sobre os juros, se houverobjeto
TipoTipo de juros, conforme tabela Tipo 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
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 pagadorTexto
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 pagador: Cpf ou CnpjTexto

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