Consultas de boleto e de QR Code Pix

As consultas do módulo Dados verificam um documento antes do pagamento:

• Consulta de Boleto: a partir da linha digitável ou do código de barras, traz valor, vencimento, beneficiário, pagador e se o boleto está apto para pagamento. Funciona para boletos emitidos fora da Kobana.
• Consulta de Pix via QR Code: a partir do código Pix Copia e Cola, traz valor, vencimento, beneficiário, devedor e encargos.

A consulta não cria pagamento. Para pagar, use Pagamento de boletos ou Pagamento de Pix por QR Code.

Onde fica no painel

As consultas não têm item no menu lateral. Acesse pelos endereços:

• Consulta de Boleto: app.kobana.com.br/dados/consulta-boletos
• Consulta de Pix via QR Code: app.kobana.com.br/dados/consulta-pix-via-qrcode

Cada tela lista as consultas já feitas, com UID, o código consultado e o Status. Sem nenhuma consulta, a tela mostra o atalho Nova Consulta.

Consulta de Boleto

Nova consulta

Campo	Obrigatório	Descrição
Linha Digitável ou Código de Barras	Sim	Linha digitável (com ou sem pontuação) ou código de barras de 44 dígitos.
Etiquetas (Tags)	Não	Etiquetas para organizar as consultas, separadas por vírgula.

Clique em Realizar Consulta. A Kobana consulta o boleto na hora e abre o resultado com Consulta realizada com sucesso. ou Erro ao realizar a consulta.

Resultado

Com Consulta com Sucesso, a tela mostra:

• Linha Digitável e Código de Barras, com botão de copiar;
• Apto para pagamento (Sim ou Não) e, quando não estiver, o Motivo;
• Vencimento e Data-limite para Pagamento;
• Valor;
• Banco Emissor;
• Pagador, Beneficiário, Beneficiário Final e Sacador Avalista (nome e documento), quando informados;
• Valor Mínimo, Valor Máximo, Valor Original, Permite Alterar Valor e Permite Pagamento Parcial;
• ID Externo, Etiquetas (Tags), Dados Personalizados e as datas de criação e processamento.

Com Erro na Consulta, a tela mostra a Mensagem de Erro. As mensagens mais comuns:

Mensagem	Significado
Boleto indisponível, pode já ter sido pago, cancelado ou baixado	O boleto não está disponível para pagamento.
Não foi possível confirmar a disponibilidade deste documento para pagamento. O convênio ou a modalidade de pagamento pode não ser suportado.	O documento não pôde ser confirmado como pagável.
Não foi possível consultar o boleto	A consulta ao provedor falhou.

Status

Status	Significado
Pendente	Consulta cadastrada e ainda não processada.
Consulta com Sucesso	Os dados do boleto foram obtidos.
Erro na Consulta	A consulta falhou; veja a mensagem de erro.

Uma consulta Pendente tem o menu Ações com Processar (executa a consulta) e Excluir. Depois de processada, a consulta não pode ser processada de novo nem excluída. Para consultar outra vez, crie uma nova consulta.

Consulta de Pix via QR Code

Nova consulta

Campo	Obrigatório	Descrição
QR code do pix (código do copia e cola)	Sim	O código Pix Copia e Cola.
Etiquetas (Tags)	Não	Etiquetas separadas por vírgula.

Clique em Realizar Consulta. O painel abre o resultado com Consulta realizada com sucesso. ou Erro ao processar a consulta.

Resultado

Com Consulta com Sucesso, a tela mostra:

• Vencimento, Valor e Valor do pix troco;
• Devedor e Beneficiário (nome e documento), quando informados;
• Multa, Juros, Desconto e Valor com multas, juros e descontos;
• em Informações Adicionais: a descrição da cobrança, se ela pode ser paga, se aceita pagamento com valor diferente e, quando não pode ser paga, o motivo;
• ID Externo, Etiquetas (Tags), Dados Personalizados e as datas.

Quando o QR Code consultado é de uma cobrança Pix emitida pela própria conta na Kobana, a lateral mostra a situação de pagamento dessa cobrança, a imagem do QR Code e o Pix Copia e Cola.

Os status são os mesmos da consulta de boleto: Pendente, Consulta com Sucesso e Erro na Consulta. Uma consulta Pendente pode ser excluída; depois de processada, não.

Permissões

Módulo Dados:

Produto	Ações
Consulta de Boleto	Ações Básicas para ver; Criar para consultar e processar.
Consulta Pix via QR Code	Ações Básicas para ver; Criar para consultar.

Cada consulta também precisa do produto correspondente contratado no plano.

Eventos de webhook

Evento	Quando
data.bank_billet_query.success / data.pix_qrcode_query.success	Consulta concluída com sucesso.
data.bank_billet_query.error / data.pix_qrcode_query.error	Consulta concluída com erro.
data.bank_billet_query.db.created / data.pix_qrcode_query.db.created	Consulta criada.

Lista completa em Eventos de webhook.

Pela API

Referência em API v2.