PIX: Banco do Brasil API V1
Índice
Configurações do Pix BB
PROFILE BB
Atenção! Caso não tenha nenhuma profile do Banco do Brasil no layout v2 homologada em seu sistema entre em contato com a equipe de suporte a homologação bancária para iniciar o processo.
Contratações da API PIX do BB realizadas a partir de Junho/2023 pertencem a modalidade V2. Caso tenha criado a aplicação a partir desta data então a sua API é do modelo V2, veja o passo a passo de como configura-la no ERP em PIX: Banco do Brasil API V2.
Cadastro PIX BB em Homologação
Para realizar testes da integração antes de disponibilizar os pagamentos para todos os clientes é possível configurar chaves de homologação. Deve ser utilizada uma conta (profile BB v2) já cadastrada no sistema, só é necessário solicitar o Client ID, Client Secret e Developer Api Key da conta. A solicitação é feita pelo Portal Developers BB . Ao acessar o portal faça a criação da conta de testes preenchendo as seguintes informações:
- Nome da aplicação: descrição identificativa (texto livre);
- Descrição: descrição identificativa (texto livre);
Selecione a opção APIs com contratação online pelo Portal Developers BB e após marque a opção PIX:
Para avançar clique em CRIAR. Acesse a área Consultar Credenciais para copiar os dados:
Configuração da profile de pagamento em ambiente de homologação
ACESSO: Configurações → Menu Financeiro → Submenu Profile de Pagamento → Boleto MK Ver. 2 - Edição, localize a profile do Banco do Brasil e então vai estar disponível a área PIX para inserir a configuração.
PIX BB
A área PIX fica disponível somente em profiles do Banco do Brasil
Nesta tela temos os seguintes campos:
- Chave PIX: Chave da conta do Banco do Brasil adquirida no site do BB. Enquanto estiver fazendo testes em homologação utilize uma das chaves abaixo:
- 7f6844d0-de89-47e5-9ef7-e0a35a681615
- 3d94a38b-f344-460e-b6c9-489469b2fb03
- d14d32de-b3b9-4c31-9f89-8df2cec92c50
- Credenciais: Seleção da credencial utilizada na conta/profile de pagamento;
- Status: da profile, selecione a opção:
- Homologação - Esta definição deve ser feita para que o provedor faça seus testes internos (com a chave pix e credenciais de homologação);
- Homologação - Esta definição deve ser feita para que o provedor faça seus testes internos (com a chave pix e credenciais de homologação);
- Hab. testes: Sim/Não;
- Cliente Homologação: Cadastro que será utilizado para os testes enquanto estiver com o status de Homologação, então somente este cadastro vai poder fazer os pagamentos pelo SAC;
- Testar comunicação: Teste de comunicação com o BB para confirmar se a chave e credenciais estão corretas;
- Cadastrar credenciais PIX: ao clicar neste botão será aberta nova janela onde deve ser inserida a configuração.
- Empresa: Em caso de multiempresa podem ser cadastradas credenciais específicas;
- Developer Application Key: Chave adquirida no site do BB;
- Client ID: Chave adquirida no site do BB;
- Cliente Secret: Chave adquirida no site do BB;
Requisitos para o cliente/cadastro utilizado para os testes de pagamento
O Banco do Brasil tem um banco de dados com vários documentos disponíveis para testes. Então pode ser utilizado um cadastro com CPF ou CNPJ válidos. Mas, caso um destes documentos não esteja cadastrado na base do BB o QRcode não será gerado e na ferramenta Transações via Pix vai ficar registrado o retorno de erro: documento inválido.
Abaixo segue listagem de CPFs utilizados com a finalidade de desenvolvimento justamente para que possam realizar testes de pagamento:
- 96050176876
- 66779051870
- 22902869150
- 97965940132
- 75069056123
Testes de pagamento
Após inserir as chaves de homologação devem ser realizados alguns testes para verificar a configuração feita e a comunicação entre o mk erp e a API do BB.
Testar comunicação
Para confirmar que as chaves de homologação estão corretas utilize a ferramenta Testar comunicação:
Este teste verifica se as chaves informadas na credencial estão corretas, se são do status selecionado (homologação) e se a comunicação com a API do BB está ok.
Ativar ferramentas PIX no SAC WEB
Para gerar o teste de pagamento do cliente selecionado na profile em homologação o PIX deve ser ativo no SAC WEB. Veja na documentação: Habilitar/Desabilitar pagamentos por PIX no SAC WEB
Testar a linha de pagamento gerada pelo QRcode
Para que o BB faça a análise da linha de pagamento o QRcode para uma fatura do cliente em homologação deve ser gerado no SAC e então a linha pode ser copiada. Veja na documentação: Efetuar pagamentos pelo SAC WEB
Faça a cópia do código e então acesse a área de testes: Sandbox BB
Acesse o menu API's > Simula pagamento de boleto e Pix :
Clique para expandir a ferramenta pix e após clique sobre POST para visualizar a tela abaixo.
Copie o código gw-app-key para o campo string:
Clique então sobre a opção Try it out e cole o código do QRcode (copiado do SAC do mk) e cole entre as aspas conforme destacado no Request body > após clique em Execute:
Aguarde o retorno e então a área responses vai ser atualizada. O exemplo abaixo é de um teste OK, observe o retorno "Pagamento efetuado com sucesso" no Response body:
Após este teste em cinco minutos o pagamento será enviado para o mk. A análise pode ser feita no Painel de acompanhamento das transações via PIX.
Cadastro PIX BB
Após realizar os testes de pagamento as chaves podem ser alteradas para as de produção. O suporte do BB disponibiliza o manual abaixo com o passo e o seu gerente de contas também pode auxiliar:
No canal do YouTube do BB também está disponível um vídeo que explica o processo: Como criar uma aplicação e conseguir suas credenciais - Portal Developers BB | BB.
Configuração da profile de pagamento em ambiente de produção
Após a configuração da conta em produção os dados na profile de pagamento BB v2 deve ser atualizados.
ACESSO: Configurações → Menu Financeiro → Submenu Profile de Pagamento → Boleto MK Ver. 2 - Edição, localize a profile do Banco do Brasil e então vai estar disponível a área PIX para inserir a configuração:
Importante
O cadastro dos dados de homologação e de produção é de responsabilidade exclusiva do provedor
Altere os seguintes campos:
- Chave PIX: Em ambiente de Produção, o cliente deve criar sua própria chave através de seu Internet Banking. É essa chave que vai ser informada no MK (recomendamos que utilize a opção de gerar chave aleatória);
- Credenciais: Seleção da credencial utilizada na conta/profile de pagamento. Clique em Cadastrar credenciais PIX para alterar os dados para as novas chaves de produção;
- Status: agora selecione a opção:
- Produção - Para quando a integração estiver em produção de fato (com a chave pix e credenciais de produção);
- Hab. testes: Não;
- Cliente Homologação: Retire o cadastro do cliente;
- Testar comunicação: Teste de comunicação com o BB para confirmar se a chave e credenciais estão corretas;
- Cadastrar credenciais PIX: ao clicar neste botão será aberta nova janela onde deve ser inserida a configuração com as novas chaves de produção;