Banco do Brasil

Passo a passo para gerar as Credenciais Pix Online no Portal Developers - Banco do Brasil

O primeiro passo para utilizar o Pix Online via API do Banco do Brasil é obter as credenciais de acesso. Este processo inicia-se com o contato ao cliente, preferencialmente por ligação, explicando a necessidade de obtenção das credenciais junto ao Banco do Brasil para a configuração do Pix Online no sistema.

O cliente deverá acessar o Portal Developers BB através do link: Portal Developers BB

Ao acessar o portal, será necessário realizar um cadastro completo utilizando o CPF e os dados da conta bancária. É fundamental que todas as informações fornecidas estejam corretas e atualizadas para garantir o acesso às funcionalidades do Pix via API.

O processo de cadastro é simples, mas requer atenção aos detalhes. O cliente deverá preencher todos os campos obrigatórios e seguir as instruções apresentadas na tela. Após a conclusão do cadastro, o cliente terá acesso ao Portal Developers BB, onde poderá prosseguir com a criação da aplicação necessária para gerar as credenciais de integração com o Pix.

Criação da Aplicação para Gerar as Credenciais

Após concluir o cadastro no Portal Developers BB, o cliente deverá criar uma aplicação dentro do portal para que as credenciais de integração com o Pix via API sejam geradas.

Criando uma Nova Aplicação

O primeiro passo é clicar em "Criar nova aplicação" no painel principal do Portal Developers. Ao fazer isso, será exibido um formulário para preenchimento com os seguintes campos:

Nome da Aplicação: Recomenda-se utilizar "Pix Online + Razão Social" para facilitar a identificação

Descrição: Informar a finalidade da aplicação, por exemplo: "Integração Pix Online - eSistemLoja"

Selecionando a API Necessária

Após preencher os dados básicos da aplicação, o cliente deverá clicar na aba "APIs com contratação online pelo Portal Developers BB" e selecionar a API necessária para a integração com o Pix. É fundamental selecionar corretamente a API relacionada ao Pix conforme a necessidade específica da integração.

Finalizando a criação e enviando para produção

Após selecionar a API desejada, o cliente deverá clicar no botão "Criar" para concluir o processo de registro da aplicação. Em seguida, deverá localizar a aplicação recém-criada na lista e clicar sobre seu nome para acessar os detalhes e configurações. Na tela de detalhes, após conferir todas as informações preenchidas, o cliente deverá clicar no botão "Enviar para Produção".

Vinculação ao CNPJ e Acesso às Credenciais

Após enviar a aplicação para produção, o próximo passo é vincular a aplicação ao CNPJ da empresa. Esta etapa é fundamental para estabelecer a relação legal entre a aplicação e a empresa que utilizará o serviço de Pix Online.

Vinculando a Aplicação ao CNPJ

Após inserir o CNPJ, é necessário clicar no botão "Pesquisar CNPJ" para validar a informação. É extremamente importante inserir o CNPJ correto, pois ele vincula a aplicação legalmente à empresa.

Aceitando o Termo de Adesão

Após a validação do CNPJ, o cliente deverá clicar em "Próximo" para avançar. Será apresentado o termo de adesão em formato PDF. É necessário rolar o documento até o final para habilitar a opção de concordância. Após aceitar o termo, as credenciais de produção serão geradas automaticamente.

Acessando as Credenciais

Para acessar as credenciais geradas, o cliente deverá retornar à tela inicial do Portal Developers BB, localizar e clicar na aplicação que foi criada. Na tela com as informações detalhadas da aplicação, deverá clicar na aba "Credenciais" para visualizar:

• Application Key

• Client ID

• Client Secret

Importação do Certificado

Para que a aplicação funcione corretamente, é necessário importar o arquivo de certificado "certificado_cadeias.pem" pelo Portal Developers do Banco do Brasil. Esta etapa é fundamental para o funcionamento da aplicação.

Localizando a Seção de Certificados

O cliente deverá localizar a aplicação criada no Portal Developers BB e acessar a seção "Certificados". Esta área é dedicada ao gerenciamento dos certificados digitais que garantem a segurança da comunicação com a API do banco.

Enviando o Certificado

Dentro da aplicação criada, o cliente deverá localizar a opção "Enviar Certificado" e utilizá-la para fazer o upload do arquivo "certificado_cadeias.pem", que é necessário para o correto funcionamento da aplicação. O processo de upload é simples, mas requer atenção para garantir que o arquivo correto seja enviado.

Execução Script criado pelo Devel para liberações

A execução do Script tem como finalidade ajustar alguns parâmetros do sistema operacional para garantir o correto funcionamento da aplicação, conforme definido pelo setor de desenvolvimento.

Instruções de Execução:

• Clique com o botão direito em “Windows PowerShell” e execute como administrador.

• Copie o script e cole no PowerShell e rode o Script.

O Script pode ser solicitado ao supervisor Cristiano e em casos de dúvidas também.

Configuração das Credenciais no eSistemLoja

Após obter as credenciais e configurar o certificado no Portal Developers BB, é necessário configurar essas informações no sistema eSistemLoja para habilitar o funcionamento do Pix Online. Este processo envolve várias etapas que devem ser seguidas com atenção.

Configuração Inicial

Antes de iniciar a configuração, é fundamental certificar-se de que todos os sistemas (eSistemLoja/Api, eSistemNFC-e, Integra) estejam devidamente atualizados. Caso algum sistema não esteja na versão mais recente, será necessário realizar a atualização para garantir a compatibilidade com a integração do Pix Online.

Configurações Gerais no Sistema

O primeiro passo é acessar a aba "Financeiro" no sistema eSistemLoja e cadastrar corretamente a conta do Banco do Brasil do cliente com todos os dados necessários. Esta etapa é fundamental para estabelecer a conexão entre o sistema e a conta bancária que receberá os pagamentos via Pix.

Configuração do Pix On-Line (QR Code Dinâmico)

Para habilitar o Pix On-line é necessário realizar os seguinte procedimentos:

• Acessar o módulo de configuração do Pix On-line no sistema

• Marcar a opção "Habilitar Pix On-line - QR Code Dinâmico"

• No campo de Gateway, selecionar Banco do Brasil

• Preencher o campo "Certificado PFX" com o nome exato do arquivo PFX e sua senha correspondente

• Marcar a opção "Produção"

• Selecionar a conta do Banco do Brasil cadastrada anteriormente Inserir a chave Pix vinculada à conta

❗Observação Importante: Para que a aplicação funcione corretamente, o arquivo do certificado digital (.pfx) deve estar presente na pasta do Banco do Brasil, no caminho: \eSistemLojaAPI\Certificate\BancoDoBrasil\

Configuração no eSistemNFC-e e Testes

Além da configuração no eSistemLoja, também é necessário configurar o Pix Online no sistema eSistemNFC-e para garantir o funcionamento.

Configuração Pix-Online no eSistemNFC-e

Para configurar o Pix Online no eSistemNFC-e, siga os passos abaixo:

1. Acesse o menu Configurações > Venda > Carteiras Digitais > Pix

2. Verifique se a API está comunicando corretamente com o sistema.

3. Marque a opção "Habilitar Pix On-line" conforme demonstrado na imagem de referência

4. Selecione o Gateway do Banco do Brasil

5. Insira a Chave Pix fornecida pelo cliente

6. Clique em "Salvar" para aplicar as alterações

Observações: Certifique-se que a API esteja ativa e em funcionamento no caixa para evitar problemas na comunicação

Teste do Recurso

Após concluir todas as configurações, é fundamental realizar um teste com o cliente utilizando a forma de pagamento Pix Online durante uma venda. Este teste permitirá verificar se o QR Code dinâmico é gerado corretamente e se a transação é concluída com sucesso.

Durante o teste, observe atentamente o processo completo, desde a geração do QR Code até a confirmação do pagamento no sistema. Verifique se todas as informações estão sendo exibidas corretamente e se o sistema está processando adequadamente a transação. Caso ocorra algum problema, verifique as configurações e certifique-se de que todos os passos anteriores foram seguidos corretamente.

Gerenciamento das Transações Pix

Após a configuração completa e os testes bem-sucedidos, é importante compreender como gerenciar as transações Pix realizadas através do eSistemLoja.

No retaguarda do sistema, o cliente pode acessar a aba Financeiro > Transações Pix. Nesta seção, é possível visualizar e gerenciar todas as transações realizadas via Pix On-line. A interface permite consultar detalhes de cada transação, como status, data e valor, facilitando o controle financeiro e operacional.

Status das Transações Pix: É fundamental compreender os diferentes status que uma transação Pix pode apresentar:

• Ativa: Uma transação PIX que foi criada e está aguardando o pagamento.

• Concluída: Uma transação PIX que foi criada e teve o pagamento identificado pelo sistema.

• Devolvida: Uma transação PIX que foi criada, teve o pagamento identificado, e posteriormente foi realizada a devolução através do botão Devolver.

• Pendente: Uma transação PIX que foi criada, teve o pagamento identificado, foi solicitada a devolução, mas por algum motivo ainda não foi identificada pela API a conclusão da devolução desta transação.

• Expirada: Uma transação PIX que foi criada, não teve o pagamento identificado, e chegou ao seu prazo de expiração. Ou foi solicitado o Cancelamento desta transação que anteriormente estava com status ATIVA.