Cobrança Pix
A cobrança Pix é um pedido de pagamento com QR Code dinâmico, emitido numa das suas contas Pix. Cada cobrança tem o próprio QR Code, o próprio código Pix Copia e Cola e um identificador da transação (TX ID), que é como o banco liga o pagamento recebido à cobrança.
Tipos de cobrança
O campo Tipo de Registro define o tipo:
| Tipo de Registro | Como funciona |
|---|---|
| Imediato | Cobrança para pagamento na hora. O Vencimento é data e hora; passado esse momento, a cobrança aberta passa a Vencido. O formulário não mostra multa, juros, desconto, abatimento nem Dias para Baixa, e os dados do pagador são opcionais. |
| Cobrança | Cobrança com vencimento. O Vencimento é uma data e vale até o fim desse dia. O formulário aceita multa, juros, descontos, abatimento e Dias para Baixa, e exige os dados e o endereço do pagador. |
Os tipos disponíveis dependem do banco da conta Pix. Quando o banco aceita só um tipo, o campo Tipo de Registro não aparece e o formulário usa esse tipo.
Onde fica no painel
- Recebimentos > Pix > Gerenciar: lista de cobranças. O ícone de mais ao lado do título abre a lista das suas contas Pix ativas; escolha uma para criar a cobrança.
- Cadastrar > Pix: atalho que também lista as contas Pix ativas.
- Recebimentos > Pix > Importar: cria várias cobranças de uma vez a partir de um arquivo CSV.
Para criar uma cobrança, a conta Pix precisa estar ativa e com uma conexão ativa que tenha o escopo de operações Pix. Se não estiver, o painel volta para a lista com uma destas mensagens:
- "Não é possível criar Pix. A conta Pix selecionada não possui conexão bancária configurada. ..."
- "Não é possível criar Pix. A conta Pix selecionada não possui conexão bancária ativa. ..."
- "Não é possível criar Pix. A conexão bancária da conta Pix selecionada não possui escopo de operações Pix. ..."
Criar uma cobrança
- Escolha a conta Pix pelo menu.
- Preencha o formulário Novo Pix.
- Clique em Gerar um Novo Pix.
A Kobana grava a cobrança e abre a tela dela. Em seguida, envia a cobrança para registro no banco em segundo plano. O QR Code e o Pix Copia e Cola aparecem depois que o banco confirma o registro: veja Status e registro no banco.
Campos principais
| Campo | Obrigatório | Descrição |
|---|---|---|
| Quantia | Sim | Valor da cobrança em reais. Mínimo de R$ 0,01. |
| Tipo de Registro | Sim, quando o banco aceita os dois tipos | Imediato ou Cobrança. |
| Vencimento | Sim | No tipo Imediato, data e hora, que não podem estar no passado. No tipo Cobrança, data a partir de hoje. |
| Dias para Baixa | Não (só tipo Cobrança) | Número de dias após o vencimento em que o Pix ainda pode ser pago com juros e multas. Padrão 0. Precisa ser maior que zero quando houver multa ou juros. |
| Mensagem ao Pagador | Não | Texto exibido ao pagador. Aceita variáveis, inseridas pelo menu ao lado do campo. |
| Informações Adicionais | Não | Pares de Chave e Valor. As chaves são separadas com "_". Uma linha com chave preenchida não pode ter valor em branco. |
| Etiquetas (Tags) | Não | Etiquetas para organizar e buscar cobranças. Separe com vírgulas. |
Dados do Pagador
No tipo Cobrança, os dados do pagador e o endereço são obrigatórios. No tipo Imediato, são opcionais; se você deixar CNPJ/CPF e nome em branco, a cobrança é criada sem pagador.
| Campo | Obrigatório no tipo Cobrança | Descrição |
|---|---|---|
| CNPJ/CPF | Sim | Documento do pagador. Ao digitar um CNPJ, o painel busca a razão social e o endereço. |
| Nome | Sim | Nome ou razão social do pagador. |
| CEP | Sim | Ao digitar o CEP, o painel busca o endereço. |
| Endereço (rua) | Sim | |
| Nº | Não | |
| Bairro | Sim | |
| Complemento | Não | |
| Estado | Sim | |
| Cidade | Sim |
O painel também sugere pagadores já cadastrados como clientes enquanto você digita.
Multa (tipo Cobrança)
| Tipo de Multa | Campo que aparece |
|---|---|
| Sem multa | nenhum |
| Por valor | valor da multa em reais |
| Por porcentagem | percentual da multa |
Juros (tipo Cobrança)
Escolha o Tipo de Juro e informe o valor ou o percentual:
| Tipo de Juro | Cálculo |
|---|---|
| Sem juros | |
| Valor diário | valor em reais por dia corrido |
| Porcentagem diária | percentual por dia corrido |
| Porcentagem mensal | percentual ao mês, em dias corridos |
| Porcentagem anual | percentual ao ano, em dias corridos |
| Valor diário (dias úteis) | valor em reais por dia útil |
| Porcentagem diária (dias úteis) | percentual por dia útil |
| Porcentagem mensal (dias úteis) | percentual ao mês, em dias úteis |
| Porcentagem anual (dias úteis) | percentual ao ano, em dias úteis |
Com multa ou juros, o campo Dias para Baixa precisa ser maior que zero. Sem isso, a cobrança não é criada e o campo mostra "deve ser maior que zero quando há juros ou multa configurados".
Descontos (tipo Cobrança)
Escolha o tipo de desconto. Os campos de valor ou percentual e de dias aparecem conforme o tipo.
| Tipo de Desconto | Valor informado | Níveis de desconto |
|---|---|---|
| Sem desconto | ||
| Valor Fixo | reais | até três |
| Porcentagem Fixa | percentual | até três |
| Valor por antecipação dia corrido | reais | um |
| Valor por antecipação dia útil | reais | um |
| Percentual por antecipação dia corrido | percentual | um |
| Percentual por antecipação dia útil | percentual | um |
O campo de dias ("dias antes") define até quantos dias antes do vencimento o desconto vale. Com zero, o limite é a própria data de vencimento.
Os tipos por antecipação aceitam um nível de desconto só. Se você preencher o segundo ou o terceiro desconto com um desses tipos, a cobrança não é criada e aparece "Modalidades de desconto por antecipação não permitem múltiplos níveis de desconto".
Abatimento (tipo Cobrança)
| Tipo de Abatimento | Campo que aparece |
|---|---|
| Sem abatimento | nenhum |
| Valor | valor do abatimento em reais |
| Porcentagem | percentual do abatimento |
Tela da cobrança
A tela da cobrança tem duas abas, Pix e Comandos, e um quadro lateral.
A aba Pix mostra, entre outros: ID, Situação, Registro no Banco, Vencimento, TX ID, Boleto Híbrido (quando a cobrança está ligada a um boleto), Informações Adicionais, Somente Leitura, Etiquetas (Tags), Quantia, Conta Pix, Mensagem ao Pagador, dados do pagador, juros, descontos, abatimento, multa, Dias para Baixa e, depois do pagamento, Pago em, Quantia Paga e Mensagem do Pagador.
O quadro lateral mostra:
- o aviso "Aguardando registrar no banco..." enquanto o registro está pendente, e "Aguardando pagamento..." depois que o banco confirma;
- a imagem do QR Code, com botões para copiar o link da imagem e baixá-la;
- Instruções para pagamento via Pix: link para a página de pagamento da cobrança, que você pode enviar ao pagador (não aparece em cobrança de boleto híbrido);
- Pix Copia e Cola: o código para colar no aplicativo do banco, com botão de copiar.
A aba Comandos lista as operações enviadas ao banco para esta cobrança. Veja Status e registro no banco.
O menu Ações tem Cancelar ou Marcar como cancelado (veja Cancelar uma cobrança) e atalhos para Atividades, Eventos, Alertas, E-mails enviados, SMS enviados e Webhooks enviados desta cobrança.
No ambiente de testes (sandbox), uma cobrança aberta de uma conta Pix do banco de testes mostra a ação Informar Pagamento. Ela marca o Pix como pago com o valor, a data e a mensagem do pagador que você informar, para testar o fluxo de pagamento. Essa ação não existe em produção.
Lista e busca
A lista em Recebimentos > Pix > Gerenciar mostra ID, Situação (com um ícone colorido para o registro no banco), Conta Pix, Boleto Híbrido, Cliente, Criado em, Vencimento, Quantia e Recebimento (data e valor pago). Cobranças criadas pela API têm um ícone de código ao lado do ID.
A busca filtra por:
| Filtro | Descrição |
|---|---|
| ID do Pix, ID do Boleto, TXID | Identificadores |
| Situação | Uma ou mais situações |
| Tipo | Todos, Híbridos (ligados a um boleto) ou Simples |
| Recebimento, Vencimento, Criação | Intervalos de datas |
| Quantia | Intervalo de valores |
| Situação do Registro | Situação do registro no banco |
| Conta Pix | Conta Pix da cobrança |
| Nome do pagador, CNPJ/CPF do pagador | Dados do pagador |
| Etiquetas (tags) | Uma ou mais etiquetas |
| Ordenação | Campo e ordem crescente ou decrescente |
A lista pode ser exportada em CSV, XLSX ou ODS.
Cobrança ligada a boleto
Quando o boleto tem Pix (boleto híbrido), a cobrança Pix aparece na lista com o número do boleto na coluna Boleto Híbrido. Essa cobrança é gerenciada pelo boleto: ela não pode ser cancelada nem alterada diretamente.
Permissões
As ações dependem das permissões do produto Pix, no módulo Recebimentos:
| Ação no painel | Permissão |
|---|---|
| Ver a lista e a cobrança | Ações Básicas |
| Criar | Criar |
| Cancelar e marcar como cancelado | Cancelar |
Pela API
Cobranças Pix podem ser criadas, consultadas, alteradas e canceladas pela API v2.