Índice

Como ativar o PIX do Banco do Brasil?

Matheus Gonçalves Atualizada Por Matheus Gonçalves

O PIX é a solução de pagamento instantâneo, criada e gerida pelo Banco Central, que proporciona a realização de transferências e de pagamentos. Este artigo irá te auxiliar na ativação para geração dos QR Codes do PIX do Banco do Brasil e assim passar a receber nessa modalidade.

Conectando ao Banco do Brasil

  1. Criando sua conta no Portal Developers do Banco do Brasil

Para gerar as credenciais necessárias para a comunicação via API, você precisa criar a sua conta no Portal Developers do Banco do Brasil. Realizando o cadastro com o CPF de um dos administradores da conta da empresa no banco torna tudo mais fácil, pois não será necessário aprovar através de outra conta, conforme explicamos no item 4.

Acesse o portal e realize o login ou cadastro: Portal Developers do Banco do Brasil.

Quando finalizar o cadastro e confirmar o número de celular cadastrado, realize o login com a senha criada.

  1. Aceitando os termos de uso da plataforma

Em seguida ao login, você deverá concordar com os termos de uso da plataforma. Logo depois, você será direcionado para a tela de aplicações, onde deverá ter uma notificação no sino no canto superior direito, clique no sino.

A pendência que deverá aparecer é a de assinatura dos termos de utilização da API. Clique em Visualizar. Na próxima página leia os termos e marque que concorda, em seguida clique em Próximo para ler o termo seguinte, marque que concorda e clique em Concluir.

  1. Criando a aplicação

Retornando à tela de aplicações, você vai clicar no botão Nova Aplicação, onde você deverá preencher:

  • Nome da aplicação (ex.: "Nome da Empresa-API-PIX")
  • Descrição (ex.: "Credenciais para conexão via API referente ao PIX")
  • Ícone da aplicação (opcional)
  • API: selecione a opção APIs com contratação online pelo Portal Developers BB e, então, PIX.
Se desejar, selecione a opção de cobranças também, assim você poderá utilizar a API do Banco do Brasil para comunicar automaticamente as transações dos seus boletos gerados no sistema. Saiba mais: Como conectar à API de cobrança do Banco do Brasil?

No final da página clique em Criar.

  1. Enviando para produção e gerando as credenciais

Com o seu novo aplicativo criado, clique nele e uma tela semelhante com a da imagem abaixo deverá aparecer. Clique no avião de papel na barra lateral esquerda para enviar seu app para produção.

Na próxima tela, preencha com o CNPJ da sua empresa e clique em Pesquisar CNPJ. O sistema irá exibir a identificação da empresa selecionada. Confira se a informação está correta e clique em Próximo.

Na página seguinte, revise os dados de sua aplicação e clique em Solicitar Produção.

Caso você esteja logado com um CPF administrador da conta da empresa, será exibido um Termo de Adesão, que deverá ser lido até o final. Estando de acordo deverá ser assinado, resultando na disponibilização das credenciais de produção.

Se o CPF que você está logado não tem vínculo com a conta da empresa, um administrador deverá acessar o Portal com um CPF com vínculo e aceitar os termos para que as credenciais sejam disponibilizadas.

  1. Inserindo as credenciais na Kobana

De forma segura, copie as credenciais geradas (Client ID, Client Secret e Application Key) e acesse sua conta na Kobana.

Vá no menu Integrações > Conexões. Crie uma nova conexão e selecione o Banco do Brasil. Dê um nome para a conexão, como, por exemplo "PIX - BANCO DO BRASIL - NOME DA EMPRESA". Em seguida, selecione o PIX como permissão da API e insira as credenciais até validar com sucesso a conta.

  1. Criando a conta PIX

Agora você deve criar uma conta PIX para associar à conexão com o banco. Acesse o menu Cobrança > Configurações > Contas PIX e clique para criar uma nova conta.

Cadastre os dados o nome da conta (ex.: PIX - BANCO DO BRASIL - NOME DA EMPRESA), a chave PIX e selecione a conexão que você criou no passo anterior.

  1. Gerando o PIX e boletos-híbridos

Finalizando os passos acima, você poderá começar a gerar o PIX e o boleto-híbrido.

Para geração do boleto-híbrido, inclua a conta PIX em uma de suas carteiras de cobrança, para fazer isso acesse o menu Cobrança > Configurações > Carteiras. Clique em Ver Carteira (👁️) naquela que deseja configurar o boleto-híbrido. Na próxima tela clique em Ações > Alterar. No final da página de edição da carteira, você visualizará informações sobre o boleto-híbrido e a opção de selecionar a conta geradora do PIX. Selecione a conta PIX que desejar para esta carteira. Pronto! A partir de agora todos os boletos dessa carteira serão gerados acompanhados de um QR Code do PIX.

Para geração apenas do PIX, desacompanhado de um boleto, você deve consultar nossa documentação técnica. Atualmente, não é possível gerar apenas o PIX através da nossa interface.

O QR Code do PIX que geramos é dinâmico, ou seja, ele é gerado de acordo com valores e dados que você cadastrou no boleto. Porém, ele não obedece regras do boleto, como desconto, juros e multa. Quando utilizado em modelo boleto-híbrido, o PIX é baixado no vencimento do boleto.

Ativando os webhooks

Com o sucesso da conexão acima, a confirmação de pagamento dependerá de uma consulta da Kobana que acontece de hora em hora. Para que essas confirmações ocorram em tempo real é necessário ativar os webhooks do banco. Para fazer isso, siga os passos abaixo:

  1. Solicitando a URL do webhook

Através do seu login, solicite em nosso chat na interface a URL correspondente ao webhook da sua conta PIX.

  1. Acessando o Portal Developers do Banco do Brasil

Acesse o Portal Developers do Banco do Brasil com o seu login e senha: https://app.developers.bb.com.br/

Selecione a aplicação em produção que está conectada à Kobana.

No menu esquerdo que aparecerá, clique no sino, que representa a parte de webhooks.

Clique no botão Cadastrar Novo Evento.

Como neste artigo estamos tratando da parte de PIX, agora você vai selecionar a API de PIX.

Caso tenha interesse em utilizar para boletos, também, acesse este artigo: Como ativar a comunicação via API cobrança do Banco do Brasil?

Insira a chave PIX correspondente e cadastrada na Kobana para essa conta, inclua a URL disponibilizada pela nossa equipe para recebimento das notificações e o e-mail caso haja necessidade de um contato do banco.

Deixe o evento PIX Recebido selecionado e defina o status dele como Ativado. Cliquem em Salvar para finalizar.

Como fizemos?

Como cancelar um boleto?

Como permitir que o vencimento ocorra no final de semana?

Contato