Skip to main content

Contas Pix

A conta Pix é a configuração que liga uma conta bancária sua à Kobana para receber por Pix. Ela reúne o banco, a chave Pix que recebe os pagamentos, a conexão com o banco (as credenciais de API) e os dados do beneficiário. Toda cobrança Pix pertence a uma conta Pix, e só uma conta Pix ativa gera cobranças.

Você pode ter várias contas Pix, inclusive em bancos diferentes. Na hora de criar a cobrança, você escolhe qual delas usar.

Onde fica no painel​

Recebimentos > Pix > Contas Pix. A lista mostra, para cada conta:

ColunaConteúdo
UIDIdentificador público da conta Pix
SituaçãoNão Validada, Desabilitada ou Ativa (Validada e Habilitada)
Nome da ContaNome que você deu à conta
ProvedorBanco da conta
Chave PixChave que recebe os pagamentos

Antes de começar​

  • Uma conta financeira cadastrada num banco com integração Pix. A conta Pix é criada a partir dela, e os dados do beneficiário vêm dela.
  • Uma conexão com esse banco que tenha o escopo de operações Pix. Sem conexão válida, o cadastro leva você para a tela de Conexões.

Cadastrar uma conta Pix​

  1. Em Contas Pix, clique em novo.
  2. Na tela Selecione a conta financeira para cadastrar a conta Pix, escolha a conta financeira. Só aparecem contas financeiras de bancos com integração Pix.
  3. Em Dados da sua Conta, preencha os campos abaixo e clique em Prosseguir.
  4. Em Confirme as Informações, revise nome, instituição, chave, tipo de chave, conexão e beneficiário, e clique em Salvar e Continuar.
  5. A Kobana mostra "Conta Pix cadastrada com sucesso! Agora é necessário ativar o webservice." Siga para a validação.

A qualquer momento antes de salvar, o link Recomeçar limpa o que foi preenchido.

CampoObrigatórioDescrição
Nome da ContaSimNome para identificar a conta no painel. Até 100 caracteres.
Chave PixSim, na maioria dos bancosChave que recebe os pagamentos. Até 77 caracteres. Alguns bancos não usam chave na integração e o campo não aparece.
ConexãoSimConexão com o banco usada para registrar as cobranças. Precisa ter o escopo de operações Pix.

Tipos de chave aceitos​

A Kobana identifica o tipo da chave pelo formato:

Tipo de ChaveExemplo de formato
CNPJ14 dígitos de um CNPJ válido
AleatóriaChave aleatória gerada pelo banco
E-mailEndereço de e-mail
CelularNúmero de celular

Chave do tipo CPF não é aceita: a conta mostra o erro "não pode ser um CPF". Se o formato não corresponder a nenhum tipo, o erro é "não foi possível inferir o tipo da chave".

Validar e ativar​

Depois de salva, a conta Pix fica Não Validada. A tela da conta mostra "Precisamos validar suas credenciais para garantir que o acesso ao web service irá funcionar corretamente." e o botão Validar.

Ao clicar em Validar, a Kobana testa as credenciais com o banco na hora:

  • Deu certo: aparece "Chave Pix validada com sucesso!" e a conta fica Ativa (Validada e Habilitada).
  • Falhou: a mensagem de erro do banco aparece na tela e no quadro lateral da conta. Revise a conexão e tente de novo.

A validação exige uma conexão ativa associada à conta Pix.

Quando você associa ou troca a conexão de uma conta Pix, a Kobana dispara a validação automaticamente em segundo plano.

Situações da conta Pix​

SituaçãoO que significa
Não ValidadaAs credenciais ainda não foram validadas com o banco. A conta não gera cobranças.
DesabilitadaA conta foi validada, mas está desligada e não gera cobranças.
Ativa (Validada e Habilitada)A conta gera cobranças.

Na tela da conta, use Desabilitar para tirar uma conta ativa de uso e Habilitar para voltar a usá-la.

Se a conexão for removida da conta Pix, a conta volta a ficar Não Validada e precisa ser validada de novo depois que uma nova conexão for associada.

Tela da conta Pix​

O quadro lateral mostra ID, UID, Situação, Nome da Conta, Chave Pix, Beneficiário, Criado em, Habilitada em, Validada em e Conexão. O menu Ações tem:

AçãoO que faz
AlterarAbre o formulário de alteração
ValidarValida as credenciais com o banco (só para conta ainda não validada)
Alterar Conexão / Associar ConexãoTroca ou associa a conexão com o banco
ExcluirExclui a conta Pix

Alterar uma conta Pix​

Em Ações > Alterar você pode:

  • trocar a Chave Pix;
  • trocar a Conexão, enquanto a conta ainda não foi validada;
  • escolher uma Conta Financeira, se a conta Pix ainda não tiver uma. Os dados do beneficiário passam a vir dela.

Quando a conta Pix já tem conta financeira, os dados do beneficiário são gerenciados pela conta financeira: para mudá-los, edite a conta financeira. Depois de associada, a conta financeira não pode ser removida da conta Pix e precisa ser do mesmo banco.

Excluir uma conta Pix​

Em Ações > Excluir, a Kobana pede confirmação:

  • a exclusão é definitiva;
  • todas as cobranças Pix da conta são apagadas junto, e a tela mostra quantas são;
  • a Kobana deixa de receber notificações de pagamento para a chave Pix da conta.

Marque Tenho certeza que quero excluir a conta Pix e clique em APAGAR Permanentemente. A exclusão é processada em segundo plano.

Permissões​

As ações dependem das permissões do produto Contas Pix, no módulo Recebimentos:

Ação no painelPermissão
Ver a lista e a tela da contaAções Básicas
CadastrarCriar
Alterar, validar, habilitar e desabilitarAtivar API
ExcluirExcluir

Pela API​

Contas Pix podem ser criadas e consultadas pela API v2.