01. VISÃO GERAL
Configurações necessárias para o registro de pagamentos por API do Banco do Brasil. Para testes em ambiente de homologação devem ser utilizados os dados fictícios para testes conforme documentação no Portal Developers BB.
02. CREDENCIAIS
É possível realizar a configuração da operação de extrato bancário e/ou registro online de pagamentos através das opções:
- API Extrato - Realiza a configuração das credenciais para operação de Extratos Bancários Automático (Funcionalidade em desenvolvimento).
- API Pagar - Realiza a configuração das credenciais para operação de registro online de pagamentos.
- Ambos - Realiza a configuração da credencias para operação de extrato bancário automático e registro online de pagamentos.
Para a configuração do layout será necessário obter junto ao Banco do Brasil as informações abaixo:
Application Key - Chave da aplicação: Chave de acesso do aplicativo
Client ID - ID do Cliente: Código de identificação do cliente
Client Secret - Chave Secreta do Cliente: Chave secreta de validação do cliente.
A comunicação entre o ERP e o banco acontece via autenticação mutua de certificados (mTLS), sendo assim será necessário solicitar os dados acima ao Banco do Brasil. Para mais detalhes acesse a documentação que está disponível no Portal Developers BB - Pagamentos.
Rede interna
Para a comunicação do Protheus com o banco é necessário configurar a segurança de rede, caso necessário, para aceitar a saída da faixa de IP referente ao DNS:
03. CERTIFICADO DIGITAL
Para promover a integração sistêmica de registro on-line de pagamentos, é necessário possuir Certificado Digital ICP Brasil do tipo A1. Você pode utilizar um certificado tipo A1 que já possua (por exemplo que utiliza nas transmissões das notas fiscais eletrônicas) ou solicitar um novo certificado junto ao Banco do Brasil. Para saber mais detalhes sobre o certificado digital, acesse os links abaixo:
Autenticação Mútua de Certificados (mTLS)
Após enviar ao Banco do Brasil o certificado A1 que será utilizado no processo, importar esse mesmo certificado pela rotina CFGX060 - Documento de referencia: https://tdn.totvs.com/x/viabEg.
A validação do certificado digital pelo (NGF) Novo Gestor Financeiro, se dará pela confirmação dos arquivos "CERT" e "KEY" que deverão estar gravados no caminho \CERT\NGF\{nome do arquivo}.
O nome dos arquivos deve ser composto por:
"nome do certificado".pem;
"nome do arquivo chave do certificado".pem.
IMPORTANTE:
a) Na geração do arquivo pelo módulo configurador (rotina CFGX060) serão gerados os arquivos com extensão .pem, os quais deverão ser renomeados manualmente para .key e .crt.
b) Caso os nomes dos arquivos sejam iguais, o usuário pode usar o texto "_key" e "_cert" para diferenciá-los.
c) A estrutura das pastas deverão ser criados abaixo do caminho informado no RootPath do arquivo server INI.
04. CADASTRO DE BANCO - MATA070
- Para habilitar a configuração de um layout para o Banco do Brasil deve ser informado no campo A6_BCOOFI ( Banco oficial ) o código 001.
05. PARÂMETROS DE BANCO - FINA130
- Número de convênio deve ser informado no campo Cod. Empresa(EE_CODEMP).
- ID da transação deve ser informado o sequencial utilizado para transacionar os pagamentos (EE_IDTRANS).
- Libera aut. campo que define se o pagamento entrará liberado na instituição financeira/Banco" (EE_LIBEAUT).
ATENÇÃO (campo EE_LIBEAUT)
É muito importante a configuração correta deste campo pois é ele quem define se o pagamento entrará liberado ou não. E mesmo que a configuração do cliente, dentro do Banco do Brasil, seja para que os pagamentos necessitem de aprovação, no caso deste campo estar configurado como liberação automática, isso fará com que o pagamento entre de forma liberada.
- Agência oficial deve ser informado o número da agencia oficial (EE_AGEOFI)
- Conta oficial deve ser informado o numero da conta oficial (EE_CTAOFI)
- Digito da conta oficial deve ser informado o digito verificador da conta oficial (EE_DVCTOFI)
06. BORDERO DE PAGAMENTOS
É possível gerar um borderô de pagamentos com registro online, para isso bastar acessar as rotina Borderô de pagamentos (FINA240) ou Borderô de pagamento com impostos (FINA241), ao preencher as informação do banco e subconta previamente cadastrados, será habilitado a opção Registro Online, ao marcar essa opção o borderô será marcado para registro online (EA_BORAPI = S).
Modelos de pagamentos (Tabela genérica 58 do SX5) homologados para transmissão:
- 30 - Transmissão de pagamento dos boletos gerados
- 31 - Transmissão de pagamento dos boletos gerados
- 01 - Transmissão de transferência entre contas
- 03 - Transmissão de transferência entre contas
- 41 - Transmissão de transferência entre contas
- 43 - Transmissão de transferência entre contas
- 13 - Transmissão de pagamentos de GUIA com código de barras
- 16 - Transmissão de pagamentos da DARF
- 18 - Transmissão de pagamentos da DARF
- 17 - Transmissão de pagamentos da GPS
- 45 - Transmissão de transferência PIX
07. PROBLEMAS COMUNS
- FALHA NA COMUNICAÇÃO COM O BANCO DO BRASIL, VERIFIQUE COM O BANCO SE O SERVIÇO...
- Essa mensagem poderá aparecer no monitor de pendencias após a transmissão de um pagamento para o banco, veja abaixo algumas das possibilidades que podem ocasionar esse problema:
- Verifique se os certificados estão na pasta correta "cert/ngf/", veja o tópico 3.
- Verifique se o nome dos arquivos esta correto, veja o tópico 3.
- Verifique se os certificados foram enviados corretamente para o banco.
- Essa mensagem poderá aparecer no monitor de pendencias após a transmissão de um pagamento para o banco, veja abaixo algumas das possibilidades que podem ocasionar esse problema:
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas