GF - Como Fazer - Open Banking para Banco do Brasil

O que significa Open Banking?

Open Banking é um conceito relativamente novo na realidade do mercado financeiro brasileiro. Porém, ele tem ganhado cada vez mais atenção em todo o mundo. Traduzido, o termo significa “banco aberto”, mas uma tradução mais precisa seria “sistema financeiro aberto”. O conceito em si trata de algo de simples compreensão. Basicamente, Open Banking é a defesa de que o sistema financeiro adote a tecnologia de forma mais ampla e padronizada, como forma de incentivar e ampliar a oferta e a qualidade dos produtos e serviços financeiros. A base do Open Banking está na premissa de que os dados pertencem aos consumidores. Logo, caso eles autorizem, esses dados devem ser disponibilizados para que eles possam ter acesso a produtos e serviços que forem mais convenientes. Na prática, há um pedido para que as instituições abram suas API’s (sigla em inglês para Interface de Programação de Aplicativos) para que terceiros desenvolvam e aprimorem os sistemas e suas funcionalidades. O objetivo do Open Banking é desenvolver sistemas integrados, que facilitem o controle e transferência de informações de dados, histórico, contas, empréstimos etc. Todo o tipo de produto e serviço oferecido pelos bancos seria integrado de maneira a evitar processos complicados e dispendiosos. À primeira vista, pode parecer que com o Open Banking as informações dos clientes ficarão soltas e desprotegidas. No entanto, os bancos e instituições financeiras ainda serão responsáveis pela proteção de dados sigilosos.

Serviços Disponíveis pela API do Banco nesta Versão?

Menu > Utilidades/Diversos > Genéricos > Parâmetros > Configurações

SERVIÇO	COBRANÇA
GF	Permitir acesso aos Parâmetros PIX	Desmarcado
GF	Restringir Operações PIX por	Representante Unidade de Negócio Ambas Nenhum
FA	Permite efetivar doc. comercial com pgto PIX não confirmado	1 Permitir 2 Avisar 3 Bloquear

Como obter as Credenciais para utilizar a Funcionalidade Open Banking?

As credenciais do Banco do Brasil devem ser obtidas através do acesso ao Portal Developers (pdf caminho citado).
I:\CIGAM\Implementa\Documentos\Apoio a implementação\Open Banking Manual Banco\02 Portal Developers - Credenciais de produção.pdf

Este acesso deve ser feito pelo responsável da conta corrente na empresa. No momento da geração das credenciais devem ser incluídos os “Escopos” (Funcionalidades da API) tais como Cobrança, Pagamento e PIX.
Qualquer geração de credenciais com um contexto diferente deste, seja porque a pessoa a gerar as credenciais não é o responsável da conta ou por algum dos serviços tenha ficado de fora do escopo, irá resultar em erro no momento do uso da API.
Ex: {"statusCode":403,"error":"Forbidden","message":"Application key is not allowed to call this resource method"};”

Quais os Módulos necessários para utilizar a Funcionalidade Open Banking do Banco do Brasil”?

• Módulo Gestão Financeira;

 

Quais são as parametrizações necessárias para utilizar a funcionalidade do Open Banking?

Para utilizar esta funcionalidade é necessário possuir o Cadastro do Portador para o Banco do Brasil. O cadastro quando preenchido corretamente garante que não ocorrerá inconsistências no momento do registro do Open Banking.
Como boa prática de implementação é mais coerente criar um novo Portador para Open Banking evitando assim de alterar o Portador utilizado para CNAB caso necessite realizar algum processo via remessa ou retorno, quando a API do Banco estiver com instabilidade.
Essa parametrização deverá validar os últimos Sequenciais da numeração de Boletos do Portador utilizado para as Remessas, pois assim garante que não ocorrerá conflito enviar uma numeração de Título já registrado.

Itens Importantes na Parametrização:

- Processar retornos pelo número do Boleto: esta opção deve estar marcada, pois caso contrário ocorrerá problemas na gravação das informações e envio para Banco.

Caso tenha sido realizado movimentações com esta opção desmarcada, não será possível realizar a Baixa, pois sistema não consegue localizar devido não possuir o Nosso Número gravado nas tabelas envolvidas.

Para solucionar essa questão será necessário:

1- Identificar o Nosso Número do registro a ser baixado (Lançamento Financeiro);
2- Gravar o Nosso Número nas seguintes tabelas:
GFBOLETOS: campo a ser atualizado NOSSO_NRO com a informação do Nosso Número.
GFLAUXIL: campo a ser atualizado CODIGO_BARRAS com a informação do Nosso Número.

- A variação da Carteira do Banco do Brasil;
- Quando se tratar do Portador Open Banking do BB, o campo "Identificação do serviço" deve ser em Branco.
Para o correto funcionamento da rotina é necessário que os dados do Portador esteja com todas informações necessárias, inclusive o Convênio.
Menu > Finanças > Gestão Financeira > Parâmetros > Portadores
Este cadastro é apenas uma demonstração de parametrização:

Cadastro de Portador

Quando se tratar do Portador Open Banking do BB, o campo "Identificação do serviço" deve ser em Branco.

Convênio:
"Cada Conta Corrente é um Convênio" - (7 posições). "Uma Conta Corrente pode ter vários Convênios". "Quando tenho mais de um Convênio, muda o Código do Convênio e a variação da Carteira conforme a tabela abaixo:" Variação da Carteira (caso tenha mais de um Convênio):
019 (Código de 2 + DV)
027
035
043...

Carteira (Serviço):
011 - (Cobrança simples Boleto por correio)
031 - (Cobrança simples Vinculada)
017 - (Cobrança simples Imprime Boleto - considerado como Única)
051 - (Carteira Descontada), modalidade utilizada é 04.
Demais são considerados atributos.

Modalidades de Serviço do Banco do Brasil consideradas:
01 - Simples
04 - Vinculada (esta Modalidade esta atrelada somente a Carteira 051, logo não deve ser utilizada para outras Carteiras)
Regra do Sistema para Banco do Brasil Open Banking:
Identificador do Serviço: as opções para este campo são:
01 - Simples
04 - Vinculado
Valores diferentes destes serão tratados = 01 - Simples

Espécie: este campo para Open Banking é considerado para identificar o Tipo de Boleto de Cobrança. Quando este campo estiver em Branco o Sistema irá considerar sempre 04 - DUPLICATA SERVICO.
01 - CHEQUE
02 - DUPLICATA MERCANTIL
03 - DUPLICATA MTIL POR INDICACAO
04 - DUPLICATA SERVICO
05 - DUPLICATA SRVC P/INDICAO
06 - DUPLICATA RURAL
07 - LETRA DE CAMBIO
08 - NOTA DE CRÉDITO COMERCIAL
9- NOTA DE CREDITO A EXPORTACAO
10- NOTA DE CREDITO INDULTRIAL
11- NOTA DE CREDITO RURAL
12- NOTA PROMISSORIA
13- NOTA PROMISSORIA RURAL
14- TRIPLICATA MERCANTIL
15- TRIPLICATA DE SERVICO
16- NOTA DE SEGURO
17- RECIBO
18- FATURA
19- NOTA DE DEBITO
20- APOLICE DE SEGURO
21- MENSALIDADE ESCOLAR
22- PARCELA DE CONSORCIO
23- DIVIDA ATIVA DA UNIAO
24- DIVIDA ATIVA DE ESTADO
25- DIVIDA ATIVA DE MUNICIPIO
31- CARTAO DE CREDITO
32- BOLETO PROPOSTA
33- BOLETO APORTE
99- OUTROS

Guia CNAB

Guia Configurações

Irá surgir a necessidade de realizar a alteração de Vencimento, Multa ou Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?

Regra Sistema para Vencimento, Multa ou Juros:

Cadastro do Portador deve possuir Comando de Remessa com as novas opções:

Tipo de Comando = Alteração de Vencimento (para alteração de Vencimento).
Tipo de Comando = Alteração de Multa para Multa (para alteração de Multa).
Tipo de Comando = Alteração de Juros para Juros (para alteração de Juros).

Caso não seja parametrizado neste primeiro momento as opções de Multa e Juros o sistema cria automaticamente (Somente Juros e Multa).

Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo Multa de ou Juros de, automaticamente após alteração da Multa, o Sistema irá criar essa parametrização do Comando de Remessa com sugestão, sendo passível de alteração, no Cadastro do Portador no botão Remessas e depois no botão Comandos.

Comando sugestão para Multa:
Código Operação = ATM
Comando = ATM
Descrição = ALTERAÇÃO DE MULTA PARA OPEN BANKING
Tipo de Comando = Alteração de Multa

Comando sugestão para Juros:
Código Operação = ATJ
Comando = ATK
Descrição = ALTERAÇÃO DE JUROS PARA OPEN BANKING
Tipo de Comando = Alteração de Juros

Botão Remessas > Comandos

Botão Retornos > Códigos de Retorno

Para iniciar a configuração através do “Assistente de Parâmetros do Open Banking”, basta selecionar o botão “Open Banking”:
Menu > Finanças > Gestão Financeira > Parâmetros > Configuração de Bancos

Configurações de Banco

Para dar início ao processo de parametrização, basta selecionar o botão “Avançar”:

Tela Inicial Configuração do Assistente Open Banking:

IMPORTANTE: Devido a uma especificação do Banco do Brasil, as Credenciais do Banco geradas são válidas para o escopo de serviços (APIs) do Cliente no momento da sua criação.
Caso haja adição de novos serviços ao escopo do Cliente, por exemplo, Credenciais para a API de Cobrança e posteriormente adicione a API do PIX ao seu escopo, será necessário excluir as Credenciais Antigas no Portal Developers e criar novas, contendo as duas APIs.
Depois disso, ele deverá inseri-las no Sistema novamente, substituindo as antigas.

Para iniciar a configuração é necessário ter em mãos os seguintes dados: (Cliente, Chave de Autorização e Gw-app-Key). Sem essas informações não será possível dar continuidade na parametrização do Open Banking para o Banco do Brasil.

Tela Inicial Assistente de Parâmetros Open Banking

Etapa 1 (Parâmetros: Passo 1 de 4):

Uma das etapas mais importantes e que requer um cuidado maior e sigilo das informações nesta parametrização.
Essas informações são disponibilizadas pelo Banco a qual deve ser restrita somente a pessoa responsável pelo setor Financeiro da Empresa.
O assistente tem como objetivo proporcionar que o próprio usuário tenha autonomia para executar esse passo a passo sem necessidade de passar essas informações restritas da Empresa para qualquer pessoa que não seja ele mesmo.
Reforçando, mesmo que tenha dificuldades para executar esta etapa, não repasse nenhuma informação relacionado aos acessos dos tokens.
Dados em mãos para informar os respectivos campos, basta copiar e colar as informações.
Developer Application Key, Client Id, Cliente Secret, e o Scope que passa vir preenchido automaticamente por padrão.
Os campos:
Client ID e Client Secret possuem uma tecnologia de criptografia, ou seja, após informar os dados nos campos o sistema irá criptografar as informações garantindo e mantendo a segurança das informações.
Caso haja necessidade de alterações, basta clicar no ícone do "Cadeado", será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Confirmar".
Também tenha alguma dúvida no dado informado e necessitar validar o dado seguindo os mesmos passos da alteração será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Validar", sistema confirma se os dados são os mesmos.
Observamos que esta tela possui duas guias, uma de Homologação e Produção. Preencher conforme a necessidade do processo, caso precise realizar testes, parametrize em homologação e posteriormente parametrize o de Produção ou se preferir, pode preencher os dois se possuir os dados.
Lembrando que esses dados são confidenciais de uso e exclusivo de cada usuário.
Através dessas informações o sistema irá se comunicar com API do Banco para poder realizar os registros dos Lançamentos.
Após informado os dados, basta selecionar o botão "Avançar", para seguir os próximos passos.
Developer Application Key: conforme orientação do Banco esses dados são de cunho da própria Desenvolvedora de Software, ou seja, elas serão fixas do Sistema CIGAM, sendo setadas por padrão.
Client ID: Identificação da Aplicação, é necessário informar a codificação passada pelo Banco. Este dado é criptografado.
Client Secret: Credencial do banco, é necessário informar a codificação passada pelo Banco. Este dado é criptografado.

Parâmetros: Passo 1 de 4

Atualizado o Scope para Versão 2 do Open Banking sendo setado por padrão, para maiores informações acessar o título do Manual:
Quais são as novidades após atualização para Versão 2 do Open Banking?

Etapa 2 (Portador de Remessa e Retorno - Pagamento: Passo 2 de 4):

Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Pagamento (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Pagamento (onde serão liquidados os retornos de Pagamentos).
Nesta etapa, é possível pular, caso não utilize ainda o Envio de Pagamentos do Open Banking.
Pular: caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
Avançar: dá continuidade ao processo de parametrização, após selecionado uma opção.
Para continuar a parametrização selecione o botão "Pular" e siga para os próximos passos.

Portador de Remessa e Retorno: Passo: 2 de 4

Etapa 3 (Convênios de Cobrança: Passo 3 de 4):

Nesta etapa o sistema avalia sua base de dados, e localiza os Convênios parametrizados para o Banco do Brasil, onde serão listados. O sistema possibilita a parametrização de Convênios específicos bem como caso seja optado, selecionando o botão "Pular" o sistema criará automaticamente o Convênio "Geral", ao qual utiliza dados do Portador registrado.
Pular: caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
Avançar: dá continuidade ao processo de parametrização, após selecionado uma opção.

Convênios de Cobrança: Passo 3 de 4

Etapa 3 (Portador de Remessa e Retorno - Cobrança: Passo 3 de 4):

Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Cobrança (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Cobrança (onde serão liquidados os retornos de Cobranças).
Avançar: dá continuidade ao processo de parametrização, após selecionado uma opção.

Portador de Remessa e Retorno - Cobrança: Passo 3 de 4

Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
- Direto: esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
- PIX: esta opção tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção Direto marcado).
Esta opção é válida SOMENTE para o Banco do Brasil.
Para maiores informações acessar o título do Manual:
Quais são as novidades após atualização para Versão 2 do Open Banking?

Etapa 4 (Relatório: Passo 4 de 4):

Nesta etapa o sistema irá buscar automaticamente o Modelo de Relatório Padrão, caso exista no ambiente, facilitando assim todo processo de parametrização e implementação para usuário.
A busca é realizado (%CIGAM_INSTAL%RF00071_remessas.RTF), com isso é importante que o Modelo de Relatório (RF00071_remessas.RTF) esteja devidamente localizado na pasta padrão do Cigam_Instal, como por exemplo:
%CIGAM_INSTAL% = P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking
"P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking\Modelos\Relatorios\Gestao Financeira\RF00071_remessas.RTF"
Clicar em "Avançar" para dar seguimento.

Assistente de Parâmetros Open Banking: Passo 4 de 4

Etapa Conclusão (Parâmetros de Convênio Open Banking - Conclusão):

Esta etapa o sistema faz validação da comunicação com o Banco através da API verificando o ambiente se esta tudo ok, listando em tela.
Após a consulta estar "OK", basta clicar no botão "Concluir" e seu ambiente estará apto para utilizar a funcionalidade Open Banking.

Parâmetros de Convênio Open Banking: Passo Final - Conclusão

Homologação: Conexão realizada com sucesso.
Produção: O servidor remoto retornou um erro: (401) Não Autorizado. Isso ocorre quando não houve a parametrização dos dados em Produção como foi realizado no ambiente de Homologação conforme o passo a passo, ou possa ter ocorrido algum erro na comunicação com o Banco.

Convênio Cadastrado com Sucesso - Cobrança

Ambiente: lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
Convênios: neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
- Portador;
- Agência;
- Número Conta;
- Portador de retorno;
- Direto: esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
Também quando selecionada, terá uma particularidade na questão da Emissão de Boletos em lote pela Rotina de Emissão de Boletos Personalizados. A rotina na guia Opções tem a opção Enviar somente Lançamentos não marcados e marca-los, caso esteja desmarcada o Registro Open Banking ocorrerá da mesma forma que o sistema irá marcar a opção Boleto Impresso do Lançamento Financeiro, registrando a Operação Open Banking. Isso ocorre para manter a integridade, já que esta operação é considerada única no registro, sendo então necessário marcar a Boleto Impresso, para poder conseguir realizar alterações como Alteração de Vencimento ou mesmo a Baixa, sendo uma condição de Sistema.
- PIX: esta opção fica habilitada somente quando selecionado a opção Direto, ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção Direto marcado).
Esta opção é válida SOMENTE para o Banco do Brasil.
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
- Boleto Impresso;
- Remessa Enviada;
- Código de Barras Lido;
U.N Ced.: esta opção tem como finalidade possibilitar o envio e registro de Boletos de outras Unidades de Negócio.
Basta informar a Unidade desejada no campo e o sistema entenderá quando realizado o processo de registro de um título que não seja da Unidade Matriz, então sistema identifica e realiza o processo de envio e registro. Se deixar em Branco a Unidade Cedente irá considerar para todas Unidades de Negócio.

Convênio Cadastrado com Sucesso - Pagamento

Ambiente: lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
Convênios: neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
- Portador;
- Agência;
- Número Conta;
- Portador de retorno;

Ícone Credenciais

Através deste ícone é possível verificar os Parâmetros API parametrizados, tanto em homologação quanto em produção.

Ícone Endereços

Através deste ícone é possível verificar todos endereços de URLs parametrizados.

O que significa a Categoria Open Banking de acesso?

A Categoria Open Banking é uma Categoria que é habilitada mediante a utilização de um Portador parametrizado com as Configurações de Banco Open Banking. A mesma tem como objetivo proporcionar maior agilidade e gerenciamento das atividades relacionadas a Remessa de Cobrança Online.
Categoria Open Banking

Categoria Open Banking

Registrar: item de categoria tem como funcionalidade registrar o Boleto Bancário Online. Substitui todo o processo de geração do arquivo de Remessa de Cobrança, acessar o site e remeter ao Banco esse arquivo, com apenas um clique na opção.
Reenviar: item de categoria tem como funcionalidade possibilitar o reenvio de registros que estão com alguma pendência ou algum erro de parametrização. Será habilitado somente quando já possuir movimento de "Registro" enviado, cuja Situação estiver com pendência ou erro.
Baixar: item de categoria tem como funcionalidade comunicar o Banco referente a Baixa do movimento em questão do Boleto Bancário. Utilizado para eventuais falhas operacionais, como registrado um movimento por engano, ou negociações diretamente com cliente a parte. Eliminando então também todo processo de geração do arquivo de Remessa Bancária com Comando de Remessa de Baixa e o processo de remeter ao Banco o arquivo, sendo realizado tudo online através desta opção.
Registrar Alteração: item de categoria tem como funcionalidade registrar uma alteração ocorrida referente ao "Vencimento" do Lançamento Financeiro. Ao realizar alteração da Data de Vencimento do Lançamento Financeiro que está com "Situação Open Banking" igual "Registrado" e ocorrer alteração no Vencimento, o sistema emite uma mensagem possibilitando já o envio da alteração no momento ou mais tarde através desta opção de "Registrar Alteração".
Histórico: item de categoria tem como funcionalidade gravar todas movimentações realizadas relativo ao Open Banking. Registros, Baixas, Erros...

Como realizar a criação de Lançamentos utilizando a funcionalidade Open Banking?

Para a criação de Lançamentos Financeiros acessar o caminho de Menu:
Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos
Acessar o botão “Criar” e informar os dados necessários para a criação do Lançamento Financeiro a Receber utilizando o Portador parametrizado para Open Banking.

1- Etapa criação do Lançamento:

Criação do Lançamento Financeiro a Receber

2- Etapa Impressão do Boleto Bancário do Lançamento Financeiro:
Nesta etapa pode ser realizado a impressão do Boleto Bancário diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":

Impressão do Boleto Bancário do Lançamento Financeiro

3- Etapa do Registro do Boleto Open Banking:
Nesta etapa pode ser realizado o "Registro" do Boleto diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados": Basta acessar a Categoria "Open Banking" e selecionar o Item de Categoria "Registrar". Sistema irá realizar a comunicação através das parametrizações realizadas das Urls e Tokens de acesso e listará a situação do Registro do Boleto Bancário através do Relatório.

Registrar Boleto Open Banking através Lançamento Financeiro

Relatório Remessa Bancária OnLine

Após o registro automaticamente o sistema marca as opções de:
- Remessa Enviada
- Códigos de Barras Lido

Boleto Bancário Registrado

Para verificar todas as movimentações realizada sobre Open Banking, elas estão sendo gravadas no Item de Categoria "Histórico" que fica na Categoria "Open Banking". Ao selecionar o Item de Categoria "Histórico" deve listar o Registro do Boleto Bancário.

Item de Categoria Histórico de Movimentos Open Banking

Como realizar o Envio em Lote Open Banking através da rotina Remessa de Cobrança Open Banking?

Assim como é possível realizar o Envio do Registro do Boleto Bancário através do próprio Lançamento Financeiro, existe a possibilidade de realizar esse processo em Lote, quando se tratar de vários registros a serem enviados. Através do Menu:

Menu: Finanças > Gestão Financeira > Rotinas > EDI> Transmite > Remessa Cobranças Bancárias > Remessa de Cobrança Open Banking

Remessa de Cobrança Open Banking

Esta rotina tem um conceito muito simples em relação aos filtros, foram disponibilizados campos essências que permitem ter uma rastreabilidade dos movimentos.

Unidade de Negócio: informe a Unidade de Negócio desejada para realizar o filtro para busca dos movimentos.
Data: informe a Data desejada para realizar o filtro para busca dos movimentos.
Vencimento: informe o período de Vencimento desejado para realizar o filtro para busca dos movimentos.
Lançamento: informe a faixa de Lançamentos desejada para realizar o filtro para busca dos movimentos.
Tipo de Pagamento: informe o Tipo de Pagamento desejado para realizar o filtro para busca dos movimentos.
Série: informe a Série desejada para realizar o filtro para busca dos movimentos.
Nota Fiscal: informe a faixa de Nota Fiscal desejada para realizar o filtro para busca dos movimentos.
Conta Financeira: informe a Conta Financeira desejada para realizar o filtro para busca dos movimentos.
Empresa: informe a faixa de Empresa desejada para realizar o filtro para busca dos movimentos.
Cobrança: informe a faixa de Empresa de Cobrança desejada para realizar o filtro para busca dos movimentos.

Após informado os filtros e confirmado a operação da rotina o sistema gera um relatório com a listagem dos movimentos. Na coluna "Registro", será listado se houve a confirmação ou ocorreu algum erro.

Relatório Remessa de Cobrança Open Banking

Como realizar o Retorno de Cobrança Open Banking?

Esta rotina tem como funcionalidade realizar a consulta dos registros enviados para o Banco não só através do Open Banking como também títulos enviados pela rotina de Remessa Bancárias e efetuar as liquidações dos registros que já foram pagos ou baixados. Porém as buscas para títulos não gerados pelo CIGAM e o retorno do registro de baixa estão disponíveis apenas para Versão 2 da API do Open Banking.

Regras de Busca do Sistema para localizar os títulos a partir da Versão API = v2
1- O sistema tenta localizar os títulos pelo Número do Lançamento;
2- Caso os títulos tenham sido gerados pelo CIGAM irá localizar pelo Nosso Número, avaliando então a tabela GFBOLETOS pela coluna NOSSO_NRO.
3- Caso os títulos tenham sido gerados por outro sistema irá localizar pelo Nosso Número, avaliando então a tabela GFLAUXIL pela coluna CODIGO_BARRAS.
Como faço para atualizar com a nova Versão API = v2?

Simples acesse a opção do índice do Manual:
Quais são as novidades após atualização para Versão 2 do Open Banking?

Menu: Finanças > Gestão Financeira > Rotinas > EDI> Recebe > Retorno Cobranças Bancárias > Retorno de Cobrança Open Banking

Rotina Retorno de Cobrança Open Banking

Empresa: possibilita realizar o filtro por Empresa, consultando todos os registros da Empresa informada.
Unidade de Negócio: possibilita realizar o filtro por Unidade de Negócio.
Lançamento: possibilita realizar filtro por faixa de Lançamento.
Vencimento: possibilita realizar filtro por faixa de Vencimento.
Movimento/Registro: possibilita realizar filtro por faixa do período do Movimento ou do Registro. Data que delimita o período da Consulta de Boletos liquidados, Baixados ou Protestados.
Situação do Boleto: filtro com duas opções:
A - Em ser (abertos): listam os registros que se encontram com Status "Abertos" no Banco.
B - Baixadas/Protestados/Liquidados: listam os registros que se encontram com Status "Baixados/Protestados/Liquidados".
Cód. Situação Atual Boleto: listagem para realizar filtro através do Código da Situação do Boleto no Banco conforme layout.

Rotina Rotina Retorno de Cobrança Open Banking guia Parâmetros

Tipo de Retorno: há 3 opções para o retorno.
* Listagem: quando selecionado essa opção, ao executar a rotina, apenas listará o status do registro do Boleto Bancário junto ao Banco.
* Retorno: quando selecionado essa opção, ao executar a rotina, o sistema irá executar o retorno dos registros confirmados e já irá realizar a liquidação caso haja registros pagos, sem executar a listagem.
* Ambos: quando selecionado essa opção irá executar tanto a opção de "Listagem" quanto a opção de "Retorno".
Portador para Liquidação: este campo tem como finalidade informar qual será o Portador utilizado para os registros que serão liquidados. Caso não seja informado nenhum Portador neste campo, será utilizado o Portador de Retorno parametrizado para Open Banking.
Portador Carteira de Desconto: este campo é para informar o Portador de Carteira de Desconto, para Contratos Bancários, para os registros que possuem Duplicatas negociadas com o Banco.
Histórico de Liquidação: campo para informar o Histórico que será utilizado para os registros que serão liquidados.
Não contabilizar Juros e Descontos nas liquidações da Carteira Descontada: esta opção tem como finalidade não contabilizar os Juros e Descontos para as liquidações de Carteira Descontada, ou seja, caso possua duplicatas com o Banco negociada e o registro possuir Juros, Desconto, possibilita o usuário não contabiliza-los marcando esta opção.
Não gerar lançamentos de tarifa de cobrança: esta opção tem como finalidade quando selecionada não gerar a liquidação do valor da tarifa de cobrança.
Data para Liquidação: quando zerado a Data será habilitado para selecionar as opções. Esta opção tem como finalidade realizar a busca para liquidação de duas formas:
- Ocorrência: os títulos serão liquidados com a Data de Ocorrência do Título (Data Recebimento do Título) ao qual foi processado no Banco.
- Crédito: os títulos serão liquidados com a Data de Crédito (Data de Crédito Liquidação) em que foi processado no Banco. Ou seja, se o título foi pago por exemplo na Data 31/08/2020 o banco irá processar esse pagamento e o retorno será creditado na conta no dia 01/09/2020, porém o pagamento foi realizado no dia anterior e creditado no dia posterior.
A Data para Liquidação é trazida por padrão a Data atual como sugestão, sendo possível altera-lá ou quando zerada habilita para buscar automaticamente a Data de Ocorrência ou Crédito.

Modelo de Relatório: o modelo de relatório utilizado pode ser obtido através do caminho padrão. Nome do Modelo: (RF00071_remessas).

Relatório Retorno Bancário Online

Ao acessar o Lançamento Financeiro após o Retorno de Cobrança Open Banking, realizando as liquidações o sistema altera o status do Lançamento Financeiro.
Menu: Finanças > Gestão Financeira > Movimentos > Lançamentos

Lançamento Financeiro Liquidado através da Rotina de Cobrança Open Banking

Como realizar a Alteração de Vencimento do Lançamento já Registrado Open Banking e reenviá-lo novamente?

Irá surgir a necessidade de realizar a alteração do Vencimento do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?
Dado que já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos
Acessar o Lançamento Financeiro em modo Modificar e alterar o campo "Venc.Original", automaticamente após alteração do Vencimento, o sistema insere o Comando "05" no campo "Comando de Remessa" e diante disso já emite uma mensagem:
Confirma o envio da alteração do título ao banco?
Importante: para o envio da alteração do Vencimento o sistema já considera o campo Vencimento, caso seja utilizado a Modalidade como Seguinte por exemplo, onde é possível ter um Vencimento Original diferente do Vencimento.

Lançamento Financeiro a Receber já Registrado

Vencimento alterado, sistema insere o Comando "05" no campo "Comando de Remessa" e ao salvar o registro é emitido a mensagem: "Confirma o envio da alteração do título ao banco?"

Vencimento alterado e registro salvo

Sim: é enviado o registro de alteração do Open Banking e se registrado com sucesso, sistema retira então o Comando de Remessa.

Processo Concluído com Sucesso

Há possibilidades do tempo de comunicação com API do Banco não retornar imediatamente a confirmação do recebimento da Alteração do Vencimento. Quando ocorrer essa situação, sistema emite uma mensagem, solicitando aguardar, para tentar novamente o envio da alteração do vencimento. Quando ocorrer essa situação, será necessário aguardar e após realizar o envio novamente ou através do próprio Lançamento ou através da rotina de Remessa de Cobrança - Open Banking, que remeterá as alterações para o Banco.

Processo Pendente Alteração - Aguardar

Já quando selecionado a opção Não:
Não: não faz a comunicação do envio da alteração do vencimento via Open Banking. Este registro não foi notificado, logo será necessário realiza-lo através do próprio Lançamento ou através da rotina de Remessa de Cobrança Open Banking.
No Lançamento Financeiro é habilitado o botão "Reenviar Registro" no Item de Categoria "Open Banking". Quando selecionado o botão Registrar Alteração, sistema faz a comunicação via Open Banking e registra alteração de vencimento realizada.

Lançamento Não Registrado a alteração de Vencimento com o Comando de Remessa

Ao selecionar o botão "Registrar Alteração" sistema emite a mensagem para confirmar o envio.

Botão Registrar Alteração

Após a confirmação o sistema registra alteração

Processo Concluído com Sucesso

Lançamento alterado e registrado

Como realizar a Alteração de Multa do Lançamento já Registrado Open Banking e reenviá-lo novamente?

Irá surgir a necessidade de realizar a alteração da Multa do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?

Dado que já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:

Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos

Regra Sistema para Multa ou Juros:

Se no cadastro do Portador não possuir Comando de Remessa com as novas opções:
Tipo de Comando = Alteração de Multa para Multa
Tipo de Comando = Alteração de Juros para Juros

Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo Multa de, automaticamente após alteração da Multa, o Sistema irá criar essa parametrização do Comando de Remessa com sugestão, sendo passível de alteração, no Cadastro do Portador no botão Remessas e depois no botão Comandos.

Comando sugestão para Multa:
Código Operação = ATM
Comando = ATM
Descrição = ALTERAÇÃO DE MULTA PARA OPEN BANKING
Tipo de Comando = Alteração de Multa

Cadastro do Portador Comando de Remessa Multa

Como é identificado a alteração da Multa para Banco?

Através das tags enviadas para API gravadas no Histórico do Open Banking Dados API:

indicadorCobrarMulta:S – indica que há multa no registro.
indicadorDispensarMulta: S – indica que a multa foi zerada e não há mais ocorrência de multa para o registro enviado.
tipoMulta: 1, - indica que a Multa é maior que 0,01 centavo.
tipoMulta: 0, - indica que a Multa é menor que 0,01 centavo não registrando a operação de multa.
valorMulta: 0.44, - indica o valor da multa.
dataInicioMulta: "23.09.2021", - indica a data do movimento da alteração da multa enviado.

Lançamento Financeiro a Receber já Registrado alterando a Multa

Tags enviadas para API Banco:

Dados API Tags referente a Multa

Como realizar a Alteração de Juros do Lançamento já Registrado Open Banking e reenviá-lo novamente?

Irá surgir a necessidade de realizar a alteração de Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?

Dado que já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:

Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos

Regra Sistema para Multa ou Juros:

Se no cadastro do Portador não possuir Comando de Remessa com as novas opções:
Tipo de Comando = Alteração de Multa para Multa
Tipo de Comando = Alteração de Juros para Juros

Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo Juros Dias de ou Juros Mês de, automaticamente após alteração dos Juros, o Sistema irá criar essa parametrização do Comando de Remessa com sugestão, sendo passível de alteração, no Cadastro do Portador no botão Remessas e depois no botão Comandos.

Comando sugestão para Juros:
Código Operação = ATJ
Comando = ATJ
Descrição = ALTERAÇÃO DE JUROS PARA OPEN BANKING
Tipo de Comando = Alteração de Juros

Cadastro do Portador Comando de Remessa Juros

Como é identificado a alteração de Juros para Banco?

Através das tags enviadas para API gravadas no Histórico do Open Banking Dados API:

indicadorCobrarJuros:S – indica que há Juros no registro.
indicadorDispensarJuros: S – indica que o Juros foi zerado e não há mais ocorrência de Juros para o registro enviado.
tipoJuros: 1, - indica que os Juros é maior que 0,01 centavo.
tipoMulta: 0, - indica que os Juros é menor que 0,01 centavo não registrando a operação de Juros.
valorJuros: 0.46, - indica o valor dos Juros.

Lançamento Financeiro a Receber já Registrado alterando os Juros

Tags enviadas para API Banco:

'Dados API Tags referente aos Juros

Como realizar a Alteração dos 3 juntos (Vencimento/Juros/Multa) do Lançamento já Registrado Open Banking e reenviá-lo novamente?

Irá surgir a necessidade de realizar a alteração do Vencimento do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?
Dado que já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos
Acessar o Lançamento Financeiro em modo Modificar e alterar o campo "Venc.Original", automaticamente após alteração do Vencimento, o sistema insere o Comando "05" no campo "Comando de Remessa" e diante disso já emite uma mensagem:
Confirma o envio da alteração do título ao banco?
Importante: para o envio da alteração do Vencimento o sistema já considera o campo Vencimento, caso seja utilizado a Modalidade como Seguinte por exemplo, onde é possível ter um Vencimento Original diferente do Vencimento.

Lançamento Financeiro a Receber já Registrado

Vencimento alterado, sistema insere o Comando "05" no campo "Comando de Remessa" e ao salvar o registro é emitido a mensagem: "Confirma o envio da alteração do título ao banco?"

Vencimento alterado e registro salvo

Sim: é enviado o registro de alteração do Open Banking e se registrado com sucesso, sistema retira então o Comando de Remessa.

Processo Concluído com Sucesso

Há possibilidades do tempo de comunicação com API do Banco não retornar imediatamente a confirmação do recebimento da Alteração do Vencimento. Quando ocorrer essa situação, sistema emite uma mensagem, solicitando aguardar, para tentar novamente o envio da alteração do vencimento. Quando ocorrer essa situação, será necessário aguardar e após realizar o envio novamente ou através do próprio Lançamento ou através da rotina de Remessa de Cobrança - Open Banking, que remeterá as alterações para o Banco.

Processo Pendente Alteração - Aguardar

Já quando selecionado a opção Não:
Não: não faz a comunicação do envio da alteração do vencimento via Open Banking. Este registro não foi notificado, logo será necessário realiza-lo através do próprio Lançamento ou através da rotina de Remessa de Cobrança Open Banking.
No Lançamento Financeiro é habilitado o botão "Reenviar Registro" no Item de Categoria "Open Banking". Quando selecionado o botão Registrar Alteração, sistema faz a comunicação via Open Banking e registra alteração de vencimento realizada.

Lançamento Não Registrado a alteração de Vencimento com o Comando de Remessa

Ao selecionar o botão "Registrar Alteração" sistema emite a mensagem para confirmar o envio.

Botão Registrar Alteração

Após a confirmação o sistema registra alteração

Processo Concluído com Sucesso

Lançamento alterado e registrado

Quais são as novidades após atualização para Versão 2 do Open Banking?

Disponibilizado a Versão 2 para Open Banking que traz algumas novidades para o processo de Registro no Banco.
Para começar o que devo fazer para atualizar para Versão 2 do Open Banking?
Simples, basta atualizar com a versão que contempla aOS 664835/1.
Nela terá um componente que quando atualizado a Base através do Assistente de Atualização (Atualiza CIGAM) será adicionado nos Parâmetros Open Banking da Configuração de Bancos, especificamente nas Credenciais, o registro Versão API = v2.

Finanças > Gestão Financeira > Parâmetros > Configurações de Bancos

Parâmetros Open Banking

A partir desta Versão o Sistema passa a realizar a busca para localizar os títulos da seguinte forma:
1- O sistema tenta localizar os títulos pelo Número do Lançamento;
2- Caso os títulos tenham sido gerados pelo CIGAM irá localizar pelo Nosso Número, avaliando então a tabela GFBOLETOS pela coluna NOSSO_NRO.
3- Caso os títulos tenham sido gerados por outro sistema irá localizar pelo Nosso Número, avaliando então a tabela GFLAUXIL pela coluna CODIGO_BARRAS.

Também nesta versão estão disponíveis as tags para Envio da Série/NF, sendo utilizado a Tag na API NumeroTituloBeneficiario. A regra é Serie NF Complemento Duplicata, bem como descrito com espaços em Branco entre eles. Para verificar esse registro, basta acessar após o Registro no Banco o Histórico Open Banking na guia Envio e localizar para Tag NumeroTituloBeneficiario.

Quais são as mudanças ocorridas no Assistente de Parâmetros de Convênio Open Banking?

Para o Scope foi adicionado um novo complemento para atender ao PIX, logo o Scope passa a ficar desta forma por padrão:

cobrancas.boletos-requisicao cobrancas.boletos-info payments.transfer-batch-request payments.transfers-info payments.batch-slips payments.batch-barcode-collection-form-request cob.write cob.read pix.read pix.write
Copie e cole no campo Scope esse dado.

Parâmetros de Convênio Open Banking

Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
- Direto: esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
- PIX: esta opção fica habilitada somente quando selecionado a opção Direto, ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção Direto marcado).
Esta opção é válida SOMENTE para o Banco do Brasil.
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
- Boleto Impresso;
- Remessa Enviada;
- Código de Barras Lido;
Outra mudança é no Histórico Open Banking, ao qual passa criar o registro com Status Open Banking já Registrado.
Também ao acessar os Dados API é enviado a tag: "indicadorPix": "S", pois a opção PIX esta selecionada.
Disponibilizado o Modelo de Relatório para o Boleto Banco do Brasil já com o QRCode:
I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098_brasil_PIX.rtf

Como realizar a Baixa de um Lançamento Financeiro Registrado Open Banking e enviar o Registro de Baixa?

Para realizar o processo de Baixa de um Lançamento Financeiro que foi registrado via Open Banking, basta acessar o Lançamento Financeiro.
Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos

Selecionar a opção de Menu Lateral do Lançamento Financeiro Open Banking e a opção de Baixar.

Lançamento Financeiro Registrado/Baixar

Lançamento Financeiro Confirmando Operação

Lançamento Financeiro Baixado com Sucesso

Agora basta acessar a rotina de Retorno de Cobrança Open Banking através do Menu:
Menu > Finanças > Gestão Financeira > Rotinas > Operacionais > Open Banking > Retorno de Cobrança Open Banking

Modelo de Relatório utilizado:
%CIGAM_INSTAL%\Modelos_relatorios\Gestão Financeira\RF00071_remessas.RTF

Retorno de Cobrança Open Banking

Retorno de Cobrança Open Banking

Após confirmado a rotina emite a Listage de Retorno com o título baixado registrado.

Listagem_Retorno_Bancario_Online

Com isso para validar o Retorno da API do Banco é gravado no Histórico Open Banking do Lançamento Financeiro.
Acessando Lançamento Financeiro:

Listagem_Retorno_Bancario_Online

Acessando Dados API do Lançamento Financeiro

O sistema grava para Envio seguinte mensagem:
BAIXADO PELO PROCESSO DE RETORNO, CÓDIGO DE BAIXA: BAIXADO POR SOLICITACAO

Acessando Dados API do Lançamento Financeiro

Como realizar a Variação do Tipo de Cobrança de Simples para Vinculada?

Conforme layout do Banco para Open Banking para diferenciar o Tipo de Cobrança:

1- Cobrança Simples
4- Cobrança Vinculada
Para realizar este processo no Sistema deve ser parametrizado no Cadastro do Portador com a seguinte regra de sistema:
Tudo que for diferente de 4 (Cobrança Vinculada) será considerado 1 (Cobrança Simples), ou seja, caso seja deixado em Branco ou informado qualquer número diferente de 4 o sistema irá considerar sempre 1.
Menu > Finanças > Gestão Financeira > Parâmetros > Portadores

O Campo considerado para esta informação é o Identificação do serviço na guia CNAB.

1- Cobrança Simples

4- Cobrança Vinculada

Como parametrizar para envio Open Banking a Negativação ou Protesto?

Para enviar um PROTESTO:
Basta acessar o Cadastro do Portador e inserir os dias no campo Protestar após na guia Configurações.

Menu > Finanças > Gestão Financeira > Parâmetros > Portadores

Dias de Protesto Cadastro do Portador

Quando se tratar de Protesto o sistema deve enviar as tags para API do Banco da seguinte forma:
Setar os dias conforme parametrização no Cadastro do Portador na tag "quantidadeDiasProtesto": "1", e na tag "quantidadeDiasNegativacao": "0",.

Exemplo de envio da API:

"quantidadeDiasProtesto": "1",

"quantidadeDiasNegativacao": "0",

Já para enviar uma NEGATIVAÇÃO:
Basta acessar o Cadastro do Portador e inserir os dias no campo Negativar após na guia Configurações.

Menu > Finanças > Gestão Financeira > Parâmetros > Portadores

Dias de Protesto Cadastro do Portador

Quando se tratar de Negativação o sistema deve enviar as tags para API do Banco da seguinte forma:
Setar os dias conforme parametrização no Cadastro do Portador e nas tags deve ser zerado "quantidadeDiasProtesto": "0", e na tag "quantidadeDiasNegativacao": "7", e deve conter o órgão negativador na tag "orgaoNegativador": "10",, sendo SERASA = 10 .

Exemplo de envio da API:

"quantidadeDiasProtesto": "0",
"quantidadeDiasNegativacao": "7",
"orgaoNegativador": "10",

Como cadastrar as Mensagens de Retorno API Financeira Sugestão Usuário?

As Mensagens de Retorno API Financeira é uma funcionalidade para facilitar a identificar e de orientação para com as mensagens provindas das APIs que o Sistema tem conexão.
Elas foram implementadas para Open banking.
Para acessar o cadastro basta acessar através do Menu:

Menu: Finanças > Gestão Financeira > Parâmetros > Mensagens de Retorno API Financeiro

Mensagens de Retorno API Financeiro

Banco: código do Banco conforme codificação no orgão que rege os Bancos Febraban.

Código Erro: código do erro conforme layout das APIS dos Bancos.

Status: é o código de Status de erro do Servidor retornado da API dos Bancos. (Código HTTP)

Descrição do Erro (Banco): essa descrição é oriunda do Banco retornada pela API deles.

Sugestão CIGAM: esta mensagem é interna do Sistema, ou seja, quando internamente identificarmos uma situação a qual a Mensagem retornada pelo Banco não é clara, vamos alimentar com Mensagens de sugestão, para orientar as possíveis causas, dando um norte para situação.

Sugestão Cliente: este campo é reservado para o próprio usuário, possibilitando cadastrar Mensagens que ele identificar para facilitar no processo de entendimento das Mensagens de Retorno das APIs.

Agora através desta aplicação, quando ocorrer um Erro de Open Banking é possível verificar através dos links dispostos na tela de Lançamento Financeiro no campo Situação Open Banking, terá um link para tabela do erro ocorrido.

Lançamento Financeiro Mensagens de Retorno API Financeiro

Ou também através do Histórico Open Banking:

Lançamento Financeiro Mensagens de Retorno API Financeiro Histórico Open Banking

Não Escopo Retorno Open Banking Cartório?

Referente ao retorno para liquidação em Cartório, o Banco tem uma limitação e não foi desenvolvido ainda por parte do Banco na API, as custas e tarifas de Cartório, impossibilitando o Sistema realizar essa liquidação.
A sugestão para registros de Cartório é realizar via Remessa de CNAB de Retorno manual, até o Banco do Brasil liberar essa funcionalidade na API.