EME4 – Pagamento Automatizado: Operação Remessa/Retorno via API Banco do Brasil

Por

EME4 – Versão 05.10.00 | Como realizar transferência de dados via API do Banco do Brasil

Configuração

Parametrização Serviços Pagamentos e OAuth

Integração Externa > Integração WS > Configurações Integração WS
 
No caso de uso Configurações Integração WS  é feita a publicação das configurações WS dos itens Payments-VPN e OAuth (Imagem 1)
Imagem 1
 
Ao editar as configurações de OAuth e Payments-VPN (Imagem 2), os links dos end points publicados são de homologação e antes de utilizá-los em produção deve-se remover o “.hm” da URL. Além disso, é necessário configurar as chaves de credencial Client_ID e Client_Secret, localizadas na aba Parâmetros Autenticação/Autorização (Imagem 3)
      Imagem 2         
 
Para mais instruções sobre como gerar o token das chaves , acesse o link abaixo:
*Para informação a respeito de acesso à documentação entrar em contato com equipe de Qualidade do EME4
         
Imagem 3               
 
Assim como na parametrização do OAuth, o item Payments-VPN também precisa ser configurado para os links não apontarem para base de homologação (Imagem 4). Além disso, na aba Parâmetros Autenticação/Autorização é necessário configurar também a chave X-Developer-Application-Key       

Imagem 4

 

Deve-se editar as configurações de integração WS Payments-VPN e preencher os valores das chaves path_crt_file e path_key_file com o caminho/arquivo crt.PEM e key.PEM (Imagem 5). Os arquivos devem ser gerados pela Infra (certificado digital)  e disponibilizados em pasta para configuração;

Imagem 5

*Lembrando que o arquivo de key deve ser gerado descriptografado, segue abaixo inclusive comandos executados para geração dos mesmos:

openssl pkcs12 -in “C:\Certificado\2021\Datainfo Matriz SP\datainfo_matriz_SP.pfx” -nocerts -out “C:\Certificado\2021\Datainfo Matriz SP\datainfo_matriz_SP_new.key.pem”

openssl pkcs12 -in “C:\Certificado\2021\Datainfo Matriz SP\datainfo_matriz_SP.pfx” -clcerts -nokeys -out “C:\Certificado\2021\Datainfo Matriz SP\datainfo_matriz_SP_new.crt.pem”

openssl rsa -in “C:\Certificado\2021\Datainfo Matriz SP\datainfo_matriz_SP_new.key.pem” -out “C:\Certificado\2021\Datainfo Matriz SP\datainfo_matriz_SP_new_decritpy.key.pem”

Definir Formas de Pagamento 

Financeiro > Operações Bancárias > Config. Informações Bancárias
As configurações de Informações Bancárias  permitem definir um Layout Padrão de Pagamento, acessando as abas Nosso Número > Pagamento Automatizado (Imagem 6).
É recomendado usar a opção Layout via API Quando a API do Banco do Brasil é usada com frequência pelo usuário;
Além disso, acessando a aba Formas de Pagamento por Recurso API é possível definir a forma de pagamento que será utilizada para recursos API 

Imagem 6

Consultar Ocorrências Retorno Pagamento

Financeiro > Operações Bancárias > Pagamento Automatizado > Carregar Ocorrências Retorno Pagamento

É possível carregar as ocorrências de retorno para que os tipos de retorno de pagamento do layout via API sejam importados (Imagem 7)

Imagem 7

Configurar Tipo Documento e Histórico Padrão Retorno API

Elementos Fundamentais > Config. Gerais > Parâmetros Filiais > Financeiro > Pagto Automatizado
Na aba Pagamento Automatizado (Imagem 8) é configurado o Tipo de Documento e Histórico Padrão para retorno de pagamento (pois será gerado automaticamente a partir de consumos que o ERP fará as API’s do Banco)

Imagem 8

Configurar Tarefas Agendadas 

Relatórios e Indicadores > Agendar Tarefas

Por fim, basta criar tarefas agendadas para realizar o envio de dados e checar a comunicação do EME4 com a API do Banco do Brasil, sendo parte fundamental para que a comunicação aconteça (Imagem 9, Imagem 10).

Imagem 9         

 

 Imagem 10

Funcionamento

Preparo de Remessas a serem integradas

Financeiro > Operações Bancárias > Pagamento Automatizado > Preparar Remessa

O caso de uso Preparo Remessa (Imagem 11), inserido no grupo Pagamento Automatizado, é onde são criados os Borderôs e onde irá ocorrer os movimentos de criação e cancelamento de remessas.

Imagem 11

 

Para incluir um novo registro de Preparo de Remessa, é necessário informar inicialmente a Conta Bancária que fará parte da operação. Após isso pode ser feita a configuração de Layout e Status Envio do Preparo Remessa (Imagem 12).

O Layout é definido de acordo com a necessidade da operação. Quando a operação padrão utilizada no sistema para Movimentação de Remessas é pela API, o recomendado é utilizar a opção [Layout Via API].

Já no campo Status Envio, Os status possíveis para envio a API são:
–Nenhum: Status padrão caso não seja [Layout Via API];
–Rascunho: Usuário ainda irá validar as informações;
–Aguardando Envio: Aguardando envio por agendamento/na confirmação do borderô.

Imagem 12

 

Após a definição de Layout e Status Envio, basta que seja incluído um ou mais Itens Borderô, localizados na aba Itens Borderô B. Brasil (Imagem 13). Quando confirmado o registro, a tarefa agendada configurada pelo consultor irá realizar a comunicação com a API

Imagem 13

 

*Lembrando que opções nos Borderôs como Forma de Pagamento necessitam estar alinhadas com as informações fornecidas nas configurações da API. Caso não estejam, irá aparecer uma mensagem indicando qual informação está incongruente e qual o caso de uso no qual essa configuração foi definida (Imagem 14) 

Imagem 14

 

O cancelamento, assim como o Preparo de Remessa também é feito no Caso de Uso Preparar Remessa (Imagem 15).

Imagem 15

 

Após o registro de Preparo Remessa, é possível ainda conferir o estado de envio que a Remessa se encontra:

-Erro Envio: Caso ocorra algum erro no envio como: sem acesso à internet e falta de comunicação com o serviço/API do banco (grid em vermelho);

-Enviado sem Inconsistências: A remessa foi enviada sem retorno de erros de validação, ou seja, todas as parcelas foram entregues ao banco sem ressalvas/informações incorretas (grid em cinza);

-Enviado com Inconsistências: Caso a remessa tenha sido enviada ao banco com sucesso, porém alguma parcela a ser paga retornou com erro de informações erradas (grid em vermelho claro);

-Enviado/Rejeitado com Inconsistências: Caso a remessa tenha sido enviada ao banco com sucesso, porém todas as parcelas a serem pagas retornaram com erro de informações erradas/inconsistências (grid em vermelho claro).

 

Retorno de Remessas integradas

Financeiro > Operações Bancárias > Pagamento Automatizado > Receber Retorno
 
No caso de uso Receber Retorno é possível verificar se os retornos de pagamento estão comunicando com API (Imagem 16)

Imagem 16

Resumo

  • Preparo e Retorno de Remessas são realizados dentro de Pagamentos Automatizados;
  • Para Cancelar uma Remessa comunicada com a API do Banco do Brasil basta usar a operação no próprio caso de uso Preparar Remessa;
  • É possível durante o processo visualizar os status de envio dos registros, como forma de controle das informações que estão sendo comunicadas ao Banco.

2022046812