OS 105540 – MELHORIA – CONTAS A PAGAR E CONTABILIDADE – PAGAMENTOS VIA API DO BANCO DO BRASIL
Objetivo
Atualizar o processo SISPAG do Banco do Brasil para utilizar as APIs de Pagamentos em Lote, mantendo o fluxo de remessa e retorno e permitindo o processamento de pagamentos por boleto, transferência e PIX.
Premissas
- Necessário o ambiente estar atualizado com as versões:
- Contas a Pagar: xxx ou superior;
- Contabilidade: xxx ou superior.
- Portador do Banco do Brasil já cadastrado.
- Dados válidos do convênio, conta, certificado e credenciais disponíveis para a configuração.
- Em homologação, utilização de dados fictícios.
Atenção: As credenciais, certificados, convênios e dados de produção devem ser fornecidos e validados pelos responsáveis autorizados. Não utilize dados reais em ambiente de homologação.
Cenário 01: Configurar o portador e a integração via API
Objetivo: Habilitar o portador e configurar a integração necessária para o envio eletrônico.
Pré-condição: Possuir as credenciais e os dados de convênio correspondentes ao ambiente utilizado.
Resultado Esperado: O Banco do Brasil fica habilitado para envio via API, com autenticação OAuth2, parâmetros do ambiente preenchidos e layout do SISPAG definido como API.
Passo a passo:
- Acesse Contas a Pagar > Cadastros > Portadores.
- Localize o portador do Banco do Brasil.
- Habilite o modelo de pagamento via API.
- Acesse os parâmetros de WebService do Banco do Brasil disponíveis no ambiente.
- Configure a autenticação OAuth2 e informe os parâmetros, certificado e credenciais correspondentes ao ambiente de homologação ou produção.
- Configure o convênio, a conta bancária e o layout do SISPAG como API.
- Salve as configurações e valide se o portador está disponível para a preparação do borderô eletrônico.
Cenário 02: Cadastrar os tipos de pagamento da API
Objetivo: Cadastrar os tipos de pagamento utilizados nos envios ao Banco do Brasil.
Pré-condição: Portador e integração via API configurados.
Resultado Esperado: Os tipos 126 - Fornecedores, 127 - Salários e 128 - Diversos ficam disponíveis para a preparação de borderôs de pagamento pela API.
Passo a passo:
- Acesse o cadastro de Tipos de Pagamento disponível no ambiente.
- Localize ou cadastre o tipo 126 - Fornecedores.
- Localize ou cadastre o tipo 127 - Salários.
- Localize ou cadastre o tipo 128 - Diversos.
- Configure os tipos para utilização no pagamento via API do Banco do Brasil.
- Salve e valide se os tipos ficam disponíveis na preparação do borderô eletrônico.
Cenário 03: Preparar borderôs de pagamento
Objetivo: Preparar os lotes que serão enviados ao Banco do Brasil pela integração.
Pré-condição: Existir títulos aptos para pagamento e tipos de pagamento configurados.
Resultado Esperado: Os borderôs de boleto, PIX e transferência são criados para o Banco do Brasil e permanecem disponíveis para envio.
Passo a passo:
- Acesse a rotina de preparação do borderô eletrônico.
- Selecione o Banco do Brasil como banco de pagamento.
- Inclua os títulos que serão enviados.
- Prepare os lotes conforme a forma de pagamento: boleto, PIX ou transferência.
- Confirme a criação dos borderôs.
- Verifique se os borderôs aparecem como aguardando envio.
Cenário 04: Enviar os pagamentos pela API
Objetivo: Enviar os borderôs preparados ao Banco do Brasil.
Pré-condição: Existir borderô aguardando envio e o portador estar configurado para utilizar o layout API.
Resultado Esperado: O sistema identifica o layout API, envia os lançamentos ao Banco do Brasil e registra o identificador de pagamento retornado para cada lançamento processado.
Passo a passo:
- Acesse os borderôs preparados para o Banco do Brasil.
- Selecione o borderô que será enviado.
- Clique em Enviar.
- Aguarde o processamento da integração.
- Confirme a mensagem de processamento e consulte os lançamentos na interface de monitoramento.
Cenário 05: Monitorar e sincronizar os lançamentos
Objetivo: Acompanhar a situação dos pagamentos e atualizar o ERP com o retorno do banco.
Pré-condição: Existir lançamento enviado ou registrado no Banco do Brasil.
Resultado Esperado: A interface apresenta os lançamentos, a situação do pagamento, a ocorrência, o identificador de pagamento e a data da última sincronização. A ação de sincronização atualiza os dados retornados pelo banco.
Passo a passo:
- Acesse a interface de monitoramento dos lançamentos.
- Utilize os filtros de Banco, Data Movimento e Forma de Pagamento, quando necessário.
- Consulte os lançamentos apresentados no grid.
- Selecione os lançamentos que deseja atualizar.
- Clique em Sincronizar lançamentos.
- Verifique a situação retornada e a data de Última sincronização.
- Consulte o campo Ocorrência quando o banco retornar uma inconsistência.
- Utilize o identificador de pagamento para localizar o lançamento no acompanhamento do banco, quando necessário.
As situações podem indicar, conforme o retorno do banco:
- REGISTRADO: lançamento recebido e registrado sem erro inicial;
- PENDENTE / CONSISTENTE: lançamento enviado e aguardando processamento;
- REJEITADO / INCONSISTENTE: lançamento com inconsistência registrada;
- BLOQUEADO: lançamento bloqueado pelo banco;
- PAGO: lançamento liberado e pago, apto para a baixa no ERP.
Cenário 06: Cancelar lançamentos e reabrir títulos
Objetivo: Cancelar lançamentos não pagos e reabrir os títulos no ERP.
Pré-condição: Existir lançamento não baixado e não pago.
Resultado Esperado: Os lançamentos aptos são cancelados, o borderô é excluído quando todos os seus lançamentos são cancelados com sucesso e os títulos são reabertos para novo processamento. Lançamentos pagos não são reabertos.
Passo a passo:
- Acesse a interface de monitoramento dos lançamentos.
- Para cancelar o borderô, utilize Cancelar Lançamentos/Borderô.
- Para cancelar somente alguns lançamentos, marque os itens desejados e clique em Excluir selecionados.
- Para cancelar um item, utilize a opção de exclusão individual do lançamento.
- Utilize Marcar todos ou Desmarcar todos para controlar a seleção do grid.
- Confirme o cancelamento.
- Verifique se os lançamentos não pagos foram reabertos no ERP.
- Quando o lançamento já tiver sido enviado ao banco, consulte a ocorrência do cancelamento e o resultado da comunicação com o banco.
Cenário 07: Confirmar a baixa após o retorno PAGO
Objetivo: Confirmar a atualização do ERP quando o banco retornar o pagamento como realizado.
Pré-condição: Existir lançamento enviado e posteriormente retornado pelo Banco do Brasil com situação PAGO.
Resultado Esperado: O ERP atualiza a situação do lançamento, registra a sincronização, executa a baixa e gera os lançamentos contábeis correspondentes. Após a baixa, o título não pode ser sincronizado novamente, cancelado ou reaberto.
Passo a passo:
- Acesse a interface de monitoramento dos lançamentos.
- Sincronize o lançamento enviado ao Banco do Brasil.
- Confirme que a situação retornada é PAGO.
- Consulte a baixa do título no Contas a Pagar.
- Consulte os lançamentos contábeis gerados pela baixa.
- Verifique que o título baixado não está disponível para nova sincronização, cancelamento ou reabertura.
Observação: No ambiente de homologação do Banco do Brasil, algumas situações podem ser simuladas ou bloqueadas pelo próprio banco. A validação definitiva do fluxo de autorização e pagamento em produção depende das credenciais, certificados, convênio e alçadas liberados para o ambiente produtivo.
ATENÇÃO: As informações neste documento são meramente ilustrativas e utilizadas apenas para fins de teste.