CIGAM WIKI - Contribuições do usuário [pt-br]

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-22T15:26:46Z

Tais.felles: /* Impressão de QR Code no Boleto - Banrisul */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

O acesso aos parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o Banrisul, e em modo modificar, acesse o botão '''Open Banking''':


<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

[[Arquivo:Open Banking Banrisul 0010.png|centro]]
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

[[Arquivo:Open Banking Banrisul 0011.png|centro]]

'''a. Client Id:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''b. Client Secret:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''c. Ambiente:''' campo preenchido automaticamente pelo CIGAM;


'''d. Versão da Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''e. Versão da API:''' campo preenchido automaticamente pelo CIGAM;


'''f. Scope:''' campo preenchido automaticamente pelo CIGAM, conforme as permissões de acesso necessárias para utilização da API de Cobrança do Banrisul.


'''g. Url Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''f. Url API:''' campo preenchido automaticamente pelo CIGAM.

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

[[Arquivo:Open Banking Banrisul 0012.png|centro]]

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Banrisul 0013.png|centro]]

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Open Banking Banrisul 0014.png|centro]]

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Open Banking Banrisul 0015.png|centro]]

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

[[Arquivo:Open Banking Banrisul 0016.png|centro]]

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

O registro do Banrisul é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Banrisul ===

'''Código do Beneficiário (Convênio):''' Para utilização da API de Cobrança do Banrisul, é necessário possuir um convênio de cobrança ativo junto ao banco.


O Código do Beneficiário deve conter 13 dígitos, sendo composto por 4 dígitos da agência, 7 dígitos do código do beneficiário e 2 dígitos do número de controle. Cada parte deve ser completada com zeros à esquerda, quando necessário.


=== Protesto e Negativação ===

A API de Cobrança do Banrisul permite o envio de instruções de protesto ou negativação durante o registro dos boletos.


=== Impressão de QR Code no Boleto - Banrisul ===

O Banrisul disponibiliza a modalidade de boleto híbrido, que permite o pagamento por meio do código de barras ou do QR Code Pix.


Para que uma empresa possa emitir boletos com QR Code Pix, é necessário possuir as credenciais de acesso à API de Cobrança do Banrisul, devidamente habilitadas para essa funcionalidade. Adicionalmente, ela precisa:


* Marcar a opção “PIX” dos parâmetros open banking;
* Chave PIX: para o Banrisul, não é necessário informar a chave Pix no cadastro do Portador de Remessa, pois o QR Code Pix é gerado pelo banco por meio da API de Cobrança, desde que a empresa esteja habilitada para utilizar essa modalidade;
* Possuir a TAG qrcode_pix no seu modelo de boleto caminho para modelo padrão salvo em: I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098 - banrisul_pix.rtf


Identificação no arquivo JSON de remessa:

[[Arquivo:Open Banking Banrisul 0017.png|centro]]

== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

Arquivo:Open Banking Banrisul 0017.png

2026-09-22T15:26:33Z

Tais.felles:

Open Banking Banrisul 0017

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-22T15:25:25Z

Tais.felles: /* Impressão de QR Code no Boleto - Banrisul */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

O acesso aos parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o Banrisul, e em modo modificar, acesse o botão '''Open Banking''':


<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

[[Arquivo:Open Banking Banrisul 0010.png|centro]]
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

[[Arquivo:Open Banking Banrisul 0011.png|centro]]

'''a. Client Id:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''b. Client Secret:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''c. Ambiente:''' campo preenchido automaticamente pelo CIGAM;


'''d. Versão da Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''e. Versão da API:''' campo preenchido automaticamente pelo CIGAM;


'''f. Scope:''' campo preenchido automaticamente pelo CIGAM, conforme as permissões de acesso necessárias para utilização da API de Cobrança do Banrisul.


'''g. Url Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''f. Url API:''' campo preenchido automaticamente pelo CIGAM.

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

[[Arquivo:Open Banking Banrisul 0012.png|centro]]

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Banrisul 0013.png|centro]]

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Open Banking Banrisul 0014.png|centro]]

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Open Banking Banrisul 0015.png|centro]]

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

[[Arquivo:Open Banking Banrisul 0016.png|centro]]

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

O registro do Banrisul é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Banrisul ===

'''Código do Beneficiário (Convênio):''' Para utilização da API de Cobrança do Banrisul, é necessário possuir um convênio de cobrança ativo junto ao banco.


O Código do Beneficiário deve conter 13 dígitos, sendo composto por 4 dígitos da agência, 7 dígitos do código do beneficiário e 2 dígitos do número de controle. Cada parte deve ser completada com zeros à esquerda, quando necessário.


=== Protesto e Negativação ===

A API de Cobrança do Banrisul permite o envio de instruções de protesto ou negativação durante o registro dos boletos.


=== Impressão de QR Code no Boleto - Banrisul ===

O Banrisul disponibiliza a modalidade de boleto híbrido, que permite o pagamento por meio do código de barras ou do QR Code Pix.


Para que uma empresa possa emitir boletos com QR Code Pix, é necessário possuir as credenciais de acesso à API de Cobrança do Banrisul, devidamente habilitadas para essa funcionalidade. Adicionalmente, ela precisa:


* Marcar a opção “PIX” dos parâmetros open banking;
* Chave PIX: para o Banrisul, não é necessário informar a chave Pix no cadastro do Portador de Remessa, pois o QR Code Pix é gerado pelo banco por meio da API de Cobrança, desde que a empresa esteja habilitada para utilizar essa modalidade;
* Possuir a TAG qrcode_pix no seu modelo de boleto caminho para modelo padrão salvo em: I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098 - banrisul_pix.rtf


Identificação no arquivo JSON de remessa:


== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-22T15:16:09Z

Tais.felles: /* Impressão de QR Code no Boleto - Banrisul */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

O acesso aos parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o Banrisul, e em modo modificar, acesse o botão '''Open Banking''':


<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

[[Arquivo:Open Banking Banrisul 0010.png|centro]]
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

[[Arquivo:Open Banking Banrisul 0011.png|centro]]

'''a. Client Id:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''b. Client Secret:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''c. Ambiente:''' campo preenchido automaticamente pelo CIGAM;


'''d. Versão da Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''e. Versão da API:''' campo preenchido automaticamente pelo CIGAM;


'''f. Scope:''' campo preenchido automaticamente pelo CIGAM, conforme as permissões de acesso necessárias para utilização da API de Cobrança do Banrisul.


'''g. Url Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''f. Url API:''' campo preenchido automaticamente pelo CIGAM.

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

[[Arquivo:Open Banking Banrisul 0012.png|centro]]

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Banrisul 0013.png|centro]]

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Open Banking Banrisul 0014.png|centro]]

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Open Banking Banrisul 0015.png|centro]]

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

[[Arquivo:Open Banking Banrisul 0016.png|centro]]

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

O registro do Banrisul é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Banrisul ===

'''Código do Beneficiário (Convênio):''' Para utilização da API de Cobrança do Banrisul, é necessário possuir um convênio de cobrança ativo junto ao banco.


O Código do Beneficiário deve conter 13 dígitos, sendo composto por 4 dígitos da agência, 7 dígitos do código do beneficiário e 2 dígitos do número de controle. Cada parte deve ser completada com zeros à esquerda, quando necessário.


=== Protesto e Negativação ===

A API de Cobrança do Banrisul permite o envio de instruções de protesto ou negativação durante o registro dos boletos.


=== Impressão de QR Code no Boleto - Banrisul ===

O Banrisul disponibiliza a modalidade de boleto híbrido, que permite o pagamento por meio do código de barras ou do QR Code Pix.


Para que uma empresa possa emitir boletos com QR Code Pix, é necessário possuir as credenciais de acesso à API de Cobrança do Banrisul, devidamente habilitadas para essa funcionalidade. Adicionalmente, ela precisa:


* Marcar a opção “PIX” dos parâmetros open banking;
* Chave PIX: para o Banrisul, não é necessário informar a chave Pix no cadastro do Portador de Remessa, pois o QR Code Pix é gerado pelo banco por meio da API de Cobrança, desde que a empresa esteja habilitada para utilizar essa modalidade;
* Possuir a TAG qrcode_pix no seu modelo de boleto caminho para modelo padrão salvo em: I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098 - banrisul_pix.rtf


== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-22T15:09:35Z

Tais.felles: /* Protesto e Negativação */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

O acesso aos parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o Banrisul, e em modo modificar, acesse o botão '''Open Banking''':


<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

[[Arquivo:Open Banking Banrisul 0010.png|centro]]
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

[[Arquivo:Open Banking Banrisul 0011.png|centro]]

'''a. Client Id:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''b. Client Secret:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''c. Ambiente:''' campo preenchido automaticamente pelo CIGAM;


'''d. Versão da Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''e. Versão da API:''' campo preenchido automaticamente pelo CIGAM;


'''f. Scope:''' campo preenchido automaticamente pelo CIGAM, conforme as permissões de acesso necessárias para utilização da API de Cobrança do Banrisul.


'''g. Url Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''f. Url API:''' campo preenchido automaticamente pelo CIGAM.

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

[[Arquivo:Open Banking Banrisul 0012.png|centro]]

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Banrisul 0013.png|centro]]

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Open Banking Banrisul 0014.png|centro]]

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Open Banking Banrisul 0015.png|centro]]

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

[[Arquivo:Open Banking Banrisul 0016.png|centro]]

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

O registro do Banrisul é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Banrisul ===

'''Código do Beneficiário (Convênio):''' Para utilização da API de Cobrança do Banrisul, é necessário possuir um convênio de cobrança ativo junto ao banco.


O Código do Beneficiário deve conter 13 dígitos, sendo composto por 4 dígitos da agência, 7 dígitos do código do beneficiário e 2 dígitos do número de controle. Cada parte deve ser completada com zeros à esquerda, quando necessário.


=== Protesto e Negativação ===

A API de Cobrança do Banrisul permite o envio de instruções de protesto ou negativação durante o registro dos boletos.


=== Impressão de QR Code no Boleto - Banrisul ===




== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-22T15:08:44Z

Tais.felles: /* Protesto e Negativação */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

O acesso aos parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o Banrisul, e em modo modificar, acesse o botão '''Open Banking''':


<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

[[Arquivo:Open Banking Banrisul 0010.png|centro]]
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

[[Arquivo:Open Banking Banrisul 0011.png|centro]]

'''a. Client Id:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''b. Client Secret:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''c. Ambiente:''' campo preenchido automaticamente pelo CIGAM;


'''d. Versão da Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''e. Versão da API:''' campo preenchido automaticamente pelo CIGAM;


'''f. Scope:''' campo preenchido automaticamente pelo CIGAM, conforme as permissões de acesso necessárias para utilização da API de Cobrança do Banrisul.


'''g. Url Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''f. Url API:''' campo preenchido automaticamente pelo CIGAM.

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

[[Arquivo:Open Banking Banrisul 0012.png|centro]]

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Banrisul 0013.png|centro]]

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Open Banking Banrisul 0014.png|centro]]

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Open Banking Banrisul 0015.png|centro]]

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

[[Arquivo:Open Banking Banrisul 0016.png|centro]]

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

O registro do Banrisul é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Banrisul ===

'''Código do Beneficiário (Convênio):''' Para utilização da API de Cobrança do Banrisul, é necessário possuir um convênio de cobrança ativo junto ao banco.


O Código do Beneficiário deve conter 13 dígitos, sendo composto por 4 dígitos da agência, 7 dígitos do código do beneficiário e 2 dígitos do número de controle. Cada parte deve ser completada com zeros à esquerda, quando necessário.


=== Protesto e Negativação ===

A API de Cobrança do Banrisul permite o envio de instruções de protesto e negativação durante o registro dos boletos.


=== Impressão de QR Code no Boleto - Banrisul ===




== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-22T15:07:54Z

Tais.felles: /* Registro de cobrança - Banrisul */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

O acesso aos parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o Banrisul, e em modo modificar, acesse o botão '''Open Banking''':


<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

[[Arquivo:Open Banking Banrisul 0010.png|centro]]
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

[[Arquivo:Open Banking Banrisul 0011.png|centro]]

'''a. Client Id:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''b. Client Secret:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''c. Ambiente:''' campo preenchido automaticamente pelo CIGAM;


'''d. Versão da Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''e. Versão da API:''' campo preenchido automaticamente pelo CIGAM;


'''f. Scope:''' campo preenchido automaticamente pelo CIGAM, conforme as permissões de acesso necessárias para utilização da API de Cobrança do Banrisul.


'''g. Url Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''f. Url API:''' campo preenchido automaticamente pelo CIGAM.

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

[[Arquivo:Open Banking Banrisul 0012.png|centro]]

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Banrisul 0013.png|centro]]

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Open Banking Banrisul 0014.png|centro]]

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Open Banking Banrisul 0015.png|centro]]

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

[[Arquivo:Open Banking Banrisul 0016.png|centro]]

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

O registro do Banrisul é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Banrisul ===

'''Código do Beneficiário (Convênio):''' Para utilização da API de Cobrança do Banrisul, é necessário possuir um convênio de cobrança ativo junto ao banco.


O Código do Beneficiário deve conter 13 dígitos, sendo composto por 4 dígitos da agência, 7 dígitos do código do beneficiário e 2 dígitos do número de controle. Cada parte deve ser completada com zeros à esquerda, quando necessário.


=== Protesto e Negativação ===




=== Impressão de QR Code no Boleto - Banrisul ===




== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-22T15:05:53Z

Tais.felles: /* Assistente Open Banking - Banrisul */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

O acesso aos parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o Banrisul, e em modo modificar, acesse o botão '''Open Banking''':


<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

[[Arquivo:Open Banking Banrisul 0010.png|centro]]
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

[[Arquivo:Open Banking Banrisul 0011.png|centro]]

'''a. Client Id:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''b. Client Secret:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''c. Ambiente:''' campo preenchido automaticamente pelo CIGAM;


'''d. Versão da Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''e. Versão da API:''' campo preenchido automaticamente pelo CIGAM;


'''f. Scope:''' campo preenchido automaticamente pelo CIGAM, conforme as permissões de acesso necessárias para utilização da API de Cobrança do Banrisul.


'''g. Url Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''f. Url API:''' campo preenchido automaticamente pelo CIGAM.

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

[[Arquivo:Open Banking Banrisul 0012.png|centro]]

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Banrisul 0013.png|centro]]

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Open Banking Banrisul 0014.png|centro]]

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Open Banking Banrisul 0015.png|centro]]

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

[[Arquivo:Open Banking Banrisul 0016.png|centro]]

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

O registro do Banrisul é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Banrisul ===

=== Protesto e Negativação ===

=== Impressão de QR Code no Boleto - Banrisul ===

== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-17T12:03:24Z

Tais.felles: /* Assistente Open Banking - Banrisul */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

O acesso aos parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o Banrisul, e em modo modificar, acesse o botão '''Open Banking''':


<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

[[Arquivo:Open Banking Banrisul 0010.png|centro]]
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

[[Arquivo:Open Banking Banrisul 0011.png|centro]]

'''a. Client Id:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''b. Client Secret:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''c. Ambiente:'''


'''d. Versão da Autorização:'''


'''e. Versão da API:'''


'''f. Scope:'''


'''g. Url Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''f. Url API:''' campo preenchido automaticamente pelo CIGAM.

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

[[Arquivo:Open Banking Banrisul 0012.png|centro]]

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Banrisul 0013.png|centro]]

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Open Banking Banrisul 0014.png|centro]]

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Open Banking Banrisul 0015.png|centro]]

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

[[Arquivo:Open Banking Banrisul 0016.png|centro]]

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

O registro do Banrisul é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Banrisul ===

=== Protesto e Negativação ===

=== Impressão de QR Code no Boleto - Banrisul ===

== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

Arquivo:Open Banking Banrisul 0016.png

2026-09-17T12:03:04Z

Tais.felles:

Open Banking Banrisul 0016

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-17T12:00:10Z

Tais.felles: /* Assistente Open Banking - Banrisul */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

O acesso aos parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o Banrisul, e em modo modificar, acesse o botão '''Open Banking''':


<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

[[Arquivo:Open Banking Banrisul 0010.png|centro]]
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

[[Arquivo:Open Banking Banrisul 0011.png|centro]]

'''a. Client Id:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''b. Client Secret:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''c. Ambiente:'''


'''d. Versão da Autorização:'''


'''e. Versão da API:'''


'''f. Scope:'''


'''g. Url Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''f. Url API:''' campo preenchido automaticamente pelo CIGAM.

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

[[Arquivo:Open Banking Banrisul 0012.png|centro]]

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Banrisul 0013.png|centro]]

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Open Banking Banrisul 0014.png|centro]]

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Open Banking Banrisul 0015.png|centro]]

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

>>>>>>>IMAGEM<<<<<<<<

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

O registro do Banrisul é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Banrisul ===

=== Protesto e Negativação ===

=== Impressão de QR Code no Boleto - Banrisul ===

== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

Arquivo:Open Banking Banrisul 0015.png

2026-09-17T11:59:51Z

Tais.felles:

Open Banking Banrisul 0015

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-17T11:54:49Z

Tais.felles: /* Assistente Open Banking - Banrisul */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

O acesso aos parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o Banrisul, e em modo modificar, acesse o botão '''Open Banking''':


<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

[[Arquivo:Open Banking Banrisul 0010.png|centro]]
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

[[Arquivo:Open Banking Banrisul 0011.png|centro]]

'''a. Client Id:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''b. Client Secret:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''c. Ambiente:'''


'''d. Versão da Autorização:'''


'''e. Versão da API:'''


'''f. Scope:'''


'''g. Url Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''f. Url API:''' campo preenchido automaticamente pelo CIGAM.

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

[[Arquivo:Open Banking Banrisul 0012.png|centro]]

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Banrisul 0013.png|centro]]

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Open Banking Banrisul 0014.png|centro]]

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

>>>>>>>IMAGEM<<<<<<<<

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

>>>>>>>IMAGEM<<<<<<<<

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

O registro do Banrisul é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Banrisul ===

=== Protesto e Negativação ===

=== Impressão de QR Code no Boleto - Banrisul ===

== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

Arquivo:Open Banking Banrisul 0014.png

2026-09-17T11:53:59Z

Tais.felles:

Open Banking Banrisul 0014

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-17T11:48:54Z

Tais.felles: /* Assistente Open Banking - Banrisul */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

O acesso aos parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o Banrisul, e em modo modificar, acesse o botão '''Open Banking''':


<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

[[Arquivo:Open Banking Banrisul 0010.png|centro]]
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

[[Arquivo:Open Banking Banrisul 0011.png|centro]]

'''a. Client Id:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''b. Client Secret:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''c. Ambiente:'''


'''d. Versão da Autorização:'''


'''e. Versão da API:'''


'''f. Scope:'''


'''g. Url Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''f. Url API:''' campo preenchido automaticamente pelo CIGAM.

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

[[Arquivo:Open Banking Banrisul 0012.png|centro]]

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Banrisul 0013.png|centro]]

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

>>>>>>>IMAGEM<<<<<<<<

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

>>>>>>>IMAGEM<<<<<<<<

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

>>>>>>>IMAGEM<<<<<<<<

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

O registro do Banrisul é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Banrisul ===

=== Protesto e Negativação ===

=== Impressão de QR Code no Boleto - Banrisul ===

== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

Arquivo:Open Banking Banrisul 0013.png

2026-09-17T11:47:07Z

Tais.felles:

Open Banking Banrisul 0013

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-17T11:44:29Z

Tais.felles: /* Assistente Open Banking - Banrisul */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

O acesso aos parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o Banrisul, e em modo modificar, acesse o botão '''Open Banking''':


<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

[[Arquivo:Open Banking Banrisul 0010.png|centro]]
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

[[Arquivo:Open Banking Banrisul 0011.png|centro]]

'''a. Client Id:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''b. Client Secret:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''c. Ambiente:'''


'''d. Versão da Autorização:'''


'''e. Versão da API:'''


'''f. Scope:'''


'''g. Url Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''f. Url API:''' campo preenchido automaticamente pelo CIGAM.

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

[[Arquivo:Open Banking Banrisul 0012.png|centro]]

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

>>>>>>>IMAGEM<<<<<<<<

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

>>>>>>>IMAGEM<<<<<<<<

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

>>>>>>>IMAGEM<<<<<<<<

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

>>>>>>>IMAGEM<<<<<<<<

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

O registro do Banrisul é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Banrisul ===

=== Protesto e Negativação ===

=== Impressão de QR Code no Boleto - Banrisul ===

== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

Arquivo:Open Banking Banrisul 0012.png

2026-09-17T11:44:08Z

Tais.felles:

Open Banking Banrisul 0012

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-17T11:40:08Z

Tais.felles: /* Assistente Open Banking - Banrisul */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

O acesso aos parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o Banrisul, e em modo modificar, acesse o botão '''Open Banking''':


<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

[[Arquivo:Open Banking Banrisul 0010.png|centro]]
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

[[Arquivo:Open Banking Banrisul 0011.png|centro]]

'''a. Client Id:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''b. Client Secret:''' cole aqui a informação obtida no portal open banking do Banrisul;


'''c. Ambiente:'''


'''d. Versão da Autorização:'''


'''e. Versão da API:'''


'''f. Scope:'''


'''g. Url Autorização:''' campo preenchido automaticamente pelo CIGAM;


'''f. Url API:''' campo preenchido automaticamente pelo CIGAM.

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

>>>>>>>IMAGEM<<<<<<<<

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

>>>>>>>IMAGEM<<<<<<<<

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

>>>>>>>IMAGEM<<<<<<<<

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

>>>>>>>IMAGEM<<<<<<<<

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

>>>>>>>IMAGEM<<<<<<<<

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

O registro do Banrisul é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Banrisul ===

=== Protesto e Negativação ===

=== Impressão de QR Code no Boleto - Banrisul ===

== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-17T11:36:29Z

Tais.felles: /* Assistente Open Banking - Banrisul */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

O acesso aos parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o Banrisul, e em modo modificar, acesse o botão '''Open Banking''':


<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

[[Arquivo:Open Banking Banrisul 0010.png|centro]]
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

[[Arquivo:Open Banking Banrisul 0011.png|centro]]

'''a. Client Id:''' cole aqui a informação obtida no portal open banking do SICOOB;


'''b. Client Secret:'''


'''c. Ambiente:'''


'''d. Versão da Autorização:'''


'''e. Versão da API:'''


'''f. Scope:'''


'''g. Url Autorização:'''


'''f. Url API:'''

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

>>>>>>>IMAGEM<<<<<<<<

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

>>>>>>>IMAGEM<<<<<<<<

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

>>>>>>>IMAGEM<<<<<<<<

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

>>>>>>>IMAGEM<<<<<<<<

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

>>>>>>>IMAGEM<<<<<<<<

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

O registro do Banrisul é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Banrisul ===

=== Protesto e Negativação ===

=== Impressão de QR Code no Boleto - Banrisul ===

== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

Arquivo:Open Banking Banrisul 0011.png

2026-09-17T11:33:49Z

Tais.felles:

Open Banking Banrisul 0011

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-17T11:30:05Z

Tais.felles: /* Assistente Open Banking - Banrisul */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

O acesso aos parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o Banrisul, e em modo modificar, acesse o botão '''Open Banking''':


<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

[[Arquivo:Open Banking Banrisul 0010.png|centro]]
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

>>>>>>>IMAGEM<<<<<<<<

'''a. Client Id:'''


'''b. Client Secret:'''


'''c. Ambiente:'''


'''d. Versão da Autorização:'''


'''e. Versão da API:'''


'''f. Scope:'''


'''g. Url Autorização:'''


'''f. Url API:'''

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

>>>>>>>IMAGEM<<<<<<<<

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

>>>>>>>IMAGEM<<<<<<<<

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

>>>>>>>IMAGEM<<<<<<<<

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

>>>>>>>IMAGEM<<<<<<<<

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

>>>>>>>IMAGEM<<<<<<<<

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

O registro do Banrisul é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Banrisul ===

=== Protesto e Negativação ===

=== Impressão de QR Code no Boleto - Banrisul ===

== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

Arquivo:Open Banking Banrisul 0010.png

2026-09-17T11:29:31Z

Tais.felles:

Open Banking Banrisul 0010

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-17T11:17:24Z

Tais.felles: /* Assistente Open Banking - Banrisul */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

O acesso aos parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o Banrisul, e em modo modificar, acesse o botão '''Open Banking''':


<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

>>>>>>>IMAGEM<<<<<<<<
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

>>>>>>>IMAGEM<<<<<<<<

'''a. Client Id:'''


'''b. Client Secret:'''


'''c. Ambiente:'''


'''d. Versão da Autorização:'''


'''e. Versão da API:'''


'''f. Scope:'''


'''g. Url Autorização:'''


'''f. Url API:'''

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

>>>>>>>IMAGEM<<<<<<<<

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

>>>>>>>IMAGEM<<<<<<<<

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

>>>>>>>IMAGEM<<<<<<<<

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

>>>>>>>IMAGEM<<<<<<<<

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

>>>>>>>IMAGEM<<<<<<<<

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

O registro do Banrisul é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Banrisul ===

=== Protesto e Negativação ===

=== Impressão de QR Code no Boleto - Banrisul ===

== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

GF - Como Fazer - Open Banking para Banco Itaú

2026-09-17T11:16:35Z

Tais.felles: /* Assistente Open Banking - Itaú */

[[categoria:Como_Fazer_Finanças]]

= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs '''bancárias do Itaú'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Itaú''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o Manual [http://ww2.cigam.com.br/mediawiki/index.php/GF_-_Como_Fazer_-_Open_Banking Open Banking - Geral].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 220404 BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 220404 BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| 220404 BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 220404 BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 220404 BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 221107.a BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto (Bolecode)
|| 221107.a BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| 231002 BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 251103.BETA
|-
|}

</center>

= Open Banking Itaú =

== Obtenção de credenciais - Itaú (versão atual V2 + BOLECODE) ==

As credenciais do Itaú são obtidas através de um processo realizado em conjunto com a equipe de implantação e acessos ao [https://devportal.itau.com.br/baas/#/ Portal Developers] desta instituição e seguir os passos do processo de credenciamento e geração do certificado digital.


'''IMPORTANTE: '''O Itaú utiliza credenciais e certificados digitais específicos para a API de cobrança, chamada CASH MANAGEMENT (registro sem QR Code e retorno de cobrança) e para a API BOLECODE (registro de cobrança com QR Code). Desta forma, um cliente que quiser possuir registro com QR Code e retorno via API, precisará das credenciais e certificados para as duas APIs. Tratam-se de certificados próprios, não sendo possível a utilização dos certificados da NFe.


O processo de obtenção de credenciais é totalmente de responsabilidade do cliente e sua equipe de TI juntamente com o Itaú. Para aqueles que desejarem auxílio, dispomos de um parceiro homologado na empresa [https://www.certidoc.com.br/ Certidoc] onde cabe ao cliente fazer este contato.



<ul>
<pre>
O Itaú a partir de setembro de 2024 possibilita que as credenciais geradas sejam 'unificadas', no sentido de que o scope de BOLECODE passa a poder ser adicionado a credencial de CASH_MANAGEMENT. Porém, para uso dessa modalidade de 'credenciais unificadas', é necessário que identifique a versão do Cigam para saber se a versão do Cigam em uso é a 241007 e posteriores ou 240506 patch 'c' ou posteriores, que são as versões que suportam esta modalidade. Caso sua versão de Cigam seja anterior as versões mencionadas e suas credenciais forem unificadas, apenas o registro de títulos irá funcionar, o retorno acusará o erro "Não encontrado".
</pre>
</ul>


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Instruções para troca/renovação do certificado digital - Itaú ==

As instruções para renovação do certificado digital utilizado nas credenciais do Itaú estão disponíveis no [https://devportal.itau.com.br/baas/#/ Portal Developers] e são compostas por ações semelhantes às do primeiro credenciamento. Contate o seu gerente de Cash (Itaú) para maiores informações e caso tenha dificuldade em realizar o processo, a CIGAM dispõe da [http://www.certidoc.com.br Certidoc] para prestar este auxílo.


Para a troca do certificado no CIGAM (seja Bolecode ou Cash) em cenários onde o novo certificado '''manter o CN e alterar somente sua validade''' basta remover o antigo e instalar o atual. Para validar se a configuração Open Banking está utilizando o novo certificado entre nas Credenciais dos Parâmetros Open Banking e verifique se o campo "Status do Certificado" foi atualizado.

O acesso as parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o banco desejado, e em modo modificar, acesse o botão '''Open Banking''':

[[Arquivo:Renovacao do Certificado Itau.png|centro]]
 
[[Arquivo:Renovacao do Certificado Itau 2.png|centro]]

Caso o certificado tenha o '''CN alterado''' será necessário a atualização no banco e no CIGAM informar o novo '''Client Id/Client Id BOLECODE'''. Para validar a atualização verifique se o campo "Status do Certificado" foi atualizado.

[[Arquivo:Renovacao do Certificado Itau 3.png|centro]]

Para mais informações de instalação do certificado acesse a [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado? | FAQ]] sobre instalação e revisão do certificado digital.


== Assistente Open Banking - Itaú ==

O acesso aos parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o banco desejado, e em modo modificar, acesse o botão '''Open Banking''':

Conforme explicado no tópico anterior, a tela de boas-vindas do assistente do Itaú especifica os dados referentes às credenciais para as APIs do Itaú:

[[Arquivo:Abertura do Assistente Itau.png|centro]]
 

'''Passo 1: '''Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um. O Itaú a partir a versão 2 (atual) da sua API, deixou de disponibilizar ambientes de teste, desta forma, preencha apenas os dados da guia “Produção”, caso você tenha a necessidade de cadastrar alguns títulos de teste, utilize o campo “etapa processo do boleto = validação” conforme as instruções abaixo.

[[Arquivo:Passo 1 Assistente Itau.png|centro]]

<ul>
'''a. API Cobrança:''' 02 – API cash_management ou 03 – BOLECODE. Conforme explicado acima, utilize a opção 02 para registro e retorno de cobrança sem QR Code no boleto, para esta opção são necessárias apenas as informações com sufixo “CASH”. Já para utilizar a opção 03 que possui registro de cobrança com QR Code, é necessário utilizar as credenciais com sufixo “BOLECODE” e também as de sufixo “CASH” pois a API de retorno permanece nesta segunda API.
 
'''b. Client_id Remessa/Retorno Cobrança CASH:''' id da API cash Management para registro sem QR Code e retorno de cobrança;
 
'''c. Client_secret Remessa/Retorno Cobrança CASH:''' secret da API cash Management para registro sem QR Code e retorno de cobrança;
 
'''d. Chave Itaú:''' campo desabilitado, era utilizado na V1 já descontinuada;
 
'''e. Etapa Processo do Boleto:''' Aqui é onde existe a possibilidade de realizar registros de testes no Itaú, a opção “etapa processo” permite realizar registros em ambiente não produtivo conforme abaixo:
 
<ul>
01 – Efetivação: este é o formato oficial onde os títulos serão registrados em ambiente de produção.
 
02 – Validação: mantendo este parâmetro, os títulos serão enviados para um ambiente de testes restritos (apenas registro, sem possibilidade de alteração uma vez que o título não fica registrado, apenas é feita uma validação inicial).
</ul>
'''f. Status Certificado Cobrança CASH:''' campo preenchido automaticamente pelo CIGAM ao localizar um certificado nomeado com o seu CN=Client_id da API de CASH. Exemplo:
<ul>
Client_ID Remessa/Retorno CASH: 1234567891011121314
 
Nome do Certificado: “1234567891011121314”
</ul>
'''g. Identificador (CNPJ/CPF):''' campo desabilitado, era utilizado na V1 já descontinuada;
 
'''h. Versão da API:''' campo preenchido automaticamente pelo CIGAM;
 
'''i. Client_id BOLECODE:''' id da API BOLECODE para registro de cobrança com QR Code;
 
'''j. Client_Secret BOLECODE:''' secret da API BOLECODE para registro de cobrança com QR Code;
 
'''k. Status Certificado BOLECODE:''' campo preenchido automaticamente pelo CIGAM ao localizar um certificado nomeado com o seu CN=Client_id da API BOLECODE. Exemplo:
<ul>
Client_ID BOLECODE: 1234567891011121314
 
Nome do Certificado: “1234567891011121314”
</ul>
'''l. x-apigw-api-id:''' campo desabilitado, era utilizado na V1 já descontinuada;
 
'''m. Scope:''' campo desabilitado, era utilizado na V1 já descontinuada;
 
'''n. URL Autorização:''' campo preenchido automaticamente pelo CIGAM;
 
'''o. URL API:''' campo preenchido automaticamente pelo CIGAM;
 
'''p. URL BOLECODE:''' campo preenchido automaticamente pelo CIGAM;
 
'''q. Usuário para Alerta:''' informe aqui o usuário que receberá os alertas de vencimento do certificado digital utilizado na parametrização. Esta informação é muito importante pois o processo de renovação junto ao Itaú pode levar alguns dias e não será possível registrar títulos com um certificado vencido.
</ul>

 

'''Passo 2: '''Este passo diz respeito à seleção de convênios, ela é uma característica do Itaú e serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco é “341”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

[[Arquivo:Passo 2 Assistente Itau.png|centro]]

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 

'''Passo 3: '''Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Passo 3 Assistente Itau.png|centro]]

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.


'''Importante 2:''' O Itaú possui as opções de envio direto e registro PIX no boleto disponíveis, esta última só está disponível caso tenha sido selecionada a opção 03 – BOLECODE no passo 1 do assistente, bem como está condicionada à existência de credenciais válidas para esta API.

 

'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Passo 4 Relatorio SICOOB.png|centro]]

'''Pronto! '''Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Assistente Conclusao Itau.png|centro]]

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [http://ww2.cigam.com.br/mediawiki/index.php/GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

[[Arquivo:Parametros Open Banking Itau .png|centro]]

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco Itaú, os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Nas sessões a seguir estarão descritas apenas as características específicas do '''Itaú'''. Demais instruções de uso do open banking estão no [http://ww2.cigam.com.br/mediawiki/index.php/GF_-_Como_Fazer_-_Open_Banking Manual Open Banking - Geral].


== Ambiente de testes - Itaú ==

A partir da V2 (01/01/2022) não está mais disponível o ambiente de testes do Itaú, para registrar títulos nesta modalidade é necessário utilizar a opção “validação” disponível nos parâmetros open banking (campo “etapa processo do boleto”), neste formato os títulos são enviados para um ambiente de testes onde é possível realizar o registro, mas não o retorno de títulos.

[[Arquivo:Botao Credenciais Parametros Open Banking Itau.png|centro]]

== Registro de cobrança - Itaú ==

O registro do Itaú é, de maneira geral realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Itaú ===

'''- Agência e Conta:''' O portador do Itaú precisa de 12 caracteres entre Agência + Conta (completar com zeros a esquerda), do contrário, o erro abaixo será apresentado:

[[Arquivo:Erro Itau 12 Caracteres.png|centro]]
 
[[Arquivo:Cadastro de Portadores 12 Caracteres.png|centro]]
 


'''- Recebimentos divergentes da cobrança:''' Para portadores do Itaú (341) disponibilizamos o campo <ref group="Versão 231002.a"> Liberado a partir da OS 816822/2. </ref>"Aceita recebimento divergente da cobrança". Se o checkbox for marcado, a tag "codigo_tipo_autorizacao" do envio para registro no banco será enviada com o dado "01", permitindo que o título aceite recebimentos divergentes, caso contrário, a tag será enviada como "03" e o título não permitirá este tipo de recebimento.

[[Arquivo:Aceita recebimento divergente da cobranca Itau.png|centro]]
 


'''- Espécie:''' Para portadores do Itaú (341) no campo Espécie na guia CNAB do cadastro de Portadores, utilize uma das opções da coluna '''Código''' listadas abaixo a partir da documentação técnica fornecida pelo banco.

[[Arquivo:Especie itau.png|centro]]

=== Protesto e Negativação ===

'''Protesto e negativação:''' O Itaú possui os serviços de protesto e negativação e apenas um destes serviços pode ficar ativo.

Conforme Manual BoleCode via API, disponibilizado pelo Itaú, os códigos das instruções para Protesto e Negativação são:
{| class="wikitable"
|-
! Código !! Instrução
|-
| 1 || Protestar
|-
| 2|| Negativar
|-
| 4 || Não protestar
|-
| 5|| Não negativar
|-
| 7|| Não receber após o vencimento
|-
| 8|| Baixar após vencimento
|}

No mesmo manual, não está prevista instrução para envio dos dias de protesto ou negativação, como úteis ou corridos, sendo assim consulte seu gerente de cash ou o suporte de API do Banco.

Fonte: [https://www.cigam.com.br/wiki/images/a/a3/Manual_API_EmissaoBoleCode.pdf Manual BoleCode Itaú via API]

=== Impressão de QR Code no Boleto - Itaú (Bolecode) ===

Conforme já demonstrado na área de parametrização do assistente open banking do Itaú, uma empresa que queira emitir QR Codes em seus boletos deve possuir credenciais e certificado digital para a API - 03 BOLECODE. Adicionalmente, ela precisa:
* Marcar a opção “PIX” dos parâmetros open banking;
* Informar a sua chave PIX (tipo e dado) no cadastro do portador de remessa;
* Possuir a TAG qrcode_pix no seu modelo de boleto caminho para modelo padrão salvo em: ''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098 - Itau_pix.rtf''


Chave obtida no cadastro do portador de remessa:
 
Necessário direito de ''Menu GF Configurações'' e configuração ''3099 - GF - GE Permitir acesso aos Parâmetros PIX'' marcada para o usuário para acesso ao botão ''Parâmetros PIX''.

[[Arquivo:Dado Pix Portador Itau.png|centro]]

Identificação no arquivo JSON de remessa:

[[Arquivo:Dados QRCode Itau JSON.png|centro]]

Impressão do boleto com QR Code (Bolecode):

[[Arquivo:Impressao Bolecode Itau.png|centro]]

=== Particularidades de baixa - Itaú ===

O Itaú só permite a baixa de títulos após passado pelo menos um dia do registro.


'''Descrição do Erro (Banco):'''


''"Erro na validação de Campos.''
 
''Atualização não permitida na mesma data de emissão do título."''

[[Arquivo:Particularidades de baixa.png|centro]]

Observação: o registro de títulos do itaú é instantâneo, mas as alterações serão processadas somente no dia seguinte.


===Alterações de títulos registrados Via Open Banking - Alteração de Multa===

De acordo com as orientações do Portal Developers do Itaú, a tag obrigatória '''codigo_tipo_multa''', poderá ser:
*'''01''' - Quando se deseja cobrar um valor fixo de multa após o vencimento
*'''02''' - Quando se deseja cobrar um percentual do valor do título de multa após o vencimento
*'''03''' - Quando não se deseja cobrar multa caso o pagamento seja feito após o vencimento (isento)
 
[[Image: OpenItau_codigo_tipo_multa.png|750px|centro]]
 

=== Origem das tags ===
{| class="wikitable"
|-
! Tag !! Origem no Cigam
|-
| texto_seu_numero|| Número da NF + desdobramento da duplicata, do lançamento financeiro
|}

== Retorno de cobrança - Itaú ==

A rotina de retorno do Itaú funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Open Banking Itau 0001.png|centro]]
 
[[Arquivo:Open Banking Itau 0002.png|centro]]
 
===Guia Filtros===

====Busca Liquidações por "Detalhamento"====


'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.

'''Empresa:''' Filtro para a empresa do lançamento financeiro.

'''Lançamento:''' Filtro para o número do lançamento financeiro.

'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.

'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.

<ref group="Versão 240506"> Liberado a partir da OS 816822/4. </ref>'''Situação do Boleto:''' Neste filtro teremos duas opções.
* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Somente Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".


====<ref group="Versão 251103"> Liberado a partir da OS 816822/8. </ref>Busca Liquidações por "Listagem"====

'''Data:''' Filtro para a data do título.


'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Em aberto: retornará somente lançamentos registrados com situação em aberto.
* Liquidado: retornará somente lançamentos pagos.
* Baixado: retornará somente lançamentos baixados. Observação: como o pagamento via qrcode efetua a liquidacao e baixa do boleto físico, ele será retornado tanto na baixa quanto na liquidação.


'''Pesquisa por Data:''' Neste filtro teremos cinco opções:
* Data de Entrada;
* Data de Emissão;
* Data de Vencimento;
* Data de Pagamento - esta opção será habilitada apenas quando "Situação do Boleto" estiver como "Liquidado";
* Data de Pagamento(Baixa) - esta opção será habilitada apenas quando "Situação do Boleto" estiver como "Baixado".


A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.


Lembrando que o retorno de títulos do Itaú é realizado pela API “CASH MANAGEMENT” que possui credenciais próprias, dessa forma, mesmo um cliente que use a forma de consumo 03 – BOLECODE, irá precisar de credenciais da V2 para realizar os seus retornos. Além disso, o banco não retorna os títulos pagos via QR CODE com status de liquidado quando a busca de liquidações for "Detalhamento", desta forma, a rotina de retorno neste formato apenas indica que o título foi pago via QR Code, mas não o liquida, mesmo utilizando a opção “Retorno”. Os títulos recebidos via QR Code no Itaú quando utilizada a busca de liquidações por '''Detalhamento''' devem ser liquidados manualmente dentro do CIGAM ou via retorno CNAB. Já se a busca for por '''Listagem''' então a liquidação do QRCode será automática'''.

[[Arquivo:Retorno Itau pago por QRCode.png|centro]]

= Alterações de títulos registrados Via Open Banking =
== Abatimento de títulos ==

<ref group="Versão 251103">Liberado a partir da OS 816297/7.</ref>Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.

=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].

=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].

= Retenção P/C/C - PIS, COFINS, CSLL =

Para quem utiliza o recurso de Controlar Retenções na Saída, ou seja, configuração [[GF - GE - 2505 - Código de imposto para controlar retenção de CSLL na saída]], e deseja registrar o lançamento financeiro no valor líquido, já descontando as retenções, é necessário:
*Parametrizar a configuração [[GF - GE - 3214 - Diminuir valor das retenções do valor total do boleto]], como '''1 - Sempre''' ou '''2 - Por Empresa''', e
*Se a configuração estiver como '''2 - Por Empresa''', deve-se marcar as empresas desejadas no campo '''Descontar Retenção no Boleto'''.

Para mais informações de como funciona esse recurso, consulte a WIKI [[OS 816297/10 – Retenções P/C/C + Boletos + CNAB e Open Banking]].

Para informações sobre o uso do Controle das Retenções na Saída, consulte [[GF - Como Fazer - Controlar Retenções de PIS-COFINS-CSSL-IRRF-INSS-ISS para Nota Fiscal de Saída]].

= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [[FAQ_GF#Open Banking|FAQs Open Banking]]
* [[Open Banking - Em qual tabela fica gravado o registro do campo "Situação Open Banking" do lançamento financeiro]]
* [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado?]]
* [[Open Banking Itaú - Retorno de títulos acusando erro "Não encontrado"]]
* [[Open Banking - O que é Endpoint, Request e Response?]]
* [[Open Banking Itaú: Orientações referente comunicado do Banco Itaú, sobre alteração de URLs, para evitar interrupções nas cobranças]]


= Documentação Itaú =

* [https://devportal.itau.com.br/baas/#/ Portal Developers Itaú]
* [https://www.itau.com.br/atendimento-itau/para-voce/telefones Atendimento Itaú]


= Versões =
== Versão 231002 ==
<references group="Versão 231002"/>
=== Patch 'a' ===
<references group="Versão 231002.a"/>
== Versão 240506 ==
<references group="Versão 240506"/>
== Versão 251103 ==
<references group="Versão 251103"/>

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-17T11:11:56Z

Tais.felles: /* Registro de cobrança - Banrisul */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

>>>>>>>IMAGEM<<<<<<<<
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

>>>>>>>IMAGEM<<<<<<<<

'''a. Client Id:'''


'''b. Client Secret:'''


'''c. Ambiente:'''


'''d. Versão da Autorização:'''


'''e. Versão da API:'''


'''f. Scope:'''


'''g. Url Autorização:'''


'''f. Url API:'''

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

>>>>>>>IMAGEM<<<<<<<<

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

>>>>>>>IMAGEM<<<<<<<<

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

>>>>>>>IMAGEM<<<<<<<<

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

>>>>>>>IMAGEM<<<<<<<<

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

>>>>>>>IMAGEM<<<<<<<<

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

O registro do Banrisul é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Banrisul ===

=== Protesto e Negativação ===

=== Impressão de QR Code no Boleto - Banrisul ===

== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-17T11:11:17Z

Tais.felles: /* Registro de cobrança - Banrisul */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

>>>>>>>IMAGEM<<<<<<<<
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

>>>>>>>IMAGEM<<<<<<<<

'''a. Client Id:'''


'''b. Client Secret:'''


'''c. Ambiente:'''


'''d. Versão da Autorização:'''


'''e. Versão da API:'''


'''f. Scope:'''


'''g. Url Autorização:'''


'''f. Url API:'''

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

>>>>>>>IMAGEM<<<<<<<<

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

>>>>>>>IMAGEM<<<<<<<<

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

>>>>>>>IMAGEM<<<<<<<<

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

>>>>>>>IMAGEM<<<<<<<<

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

>>>>>>>IMAGEM<<<<<<<<

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

O registro do Banrisul é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.

=== Particularidades do cadastro de Portador - Banrisul ===

=== Protesto e Negativação ===

=== Impressão de QR Code no Boleto - Banrisul ===

== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-17T11:06:33Z

Tais.felles: /* Assistente Open Banking - Banrisul */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

>>>>>>>IMAGEM<<<<<<<<
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

>>>>>>>IMAGEM<<<<<<<<

'''a. Client Id:'''


'''b. Client Secret:'''


'''c. Ambiente:'''


'''d. Versão da Autorização:'''


'''e. Versão da API:'''


'''f. Scope:'''


'''g. Url Autorização:'''


'''f. Url API:'''

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

>>>>>>>IMAGEM<<<<<<<<

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

>>>>>>>IMAGEM<<<<<<<<

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

>>>>>>>IMAGEM<<<<<<<<

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

>>>>>>>IMAGEM<<<<<<<<

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

>>>>>>>IMAGEM<<<<<<<<

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

=== Particularidades do cadastro de Portador - Banrisul ===

=== Protesto e Negativação ===

=== Impressão de QR Code no Boleto - Banrisul ===

== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-16T19:57:49Z

Tais.felles: /* Assistente Open Banking - Banrisul */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

<ref group="Versão 260601.b">Liberado a partir da OS 962833/1.</ref>'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

>>>>>>>IMAGEM<<<<<<<<
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

>>>>>>>IMAGEM<<<<<<<<

'''a. Client Id:'''


'''b. Client Secret:'''


'''c. Ambiente:'''


'''d. Versão da Autorização:'''


'''e. Versão da API:'''


'''f. Scope:'''


'''g. Url Autorização:'''


'''f. Url API:'''

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

>>>>>>>IMAGEM<<<<<<<<

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

>>>>>>>IMAGEM<<<<<<<<

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

>>>>>>>IMAGEM<<<<<<<<

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

>>>>>>>IMAGEM<<<<<<<<

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

>>>>>>>IMAGEM<<<<<<<<

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Nas sessões a seguir estarão descritas apenas as características específicas do Itaú. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

=== Particularidades do cadastro de Portador - Banrisul ===

=== Protesto e Negativação ===

=== Impressão de QR Code no Boleto - Banrisul ===

== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-16T19:52:24Z

Tais.felles: /* Versões */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

O acesso as parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o banco desejado, e em modo modificar, acesse o botão '''Open Banking''':


'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

>>>>>>>IMAGEM<<<<<<<<
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

>>>>>>>IMAGEM<<<<<<<<

'''a. Client Id:'''


'''b. Client Secret:'''


'''c. Ambiente:'''


'''d. Versão da Autorização:'''


'''e. Versão da API:'''


'''f. Scope:'''


'''g. Url Autorização:'''


'''f. Url API:'''

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

>>>>>>>IMAGEM<<<<<<<<

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

>>>>>>>IMAGEM<<<<<<<<

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

>>>>>>>IMAGEM<<<<<<<<

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

>>>>>>>IMAGEM<<<<<<<<

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

>>>>>>>IMAGEM<<<<<<<<

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Nas sessões a seguir estarão descritas apenas as características específicas do Itaú. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

=== Particularidades do cadastro de Portador - Banrisul ===

=== Protesto e Negativação ===

=== Impressão de QR Code no Boleto - Banrisul ===

== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =
== Versão 260601 ==
=== Patch 'b' ===
<references group="Versão 260601.b"/>

GF - Como Fazer - Open Banking para Banco Banrisul

2026-09-16T19:50:01Z

Tais.felles: /* APIs disponíveis e serviços atendidos pelo CIGAM */

MANUAL EM CONSTRUÇÃO
= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs bancárias do '''Banrisul'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Banrisul''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o [[GF - Como Fazer - Open Banking | Manual Open Banking - Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 260601.b BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| Não tratado no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 260601.b BETA
|-
|}

</center>

= Open Banking Banrisul =

== Obtenção de credenciais - Banrisul ==

Para utilizar a integração da API de Cobrança do Banrisul no CIGAM, é necessário obter as credenciais de acesso disponibilizadas pelo [https://developersdev.banrisul.com.br/pages/home.html Portal do Desenvolvedor] do Banrisul.


Antes de iniciar a configuração da integração, é necessário:


* Possuir um convênio de cobrança ativo junto ao Banrisul;
* Solicitar acesso ao Portal do Desenvolvedor do Banrisul;
* Possuir permissão para utilização da API de Cobrança.


O processo de cadastro, habilitação da aplicação, solicitação de acesso aos ambientes e geração das credenciais é realizado exclusivamente pelo Banrisul. As instruções para criação de conta no Portal do Desenvolvedor, solicitação de acesso aos ambientes, cadastro da aplicação e obtenção das credenciais devem ser consultadas diretamente na documentação oficial do Banrisul, disponível nos seguintes endereços:


* [https://developers.banrisul.com.br/pages/home.html Portal do Desenvolvedor do Banrisul]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html Documentação da API de Cobrança]
* [https://developers.banrisul.com.br/pages/docs/clientes-banrisul/api-cobranca-v1.html#section/Explore-nossas-APIs/Acesso-ao-Portal Acesso ao Portal do Desenvolvedor]


Após a conclusão do processo de credenciamento, o Banrisul disponibilizará as credenciais necessárias para autenticação da aplicação. Essas informações serão utilizadas posteriormente na configuração da integração no CIGAM.


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Assistente Open Banking - Banrisul ==

O acesso as parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o banco desejado, e em modo modificar, acesse o botão '''Open Banking''':


'''Abertura do assistente:''' Ao abrir o assistente serão apresentadas as informações necessárias para a configuração, no caso do Banrisul, serão o Client_id e Client_secret.

>>>>>>>IMAGEM<<<<<<<<
 


'''Passo 1:''' Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um.

>>>>>>>IMAGEM<<<<<<<<

'''a. Client Id:'''


'''b. Client Secret:'''


'''c. Ambiente:'''


'''d. Versão da Autorização:'''


'''e. Versão da API:'''


'''f. Scope:'''


'''g. Url Autorização:'''


'''f. Url API:'''

 

'''Passo 2:''' Este passo diz respeito à seleção de convênios, ela serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco seja “041”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

>>>>>>>IMAGEM<<<<<<<<

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 


'''Passo 3:''' Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

>>>>>>>IMAGEM<<<<<<<<

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

>>>>>>>IMAGEM<<<<<<<<

'''Pronto!''' Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

>>>>>>>IMAGEM<<<<<<<<

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

>>>>>>>IMAGEM<<<<<<<<

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco '''Banrisul''', os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Nas sessões a seguir estarão descritas apenas as características específicas do Itaú. Demais instruções de uso do open banking estão no [[GF - Como Fazer - Open Banking]].


== Ambiente de testes - Banrisul ==

O Banrisul disponibiliza um ambiente Sandbox para validação da integração da API de Cobrança antes da utilização em Produção.


O acesso ao ambiente de testes depende de credenciais específicas fornecidas pelo Banrisul. As instruções para habilitação do ambiente e obtenção das credenciais devem ser consultadas na documentação oficial do Portal do Desenvolvedor.


Após a validação da integração, deverão ser utilizadas as credenciais do ambiente de Produção, que são distintas das credenciais de Sandbox.


== Registro de cobrança - Banrisul ==

=== Particularidades do cadastro de Portador - Banrisul ===

=== Protesto e Negativação ===

=== Impressão de QR Code no Boleto - Banrisul ===

== Retorno de cobrança - Banrisul ==

A rotina de retorno do Bradesco funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Retorno Open Banking Banrisul.png|centro]]
 
[[Arquivo:Retorno Open Banking Banrisul Informacoes.png|centro]]

=== Busca Liquidações por "Detalhamento" ===

'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.


'''Empresa:''' Filtro para a empresa do lançamento financeiro.


'''Lançamento:''' Filtro para o número do lançamento financeiro.


'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.


'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.


'''Situação do Boleto:''' Neste filtro teremos duas opções.

* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".

=== Busca Liquidações por "Listagem" ===
'''Data:''' Filtro para a data do título.

'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Ativo: retornará lançamentos registrados com situação em aberto;
* Baixado/Liquidado: retornará lançamentos pagos e baixados.

'''Pesquisa por Data:''' Neste filtro teremos duas opções:
* Data de Registro;
* Data de Vencimento.

A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.

= Alterações de títulos registrados Via Open Banking =

== Abatimento de títulos ==

Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.


=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].


=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].


= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [https://www.cigam.com.br/wiki/index.php?title=FAQ_GF#Open_Banking FAQs - Open Banking]

= Versões =

GF - Como Fazer - Open Banking para Banco Santander

2026-09-15T19:11:52Z

Tais.felles: /* Assistente Open Banking - Santander */

[[categoria:Como_Fazer_Finanças]]

= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso da '''API bancária do Santander'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Santander''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =

<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e Multa
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| 240603.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 251103.BETA
|-
|}

</center>

= Open Banking Santander =

== Obtenção de credenciais - Santander ==

As credenciais do Santander são geradas através do [https://developer.santander.com.br/ Portal Developers]. Para maiores informações, entre em contato com o seu gerente de cash e siga os passos do manual [https://developer.santander.com.br/sites/default/files/2023-10/user_guide_api_de_cobranca_pt_br_v2_3_10_10_23.pdf API de Cobrança Santander] para obtenção do token.


'''IMPORTANTE:''' na seção "2.1 Portal do Desenvolvedor" no trecho ''"Na aba de criação da “Nova aplicação” temos dois tipos de aplicações. Verifique abaixo as regras de cada tipo, para decidir a qual será a opção ideal para você (Sou um desenvolvedor | Utilizo um parceiro):"'' utilize a opção '''sou um desenvolvedor''' e carregue seu proprio certificado A1 (mesmo certificado da nota fiscal).


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Instruções para troca/renovação do certificado digital - Santander ==

A renovação do certificado digital utilizado nas credenciais do Santander é composta por ações semelhantes às do primeiro credenciamento. Contate o seu gerente de Cash para maiores informações.


Refere-se ao certificado A1, o mesmo da NF. Ao gerar as credenciais, é necessário adicionar o certificado, via Portal Developers do Banco.

Para a troca do certificado no CIGAM em cenários onde o novo certificado '''manter o CN e alterar somente sua validade''' basta remover o antigo e instalar o atual. Para validar se a configuração Open Banking está utilizando o novo certificado entre nas Credenciais dos Parâmetros Open Banking e verifique se o campo "Status do Certificado" foi atualizado:

[[Arquivo:Open Banking Santander 0008.png|centro]]
 
[[Arquivo:Parametros Santander - Status do Certificado.png|centro]]

Para mais informações de instalação do certificado acesse a [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado? | FAQ]] sobre instalação e revisão do certificado digital.


== Assistente Open Banking - Santander ==

'''Abertura do assistente: '''Ao abrir o assistente serão apresentadas as informações necessárias para a configuração do Santander.

[[Arquivo:Open Banking Santander 0001.png|centro]]
 


'''Passo 1: '''Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um. O Santander não disponibiliza ambientes de teste, desta forma, preencha apenas os dados da guia "Produção", caso você tenha a necessidade de cadastrar alguns títulos de teste, utilize o campo “Etapa Processo do Boleto" como '''Teste'''.

<ul>

'''a. Client Id: ''' cole aqui a informação obtida no [https://developer.santander.com.br/ Portal Developers] do santander conforme o item [[#Obtenção de credenciais - Santander|Obtenção de credenciais]] deste manual;
 
'''b. Client Secret: ''' cole aqui a informação obtida no [https://developer.santander.com.br/ Portal Developers] do santander conforme o item [[#Obtenção de credenciais - Santander|Obtenção de credenciais]] deste manual;
 
'''c. Etapa Processo do Boleto: ''' Aqui é onde existe a possibilidade de realizar registros de testes no Santander, a opção “etapa processo” permite realizar registros em ambiente não produtivo conforme abaixo:
 
<ul>
01 – Produção: este é o formato oficial onde os títulos serão registrados em ambiente de produção.
 
02 – Teste: mantendo este parâmetro, os títulos serão enviados para um ambiente de testes restritos (apenas registro, sem possibilidade de alteração uma vez que o título não fica registrado, apenas é feita uma validação inicial).
</ul>

'''d. Versão da API: ''' campo preenchido automaticamente pelo CIGAM;
 
'''e. Certificado: ''' informe aqui o “subject/requerente” do certificado digital do cliente. Essa informação é obtida no campo de mesmo nome na guia “detalhes” do certificado digital conforme abaixo:
[[Arquivo:CN Certificado Bradesco.png|centro]]

'''f. Status do Certificado: ''' este campo será preenchido automaticamente com a data e hora de expiração do certificado informado no item acima. Caso não haja este preenchimento, significa que o mesmo não se encontra instalado corretamente, revise a sua instalação e tente novamente.
 
'''g. URL Webhook:''' informe o site que irá receber os retornos do Santander quanto às alterações dos títulos. Esta informação é imprescindível para o uso do retorno de liquidação via data de liquidação, sem ela, o Santander somente permite o retorno via data de vencimento ou emissão. Os requisitos para um site ser aceito como WebHook estão listados na seção [[#Requisitos para o Site a ser apontado como Webhook|Requisitos para o Site a ser apontado como Webhook]]. A sugestão é utilizar o site da sua própria empresa, porém este ainda pode não ser aceito. Para saber se o site foi aceito, deve-se checar o campo “workspace” nos parâmetros open banking do Santander após a configuração, se ele estiver preenchido, o processo teve sucesso.
 
'''h. Usuário para Alerta: ''' informe aqui o usuário que receberá os alertas de vencimento do certificado digital utilizado na parametrização. Esta informação é muito importante pois o processo de renovação junto ao SANTANDER pode levar alguns dias e não será possível registrar títulos com um certificado vencido.
 
'''i. Url Autorização: ''' campo preenchido automaticamente pelo CIGAM;
 
'''j. Url API: ''' campo preenchido automaticamente pelo CIGAM.

</ul>
[[Arquivo:Open Banking Santander 0017.png|centro]]
 


'''Passo 2: '''Este passo diz respeito à seleção de convênios, ela é uma característica do Santander e serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco é “033”.

[[Arquivo:Open Banking Santander 0003.png|centro]]
 


'''Passo 3: '''Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira DESCONTADA e ambos utilizarão a mesma instancia de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Santander 0004.png|centro]]

A opção “Direto” está detalhada no manual de funcionalidades Open Banking, já a opção PIX será detalhada mais a frente neste manual.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Passo_4_Assistente_Bradesco.png|centro]]

'''Pronto! '''Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Open Banking Santander 0006.png|centro]]

'''Atenção: Criação do Workspace Santander'''


Ao concluir a configuração dos bancos, caso as credenciais sejam validadas com sucesso, mas ocorra um erro na criação do Workspace Santander, será apresentada a <ref group="Versão 260504">Liberado a partir da OS 816834/5.</ref>mensagem:


''CGM-7827: Credenciais validadas com sucesso, porém houve erro na criação do Workspace Santander. O problema ocorre quando a URL do Web Hook é inválida nos parâmetros de Open Banking e/ou o convênio do portador de remessa difere do contratado no banco.''


Nessa situação, revise a [[#Requisitos para o Site a ser apontado como Webhook|URL Webhook]] informada nos parâmetros Open Banking e o convênio cadastrado no portador de remessa, verificando se estão de acordo com os dados contratados no banco.


Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no [http://ww2.cigam.com.br/mediawiki/index.php/GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela de parâmetros Open Banking] no manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].

[[Arquivo:Open Banking Santander 0007.png|centro]]

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco Santander, os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Nas sessões a seguir estarão descritas apenas as características específicas do '''Santander'''. Demais instruções de uso do open banking estão no manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].


'''Atenção:''' Revise se na tela de credenciais o workspace foi gerado corretamente, caso esteja em branco consulte a [[Open Banking Santander - Retorno em branco ou "Invalid client credentials" | FAQ]] sobre erro de credenciais.

[[Arquivo:Open Santander Webhook atualizado.png|centro]]

O checkbox <ref group="Versão 260504">Liberado a partir da OS 816834/5.</ref>'''WebHook''' indica que o serviço de WebHook está ativo para a parametrização do Santander. Quando o WebHook estiver ativo, será possível utilizar a opção "Data Liquidação" na rotina de Retorno de Cobrança do Santander. Caso o WebHook não esteja ativo, a opção "Data Liquidação" não poderá ser utilizada, devendo ser selecionada a opção "Vencimento e/ou Data Emissão".


== Requisitos para o Site a ser apontado como Webhook ==

* URL ativa em GET e POST;
* Categorizada no site https://talosintelligence.com/;
* A URL tem que ser https, não pode ser http, por conta do mTLS;
* Ela precisa aceitar qualquer requisição em GET para cadastro.


Devem ser previstas do lado da empresa a implementação de boas práticas relacionadas as configurações da URL:
* Monitoramento da URL. Certificar-se de que esteja online, ativa e devidamente categorizada;
* Registro de URLs HTTPs;
* Liberação das portas 443 e 80;
* URL estar apta a receber POST com o body vazio (para etapa de cadastro da Workspace com Webhook);
* URL estar apta a receber POST com o CONTENT_TYPE application/json;
* Envie uma reposta HTTP adequada para o remetente do Webhook, como um código de status 200 (OK), para indicar que o recebimento foi bem-sucedido. O envio deve ser realizado imediatamente após a recepção da mensagem;
* Tratativa de notificações duplicadas.


== Ambiente de testes - Santander ==

Atualmente não é disponibilizado o ambiente de testes do Santander, para registrar títulos nesta modalidade é necessário utilizar a opção “Teste” disponível nos parâmetros open banking no campo “Etapa Processo do Boleto”, neste formato os títulos são enviados para um ambiente de testes onde é possível realizar o registro, mas não alteração e retorno de títulos.


== Registro de cobrança - Santander ==

O registro do Santander é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Santander ===

'''- Protesto e Negativação:''' O Santander possui apenas o serviço de protesto.
 

- '''Convenio:''' tenha o convênio informado corretamente conforme recebido através do e-mail do Santander, essa informação é essenciais para a correta geração do workspace. Para mais informações sobre a geração do workspace consulte a [[Open Banking Santander - Retorno em branco ou "Invalid client credentials" | FAQ]].
 

=== Impressão de QR Code no Boleto - Santander ===

Uma empresa que queira emitir QR Codes em seus boletos deve possuir credenciais com pix e seguir os itens abaixo:


* marcar a opção “PIX” dos parâmetros open banking;
* possuir a TAG qrcode_pix no seu modelo de boleto caminho para modelo padrão salvo em: ''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098 - Santander_pix.rtf''


A Chave pix será obtida no cadastro do portador de remessa:

[[Arquivo:Open Banking Santander 0014.png|centro]]

'''Observação 1:''' Necessário direito de Menu GF Configurações e configuração 3099 - GF - GE Permitir acesso aos Parâmetros PIX marcada para o usuário para acesso ao botão Parâmetros PIX.


'''Observação 2:''' Caso o tipo de chave seja "Celular" deve-se utilizar a seguinte mácara: +55DDDNUMERO. Exemplo: +5551998899776.


'''Impressão do boleto com QR Code:'''

[[Arquivo:Open Banking Santander 0012.png|centro]]

=== Particularidades de baixa - Santander ===

O Santander permite a baixa do título após 1 minuto do registro.


== Retorno de cobrança - Santander ==

A rotina de retorno do Santander funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Open Banking Santander 0015.png|centro]]
 
[[Arquivo:Open Banking Santander 0016.png|centro]]
 

'''Busca Liquidações por:'''


* '''Vencimento e/ou Data Emissão:''' habilita os filtros UN, Empresa, Lançamento, Vencimento, Data e Situação do Boleto.
**<ref group="Versão 231002.d>Liberado a partir da OS 816822/4.</ref> '''Situação do Boleto:''' Neste filtro teremos duas opções.
*** Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
*** Somente Abertos: retornará somente lançamentos registrados com situação em aberto (entrada).


* <ref group="Versão 241007.d>Liberado a partir da OS 816834/11.</ref> '''Data Liquidação:''' Este retorno funciona na modalidade “listagem” e mostrará todos os títulos encontrados no Santander com a data de liquidação informada, independente dele existir no CIGAM. Este formato de retorno somente está disponível para os clientes que possuem o serviço WEBHOOK ativo e somente retorna títulos registrados após a sua ativação, títulos anteriores à sua ativação não serão apresentados. É importante destacar que esta funcionalidade somente foi liberada na versão '''241007.d''' e que se as suas credenciais tiverem sido geradas em versões anteriores, ou seja, sem a informação da [[#Requisitos para o Site a ser apontado como Webhook|URL Webhook]], você precisará excluir as credenciais atuais e parametrizá-las novamente. [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Como_excluir_uma_parametriza%C3%A7%C3%A3o_Open_Banking Aqui] você encontra informações de como excluir e reinserir credenciais.


= Alterações de títulos registrados Via Open Banking =
== Abatimento de títulos ==

<ref group="Versão 251103">Liberado a partir da OS 816297/7.</ref>Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.

=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].

=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Abatimento de títulos|Como Fazer - Open Banking - Cancelamento de abatimento]].

= Retenção P/C/C - PIS, COFINS, CSLL =

Para quem utiliza o recurso de Controlar Retenções na Saída, ou seja, configuração [[GF - GE - 2505 - Código de imposto para controlar retenção de CSLL na saída]], e deseja registrar o lançamento financeiro no valor líquido, já descontando as retenções, é necessário:
*Parametrizar a configuração [[GF - GE - 3214 - Diminuir valor das retenções do valor total do boleto]], como '''1 - Sempre''' ou '''2 - Por Empresa''', e
*Se a configuração estiver como '''2 - Por Empresa''', deve-se marcar as empresas desejadas no campo '''Descontar Retenção no Boleto'''.

Para mais informações de como funciona esse recurso, consulte a WIKI [[OS 816297/10 – Retenções P/C/C + Boletos + CNAB e Open Banking]].

Para informações sobre o uso do Controle das Retenções na Saída, consulte [[GF - Como Fazer - Controlar Retenções de PIS-COFINS-CSSL-IRRF-INSS-ISS para Nota Fiscal de Saída]].

= CNPJ Alfanumérico =

Campo CNPJ, já é atendido no formato Alfanumérico.

= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [http://ww2.cigam.com.br/mediawiki/index.php/FAQ_GF#Open_Banking FAQs - Open Banking]
* [[Open Banking - Em qual tabela fica gravado o registro do campo "Situação Open Banking" do lançamento financeiro]]
* [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado?]]
* [[Open Banking Santander - Ao tentar registrar boletos através banco Santander via Open Banking (pela primeira vez após implementação), o banco está rejeitando boletos com o motivo de convênio não encontrado na workspace informada]]
*[[Open Banking Santander - Retorno em branco ou "Invalid client credentials"]]
*[[Open Banking - O que é Endpoint, Request e Response?]]

= Documentação Santander =

* [https://www.santander.com.br/atendimento-santander/?ic=homepf-footer-centraldeatendimento Central de Atendimento]
* [https://developer.santander.com.br/api/user-guide/emissao-de-boletos-visao-geral Portal Developer]


= Versões =
== Versão 231002 ==
<references group="Versão 231002"/>
=== Patch 'd' ===
<references group="Versão 231002.d"/>
== Versão 241007 ==
<references group="Versão 241007"/>
=== Patch 'd' ===
<references group="Versão 241007.d"/>
== Versão 251103 ==
<references group="Versão 251103"/>
== Versão 260504 ==
<references group="Versão 260504"/>

GF - Como Fazer - Open Banking para Banco Santander

2026-09-15T19:08:41Z

Tais.felles: /* Assistente Open Banking - Santander */

[[categoria:Como_Fazer_Finanças]]

= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso da '''API bancária do Santander'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Santander''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =

<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e Multa
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| 240603.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 251103.BETA
|-
|}

</center>

= Open Banking Santander =

== Obtenção de credenciais - Santander ==

As credenciais do Santander são geradas através do [https://developer.santander.com.br/ Portal Developers]. Para maiores informações, entre em contato com o seu gerente de cash e siga os passos do manual [https://developer.santander.com.br/sites/default/files/2023-10/user_guide_api_de_cobranca_pt_br_v2_3_10_10_23.pdf API de Cobrança Santander] para obtenção do token.


'''IMPORTANTE:''' na seção "2.1 Portal do Desenvolvedor" no trecho ''"Na aba de criação da “Nova aplicação” temos dois tipos de aplicações. Verifique abaixo as regras de cada tipo, para decidir a qual será a opção ideal para você (Sou um desenvolvedor | Utilizo um parceiro):"'' utilize a opção '''sou um desenvolvedor''' e carregue seu proprio certificado A1 (mesmo certificado da nota fiscal).


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Instruções para troca/renovação do certificado digital - Santander ==

A renovação do certificado digital utilizado nas credenciais do Santander é composta por ações semelhantes às do primeiro credenciamento. Contate o seu gerente de Cash para maiores informações.


Refere-se ao certificado A1, o mesmo da NF. Ao gerar as credenciais, é necessário adicionar o certificado, via Portal Developers do Banco.

Para a troca do certificado no CIGAM em cenários onde o novo certificado '''manter o CN e alterar somente sua validade''' basta remover o antigo e instalar o atual. Para validar se a configuração Open Banking está utilizando o novo certificado entre nas Credenciais dos Parâmetros Open Banking e verifique se o campo "Status do Certificado" foi atualizado:

[[Arquivo:Open Banking Santander 0008.png|centro]]
 
[[Arquivo:Parametros Santander - Status do Certificado.png|centro]]

Para mais informações de instalação do certificado acesse a [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado? | FAQ]] sobre instalação e revisão do certificado digital.


== Assistente Open Banking - Santander ==

'''Abertura do assistente: '''Ao abrir o assistente serão apresentadas as informações necessárias para a configuração do Santander.

[[Arquivo:Open Banking Santander 0001.png|centro]]
 


'''Passo 1: '''Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um. O Santander não disponibiliza ambientes de teste, desta forma, preencha apenas os dados da guia "Produção", caso você tenha a necessidade de cadastrar alguns títulos de teste, utilize o campo “Etapa Processo do Boleto" como '''Teste'''.

<ul>

'''a. Client Id: ''' cole aqui a informação obtida no [https://developer.santander.com.br/ Portal Developers] do santander conforme o item [[#Obtenção de credenciais - Santander|Obtenção de credenciais]] deste manual;
 
'''b. Client Secret: ''' cole aqui a informação obtida no [https://developer.santander.com.br/ Portal Developers] do santander conforme o item [[#Obtenção de credenciais - Santander|Obtenção de credenciais]] deste manual;
 
'''c. Etapa Processo do Boleto: ''' Aqui é onde existe a possibilidade de realizar registros de testes no Santander, a opção “etapa processo” permite realizar registros em ambiente não produtivo conforme abaixo:
 
<ul>
01 – Produção: este é o formato oficial onde os títulos serão registrados em ambiente de produção.
 
02 – Teste: mantendo este parâmetro, os títulos serão enviados para um ambiente de testes restritos (apenas registro, sem possibilidade de alteração uma vez que o título não fica registrado, apenas é feita uma validação inicial).
</ul>

'''d. Versão da API: ''' campo preenchido automaticamente pelo CIGAM;
 
'''e. Certificado: ''' informe aqui o “subject/requerente” do certificado digital do cliente. Essa informação é obtida no campo de mesmo nome na guia “detalhes” do certificado digital conforme abaixo:
[[Arquivo:CN Certificado Bradesco.png|centro]]

'''f. Status do Certificado: ''' este campo será preenchido automaticamente com a data e hora de expiração do certificado informado no item acima. Caso não haja este preenchimento, significa que o mesmo não se encontra instalado corretamente, revise a sua instalação e tente novamente.
 
'''g. URL Webhook:''' informe o site que irá receber os retornos do Santander quanto às alterações dos títulos. Esta informação é imprescindível para o uso do retorno de liquidação via data de liquidação, sem ela, o Santander somente permite o retorno via data de vencimento ou emissão. Os requisitos para um site ser aceito como WebHook estão listados na seção [[#Requisitos para o Site a ser apontado como Webhook|Requisitos para o Site a ser apontado como Webhook]]. A sugestão é utilizar o site da sua própria empresa, porém este ainda pode não ser aceito. Para saber se o site foi aceito, deve-se checar o campo “workspace” nos parâmetros open banking do Santander após a configuração, se ele estiver preenchido, o processo teve sucesso.
 
'''h. Usuário para Alerta: ''' informe aqui o usuário que receberá os alertas de vencimento do certificado digital utilizado na parametrização. Esta informação é muito importante pois o processo de renovação junto ao SANTANDER pode levar alguns dias e não será possível registrar títulos com um certificado vencido.
 
'''i. Url Autorização: ''' campo preenchido automaticamente pelo CIGAM;
 
'''j. Url API: ''' campo preenchido automaticamente pelo CIGAM.

</ul>
[[Arquivo:Open Banking Santander 0017.png|centro]]
 


'''Passo 2: '''Este passo diz respeito à seleção de convênios, ela é uma característica do Santander e serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco é “033”.

[[Arquivo:Open Banking Santander 0003.png|centro]]
 


'''Passo 3: '''Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira DESCONTADA e ambos utilizarão a mesma instancia de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Santander 0004.png|centro]]

A opção “Direto” está detalhada no manual de funcionalidades Open Banking, já a opção PIX será detalhada mais a frente neste manual.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Passo_4_Assistente_Bradesco.png|centro]]

'''Pronto! '''Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Open Banking Santander 0006.png|centro]]

'''Atenção: Criação do Workspace Santander'''


Ao concluir a configuração dos bancos, caso as credenciais sejam validadas com sucesso, mas ocorra um erro na criação do Workspace Santander, será apresentada a <ref group="Versão 260504">Liberado a partir da OS 816834/5.</ref>mensagem:


''CGM-7827: Credenciais validadas com sucesso, porém houve erro na criação do Workspace Santander. O problema ocorre quando a URL do Web Hook é inválida nos parâmetros de Open Banking e/ou o convênio do portador de remessa difere do contratado no banco.''


Nessa situação, revise a [[#Requisitos para o Site a ser apontado como Webhook|URL Webhook]] informada nos parâmetros Open Banking e o convênio cadastrado no portador de remessa, verificando se estão de acordo com os dados contratados no banco.


Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no [http://ww2.cigam.com.br/mediawiki/index.php/GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela de parâmetros Open Banking] no manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].

[[Arquivo:Open Banking Santander 0007.png|centro]]

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco Santander, os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Nas sessões a seguir estarão descritas apenas as características específicas do '''Santander'''. Demais instruções de uso do open banking estão no manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].


'''Atenção:''' Revise se na tela de credenciais o workspace foi gerado corretamente, caso esteja em branco consulte a [[Open Banking Santander - Retorno em branco ou "Invalid client credentials" | FAQ]] sobre erro de credenciais.

[[Arquivo:Open Santander Webhook atualizado.png|centro]]

== Requisitos para o Site a ser apontado como Webhook ==

* URL ativa em GET e POST;
* Categorizada no site https://talosintelligence.com/;
* A URL tem que ser https, não pode ser http, por conta do mTLS;
* Ela precisa aceitar qualquer requisição em GET para cadastro.


Devem ser previstas do lado da empresa a implementação de boas práticas relacionadas as configurações da URL:
* Monitoramento da URL. Certificar-se de que esteja online, ativa e devidamente categorizada;
* Registro de URLs HTTPs;
* Liberação das portas 443 e 80;
* URL estar apta a receber POST com o body vazio (para etapa de cadastro da Workspace com Webhook);
* URL estar apta a receber POST com o CONTENT_TYPE application/json;
* Envie uma reposta HTTP adequada para o remetente do Webhook, como um código de status 200 (OK), para indicar que o recebimento foi bem-sucedido. O envio deve ser realizado imediatamente após a recepção da mensagem;
* Tratativa de notificações duplicadas.


== Ambiente de testes - Santander ==

Atualmente não é disponibilizado o ambiente de testes do Santander, para registrar títulos nesta modalidade é necessário utilizar a opção “Teste” disponível nos parâmetros open banking no campo “Etapa Processo do Boleto”, neste formato os títulos são enviados para um ambiente de testes onde é possível realizar o registro, mas não alteração e retorno de títulos.


== Registro de cobrança - Santander ==

O registro do Santander é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Santander ===

'''- Protesto e Negativação:''' O Santander possui apenas o serviço de protesto.
 

- '''Convenio:''' tenha o convênio informado corretamente conforme recebido através do e-mail do Santander, essa informação é essenciais para a correta geração do workspace. Para mais informações sobre a geração do workspace consulte a [[Open Banking Santander - Retorno em branco ou "Invalid client credentials" | FAQ]].
 

=== Impressão de QR Code no Boleto - Santander ===

Uma empresa que queira emitir QR Codes em seus boletos deve possuir credenciais com pix e seguir os itens abaixo:


* marcar a opção “PIX” dos parâmetros open banking;
* possuir a TAG qrcode_pix no seu modelo de boleto caminho para modelo padrão salvo em: ''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098 - Santander_pix.rtf''


A Chave pix será obtida no cadastro do portador de remessa:

[[Arquivo:Open Banking Santander 0014.png|centro]]

'''Observação 1:''' Necessário direito de Menu GF Configurações e configuração 3099 - GF - GE Permitir acesso aos Parâmetros PIX marcada para o usuário para acesso ao botão Parâmetros PIX.


'''Observação 2:''' Caso o tipo de chave seja "Celular" deve-se utilizar a seguinte mácara: +55DDDNUMERO. Exemplo: +5551998899776.


'''Impressão do boleto com QR Code:'''

[[Arquivo:Open Banking Santander 0012.png|centro]]

=== Particularidades de baixa - Santander ===

O Santander permite a baixa do título após 1 minuto do registro.


== Retorno de cobrança - Santander ==

A rotina de retorno do Santander funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Open Banking Santander 0015.png|centro]]
 
[[Arquivo:Open Banking Santander 0016.png|centro]]
 

'''Busca Liquidações por:'''


* '''Vencimento e/ou Data Emissão:''' habilita os filtros UN, Empresa, Lançamento, Vencimento, Data e Situação do Boleto.
**<ref group="Versão 231002.d>Liberado a partir da OS 816822/4.</ref> '''Situação do Boleto:''' Neste filtro teremos duas opções.
*** Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
*** Somente Abertos: retornará somente lançamentos registrados com situação em aberto (entrada).


* <ref group="Versão 241007.d>Liberado a partir da OS 816834/11.</ref> '''Data Liquidação:''' Este retorno funciona na modalidade “listagem” e mostrará todos os títulos encontrados no Santander com a data de liquidação informada, independente dele existir no CIGAM. Este formato de retorno somente está disponível para os clientes que possuem o serviço WEBHOOK ativo e somente retorna títulos registrados após a sua ativação, títulos anteriores à sua ativação não serão apresentados. É importante destacar que esta funcionalidade somente foi liberada na versão '''241007.d''' e que se as suas credenciais tiverem sido geradas em versões anteriores, ou seja, sem a informação da [[#Requisitos para o Site a ser apontado como Webhook|URL Webhook]], você precisará excluir as credenciais atuais e parametrizá-las novamente. [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Como_excluir_uma_parametriza%C3%A7%C3%A3o_Open_Banking Aqui] você encontra informações de como excluir e reinserir credenciais.


= Alterações de títulos registrados Via Open Banking =
== Abatimento de títulos ==

<ref group="Versão 251103">Liberado a partir da OS 816297/7.</ref>Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.

=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].

=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Abatimento de títulos|Como Fazer - Open Banking - Cancelamento de abatimento]].

= Retenção P/C/C - PIS, COFINS, CSLL =

Para quem utiliza o recurso de Controlar Retenções na Saída, ou seja, configuração [[GF - GE - 2505 - Código de imposto para controlar retenção de CSLL na saída]], e deseja registrar o lançamento financeiro no valor líquido, já descontando as retenções, é necessário:
*Parametrizar a configuração [[GF - GE - 3214 - Diminuir valor das retenções do valor total do boleto]], como '''1 - Sempre''' ou '''2 - Por Empresa''', e
*Se a configuração estiver como '''2 - Por Empresa''', deve-se marcar as empresas desejadas no campo '''Descontar Retenção no Boleto'''.

Para mais informações de como funciona esse recurso, consulte a WIKI [[OS 816297/10 – Retenções P/C/C + Boletos + CNAB e Open Banking]].

Para informações sobre o uso do Controle das Retenções na Saída, consulte [[GF - Como Fazer - Controlar Retenções de PIS-COFINS-CSSL-IRRF-INSS-ISS para Nota Fiscal de Saída]].

= CNPJ Alfanumérico =

Campo CNPJ, já é atendido no formato Alfanumérico.

= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [http://ww2.cigam.com.br/mediawiki/index.php/FAQ_GF#Open_Banking FAQs - Open Banking]
* [[Open Banking - Em qual tabela fica gravado o registro do campo "Situação Open Banking" do lançamento financeiro]]
* [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado?]]
* [[Open Banking Santander - Ao tentar registrar boletos através banco Santander via Open Banking (pela primeira vez após implementação), o banco está rejeitando boletos com o motivo de convênio não encontrado na workspace informada]]
*[[Open Banking Santander - Retorno em branco ou "Invalid client credentials"]]
*[[Open Banking - O que é Endpoint, Request e Response?]]

= Documentação Santander =

* [https://www.santander.com.br/atendimento-santander/?ic=homepf-footer-centraldeatendimento Central de Atendimento]
* [https://developer.santander.com.br/api/user-guide/emissao-de-boletos-visao-geral Portal Developer]


= Versões =
== Versão 231002 ==
<references group="Versão 231002"/>
=== Patch 'd' ===
<references group="Versão 231002.d"/>
== Versão 241007 ==
<references group="Versão 241007"/>
=== Patch 'd' ===
<references group="Versão 241007.d"/>
== Versão 251103 ==
<references group="Versão 251103"/>
== Versão 260504 ==
<references group="Versão 260504"/>

GF - Como Fazer - Open Banking para Banco Santander

2026-09-15T19:05:26Z

Tais.felles: /* Versões */

[[categoria:Como_Fazer_Finanças]]

= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso da '''API bancária do Santander'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Santander''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =

<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e Multa
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| 240603.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 251103.BETA
|-
|}

</center>

= Open Banking Santander =

== Obtenção de credenciais - Santander ==

As credenciais do Santander são geradas através do [https://developer.santander.com.br/ Portal Developers]. Para maiores informações, entre em contato com o seu gerente de cash e siga os passos do manual [https://developer.santander.com.br/sites/default/files/2023-10/user_guide_api_de_cobranca_pt_br_v2_3_10_10_23.pdf API de Cobrança Santander] para obtenção do token.


'''IMPORTANTE:''' na seção "2.1 Portal do Desenvolvedor" no trecho ''"Na aba de criação da “Nova aplicação” temos dois tipos de aplicações. Verifique abaixo as regras de cada tipo, para decidir a qual será a opção ideal para você (Sou um desenvolvedor | Utilizo um parceiro):"'' utilize a opção '''sou um desenvolvedor''' e carregue seu proprio certificado A1 (mesmo certificado da nota fiscal).


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Instruções para troca/renovação do certificado digital - Santander ==

A renovação do certificado digital utilizado nas credenciais do Santander é composta por ações semelhantes às do primeiro credenciamento. Contate o seu gerente de Cash para maiores informações.


Refere-se ao certificado A1, o mesmo da NF. Ao gerar as credenciais, é necessário adicionar o certificado, via Portal Developers do Banco.

Para a troca do certificado no CIGAM em cenários onde o novo certificado '''manter o CN e alterar somente sua validade''' basta remover o antigo e instalar o atual. Para validar se a configuração Open Banking está utilizando o novo certificado entre nas Credenciais dos Parâmetros Open Banking e verifique se o campo "Status do Certificado" foi atualizado:

[[Arquivo:Open Banking Santander 0008.png|centro]]
 
[[Arquivo:Parametros Santander - Status do Certificado.png|centro]]

Para mais informações de instalação do certificado acesse a [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado? | FAQ]] sobre instalação e revisão do certificado digital.


== Assistente Open Banking - Santander ==

'''Abertura do assistente: '''Ao abrir o assistente serão apresentadas as informações necessárias para a configuração do Santander.

[[Arquivo:Open Banking Santander 0001.png|centro]]
 


'''Passo 1: '''Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um. O Santander não disponibiliza ambientes de teste, desta forma, preencha apenas os dados da guia "Produção", caso você tenha a necessidade de cadastrar alguns títulos de teste, utilize o campo “Etapa Processo do Boleto" como '''Teste'''.

<ul>

'''a. Client Id: ''' cole aqui a informação obtida no [https://developer.santander.com.br/ Portal Developers] do santander conforme o item [[#Obtenção de credenciais - Santander|Obtenção de credenciais]] deste manual;
 
'''b. Client Secret: ''' cole aqui a informação obtida no [https://developer.santander.com.br/ Portal Developers] do santander conforme o item [[#Obtenção de credenciais - Santander|Obtenção de credenciais]] deste manual;
 
'''c. Etapa Processo do Boleto: ''' Aqui é onde existe a possibilidade de realizar registros de testes no Santander, a opção “etapa processo” permite realizar registros em ambiente não produtivo conforme abaixo:
 
<ul>
01 – Produção: este é o formato oficial onde os títulos serão registrados em ambiente de produção.
 
02 – Teste: mantendo este parâmetro, os títulos serão enviados para um ambiente de testes restritos (apenas registro, sem possibilidade de alteração uma vez que o título não fica registrado, apenas é feita uma validação inicial).
</ul>

'''d. Versão da API: ''' campo preenchido automaticamente pelo CIGAM;
 
'''e. Certificado: ''' informe aqui o “subject/requerente” do certificado digital do cliente. Essa informação é obtida no campo de mesmo nome na guia “detalhes” do certificado digital conforme abaixo:
[[Arquivo:CN Certificado Bradesco.png|centro]]

'''f. Status do Certificado: ''' este campo será preenchido automaticamente com a data e hora de expiração do certificado informado no item acima. Caso não haja este preenchimento, significa que o mesmo não se encontra instalado corretamente, revise a sua instalação e tente novamente.
 
'''g. URL Webhook:''' informe o site que irá receber os retornos do Santander quanto às alterações dos títulos. Esta informação é imprescindível para o uso do retorno de liquidação via data de liquidação, sem ela, o Santander somente permite o retorno via data de vencimento ou emissão. Os requisitos para um site ser aceito como WebHook estão listados na seção [[#Requisitos para o Site a ser apontado como Webhook|Requisitos para o Site a ser apontado como Webhook]]. A sugestão é utilizar o site da sua própria empresa, porém este ainda pode não ser aceito. Para saber se o site foi aceito, deve-se checar o campo “workspace” nos parâmetros open banking do Santander após a configuração, se ele estiver preenchido, o processo teve sucesso.
 
'''h. Usuário para Alerta: ''' informe aqui o usuário que receberá os alertas de vencimento do certificado digital utilizado na parametrização. Esta informação é muito importante pois o processo de renovação junto ao SANTANDER pode levar alguns dias e não será possível registrar títulos com um certificado vencido.
 
'''i. Url Autorização: ''' campo preenchido automaticamente pelo CIGAM;
 
'''j. Url API: ''' campo preenchido automaticamente pelo CIGAM.

</ul>
[[Arquivo:Open Banking Santander 0017.png|centro]]
 


'''Passo 2: '''Este passo diz respeito à seleção de convênios, ela é uma característica do Santander e serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco é “033”.

[[Arquivo:Open Banking Santander 0003.png|centro]]
 


'''Passo 3: '''Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira DESCONTADA e ambos utilizarão a mesma instancia de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Santander 0004.png|centro]]

A opção “Direto” está detalhada no manual de funcionalidades Open Banking, já a opção PIX será detalhada mais a frente neste manual.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Passo_4_Assistente_Bradesco.png|centro]]

'''Pronto! '''Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Open Banking Santander 0006.png|centro]]

'''Atenção: Criação do Workspace Santander'''


Ao concluir a configuração dos bancos, caso as credenciais sejam validadas com sucesso, mas ocorra um erro na criação do Workspace Santander, será apresentada a mensagem:


''CGM-7827: Credenciais validadas com sucesso, porém houve erro na criação do Workspace Santander. O problema ocorre quando a URL do Web Hook é inválida nos parâmetros de Open Banking e/ou o convênio do portador de remessa difere do contratado no banco.''


Nessa situação, revise a [[#Requisitos para o Site a ser apontado como Webhook|URL Webhook]] informada nos parâmetros Open Banking e o convênio cadastrado no portador de remessa, verificando se estão de acordo com os dados contratados no banco.


Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no [http://ww2.cigam.com.br/mediawiki/index.php/GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela de parâmetros Open Banking] no manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].

[[Arquivo:Open Banking Santander 0007.png|centro]]

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco Santander, os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Nas sessões a seguir estarão descritas apenas as características específicas do '''Santander'''. Demais instruções de uso do open banking estão no manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].


'''Atenção:''' Revise se na tela de credenciais o workspace foi gerado corretamente, caso esteja em branco consulte a [[Open Banking Santander - Retorno em branco ou "Invalid client credentials" | FAQ]] sobre erro de credenciais.

[[Arquivo:Open Santander Webhook atualizado.png|centro]]

== Requisitos para o Site a ser apontado como Webhook ==

* URL ativa em GET e POST;
* Categorizada no site https://talosintelligence.com/;
* A URL tem que ser https, não pode ser http, por conta do mTLS;
* Ela precisa aceitar qualquer requisição em GET para cadastro.


Devem ser previstas do lado da empresa a implementação de boas práticas relacionadas as configurações da URL:
* Monitoramento da URL. Certificar-se de que esteja online, ativa e devidamente categorizada;
* Registro de URLs HTTPs;
* Liberação das portas 443 e 80;
* URL estar apta a receber POST com o body vazio (para etapa de cadastro da Workspace com Webhook);
* URL estar apta a receber POST com o CONTENT_TYPE application/json;
* Envie uma reposta HTTP adequada para o remetente do Webhook, como um código de status 200 (OK), para indicar que o recebimento foi bem-sucedido. O envio deve ser realizado imediatamente após a recepção da mensagem;
* Tratativa de notificações duplicadas.


== Ambiente de testes - Santander ==

Atualmente não é disponibilizado o ambiente de testes do Santander, para registrar títulos nesta modalidade é necessário utilizar a opção “Teste” disponível nos parâmetros open banking no campo “Etapa Processo do Boleto”, neste formato os títulos são enviados para um ambiente de testes onde é possível realizar o registro, mas não alteração e retorno de títulos.


== Registro de cobrança - Santander ==

O registro do Santander é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Santander ===

'''- Protesto e Negativação:''' O Santander possui apenas o serviço de protesto.
 

- '''Convenio:''' tenha o convênio informado corretamente conforme recebido através do e-mail do Santander, essa informação é essenciais para a correta geração do workspace. Para mais informações sobre a geração do workspace consulte a [[Open Banking Santander - Retorno em branco ou "Invalid client credentials" | FAQ]].
 

=== Impressão de QR Code no Boleto - Santander ===

Uma empresa que queira emitir QR Codes em seus boletos deve possuir credenciais com pix e seguir os itens abaixo:


* marcar a opção “PIX” dos parâmetros open banking;
* possuir a TAG qrcode_pix no seu modelo de boleto caminho para modelo padrão salvo em: ''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098 - Santander_pix.rtf''


A Chave pix será obtida no cadastro do portador de remessa:

[[Arquivo:Open Banking Santander 0014.png|centro]]

'''Observação 1:''' Necessário direito de Menu GF Configurações e configuração 3099 - GF - GE Permitir acesso aos Parâmetros PIX marcada para o usuário para acesso ao botão Parâmetros PIX.


'''Observação 2:''' Caso o tipo de chave seja "Celular" deve-se utilizar a seguinte mácara: +55DDDNUMERO. Exemplo: +5551998899776.


'''Impressão do boleto com QR Code:'''

[[Arquivo:Open Banking Santander 0012.png|centro]]

=== Particularidades de baixa - Santander ===

O Santander permite a baixa do título após 1 minuto do registro.


== Retorno de cobrança - Santander ==

A rotina de retorno do Santander funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Open Banking Santander 0015.png|centro]]
 
[[Arquivo:Open Banking Santander 0016.png|centro]]
 

'''Busca Liquidações por:'''


* '''Vencimento e/ou Data Emissão:''' habilita os filtros UN, Empresa, Lançamento, Vencimento, Data e Situação do Boleto.
**<ref group="Versão 231002.d>Liberado a partir da OS 816822/4.</ref> '''Situação do Boleto:''' Neste filtro teremos duas opções.
*** Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
*** Somente Abertos: retornará somente lançamentos registrados com situação em aberto (entrada).


* <ref group="Versão 241007.d>Liberado a partir da OS 816834/11.</ref> '''Data Liquidação:''' Este retorno funciona na modalidade “listagem” e mostrará todos os títulos encontrados no Santander com a data de liquidação informada, independente dele existir no CIGAM. Este formato de retorno somente está disponível para os clientes que possuem o serviço WEBHOOK ativo e somente retorna títulos registrados após a sua ativação, títulos anteriores à sua ativação não serão apresentados. É importante destacar que esta funcionalidade somente foi liberada na versão '''241007.d''' e que se as suas credenciais tiverem sido geradas em versões anteriores, ou seja, sem a informação da [[#Requisitos para o Site a ser apontado como Webhook|URL Webhook]], você precisará excluir as credenciais atuais e parametrizá-las novamente. [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Como_excluir_uma_parametriza%C3%A7%C3%A3o_Open_Banking Aqui] você encontra informações de como excluir e reinserir credenciais.


= Alterações de títulos registrados Via Open Banking =
== Abatimento de títulos ==

<ref group="Versão 251103">Liberado a partir da OS 816297/7.</ref>Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.

=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].

=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Abatimento de títulos|Como Fazer - Open Banking - Cancelamento de abatimento]].

= Retenção P/C/C - PIS, COFINS, CSLL =

Para quem utiliza o recurso de Controlar Retenções na Saída, ou seja, configuração [[GF - GE - 2505 - Código de imposto para controlar retenção de CSLL na saída]], e deseja registrar o lançamento financeiro no valor líquido, já descontando as retenções, é necessário:
*Parametrizar a configuração [[GF - GE - 3214 - Diminuir valor das retenções do valor total do boleto]], como '''1 - Sempre''' ou '''2 - Por Empresa''', e
*Se a configuração estiver como '''2 - Por Empresa''', deve-se marcar as empresas desejadas no campo '''Descontar Retenção no Boleto'''.

Para mais informações de como funciona esse recurso, consulte a WIKI [[OS 816297/10 – Retenções P/C/C + Boletos + CNAB e Open Banking]].

Para informações sobre o uso do Controle das Retenções na Saída, consulte [[GF - Como Fazer - Controlar Retenções de PIS-COFINS-CSSL-IRRF-INSS-ISS para Nota Fiscal de Saída]].

= CNPJ Alfanumérico =

Campo CNPJ, já é atendido no formato Alfanumérico.

= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [http://ww2.cigam.com.br/mediawiki/index.php/FAQ_GF#Open_Banking FAQs - Open Banking]
* [[Open Banking - Em qual tabela fica gravado o registro do campo "Situação Open Banking" do lançamento financeiro]]
* [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado?]]
* [[Open Banking Santander - Ao tentar registrar boletos através banco Santander via Open Banking (pela primeira vez após implementação), o banco está rejeitando boletos com o motivo de convênio não encontrado na workspace informada]]
*[[Open Banking Santander - Retorno em branco ou "Invalid client credentials"]]
*[[Open Banking - O que é Endpoint, Request e Response?]]

= Documentação Santander =

* [https://www.santander.com.br/atendimento-santander/?ic=homepf-footer-centraldeatendimento Central de Atendimento]
* [https://developer.santander.com.br/api/user-guide/emissao-de-boletos-visao-geral Portal Developer]


= Versões =
== Versão 231002 ==
<references group="Versão 231002"/>
=== Patch 'd' ===
<references group="Versão 231002.d"/>
== Versão 241007 ==
<references group="Versão 241007"/>
=== Patch 'd' ===
<references group="Versão 241007.d"/>
== Versão 251103 ==
<references group="Versão 251103"/>
== Versão 260504 ==
<references group="Versão 260504"/>

GF - Como Fazer - Open Banking para Banco Santander

2026-09-15T19:01:09Z

Tais.felles: /* Assistente Open Banking - Santander */

[[categoria:Como_Fazer_Finanças]]

= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso da '''API bancária do Santander'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Santander''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =

<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e Multa
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| 240603.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 251103.BETA
|-
|}

</center>

= Open Banking Santander =

== Obtenção de credenciais - Santander ==

As credenciais do Santander são geradas através do [https://developer.santander.com.br/ Portal Developers]. Para maiores informações, entre em contato com o seu gerente de cash e siga os passos do manual [https://developer.santander.com.br/sites/default/files/2023-10/user_guide_api_de_cobranca_pt_br_v2_3_10_10_23.pdf API de Cobrança Santander] para obtenção do token.


'''IMPORTANTE:''' na seção "2.1 Portal do Desenvolvedor" no trecho ''"Na aba de criação da “Nova aplicação” temos dois tipos de aplicações. Verifique abaixo as regras de cada tipo, para decidir a qual será a opção ideal para você (Sou um desenvolvedor | Utilizo um parceiro):"'' utilize a opção '''sou um desenvolvedor''' e carregue seu proprio certificado A1 (mesmo certificado da nota fiscal).


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Instruções para troca/renovação do certificado digital - Santander ==

A renovação do certificado digital utilizado nas credenciais do Santander é composta por ações semelhantes às do primeiro credenciamento. Contate o seu gerente de Cash para maiores informações.


Refere-se ao certificado A1, o mesmo da NF. Ao gerar as credenciais, é necessário adicionar o certificado, via Portal Developers do Banco.

Para a troca do certificado no CIGAM em cenários onde o novo certificado '''manter o CN e alterar somente sua validade''' basta remover o antigo e instalar o atual. Para validar se a configuração Open Banking está utilizando o novo certificado entre nas Credenciais dos Parâmetros Open Banking e verifique se o campo "Status do Certificado" foi atualizado:

[[Arquivo:Open Banking Santander 0008.png|centro]]
 
[[Arquivo:Parametros Santander - Status do Certificado.png|centro]]

Para mais informações de instalação do certificado acesse a [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado? | FAQ]] sobre instalação e revisão do certificado digital.


== Assistente Open Banking - Santander ==

'''Abertura do assistente: '''Ao abrir o assistente serão apresentadas as informações necessárias para a configuração do Santander.

[[Arquivo:Open Banking Santander 0001.png|centro]]
 


'''Passo 1: '''Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um. O Santander não disponibiliza ambientes de teste, desta forma, preencha apenas os dados da guia "Produção", caso você tenha a necessidade de cadastrar alguns títulos de teste, utilize o campo “Etapa Processo do Boleto" como '''Teste'''.

<ul>

'''a. Client Id: ''' cole aqui a informação obtida no [https://developer.santander.com.br/ Portal Developers] do santander conforme o item [[#Obtenção de credenciais - Santander|Obtenção de credenciais]] deste manual;
 
'''b. Client Secret: ''' cole aqui a informação obtida no [https://developer.santander.com.br/ Portal Developers] do santander conforme o item [[#Obtenção de credenciais - Santander|Obtenção de credenciais]] deste manual;
 
'''c. Etapa Processo do Boleto: ''' Aqui é onde existe a possibilidade de realizar registros de testes no Santander, a opção “etapa processo” permite realizar registros em ambiente não produtivo conforme abaixo:
 
<ul>
01 – Produção: este é o formato oficial onde os títulos serão registrados em ambiente de produção.
 
02 – Teste: mantendo este parâmetro, os títulos serão enviados para um ambiente de testes restritos (apenas registro, sem possibilidade de alteração uma vez que o título não fica registrado, apenas é feita uma validação inicial).
</ul>

'''d. Versão da API: ''' campo preenchido automaticamente pelo CIGAM;
 
'''e. Certificado: ''' informe aqui o “subject/requerente” do certificado digital do cliente. Essa informação é obtida no campo de mesmo nome na guia “detalhes” do certificado digital conforme abaixo:
[[Arquivo:CN Certificado Bradesco.png|centro]]

'''f. Status do Certificado: ''' este campo será preenchido automaticamente com a data e hora de expiração do certificado informado no item acima. Caso não haja este preenchimento, significa que o mesmo não se encontra instalado corretamente, revise a sua instalação e tente novamente.
 
'''g. URL Webhook:''' informe o site que irá receber os retornos do Santander quanto às alterações dos títulos. Esta informação é imprescindível para o uso do retorno de liquidação via data de liquidação, sem ela, o Santander somente permite o retorno via data de vencimento ou emissão. Os requisitos para um site ser aceito como WebHook estão listados na seção [[#Requisitos para o Site a ser apontado como Webhook|Requisitos para o Site a ser apontado como Webhook]]. A sugestão é utilizar o site da sua própria empresa, porém este ainda pode não ser aceito. Para saber se o site foi aceito, deve-se checar o campo “workspace” nos parâmetros open banking do Santander após a configuração, se ele estiver preenchido, o processo teve sucesso.
 
'''h. Usuário para Alerta: ''' informe aqui o usuário que receberá os alertas de vencimento do certificado digital utilizado na parametrização. Esta informação é muito importante pois o processo de renovação junto ao SANTANDER pode levar alguns dias e não será possível registrar títulos com um certificado vencido.
 
'''i. Url Autorização: ''' campo preenchido automaticamente pelo CIGAM;
 
'''j. Url API: ''' campo preenchido automaticamente pelo CIGAM.

</ul>
[[Arquivo:Open Banking Santander 0017.png|centro]]
 


'''Passo 2: '''Este passo diz respeito à seleção de convênios, ela é uma característica do Santander e serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco é “033”.

[[Arquivo:Open Banking Santander 0003.png|centro]]
 


'''Passo 3: '''Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira DESCONTADA e ambos utilizarão a mesma instancia de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Santander 0004.png|centro]]

A opção “Direto” está detalhada no manual de funcionalidades Open Banking, já a opção PIX será detalhada mais a frente neste manual.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Passo_4_Assistente_Bradesco.png|centro]]

'''Pronto! '''Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Open Banking Santander 0006.png|centro]]

'''Atenção: Criação do Workspace Santander'''


Ao concluir a configuração dos bancos, caso as credenciais sejam validadas com sucesso, mas ocorra um erro na criação do Workspace Santander, será apresentada a mensagem:


''CGM-7827: Credenciais validadas com sucesso, porém houve erro na criação do Workspace Santander. O problema ocorre quando a URL do Web Hook é inválida nos parâmetros de Open Banking e/ou o convênio do portador de remessa difere do contratado no banco.''


Nessa situação, revise a [[#Requisitos para o Site a ser apontado como Webhook|URL Webhook]] informada nos parâmetros Open Banking e o convênio cadastrado no portador de remessa, verificando se estão de acordo com os dados contratados no banco.


Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no [http://ww2.cigam.com.br/mediawiki/index.php/GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela de parâmetros Open Banking] no manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].

[[Arquivo:Open Banking Santander 0007.png|centro]]

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco Santander, os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Nas sessões a seguir estarão descritas apenas as características específicas do '''Santander'''. Demais instruções de uso do open banking estão no manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].


'''Atenção:''' Revise se na tela de credenciais o workspace foi gerado corretamente, caso esteja em branco consulte a [[Open Banking Santander - Retorno em branco ou "Invalid client credentials" | FAQ]] sobre erro de credenciais.

[[Arquivo:Open Santander Webhook atualizado.png|centro]]

== Requisitos para o Site a ser apontado como Webhook ==

* URL ativa em GET e POST;
* Categorizada no site https://talosintelligence.com/;
* A URL tem que ser https, não pode ser http, por conta do mTLS;
* Ela precisa aceitar qualquer requisição em GET para cadastro.


Devem ser previstas do lado da empresa a implementação de boas práticas relacionadas as configurações da URL:
* Monitoramento da URL. Certificar-se de que esteja online, ativa e devidamente categorizada;
* Registro de URLs HTTPs;
* Liberação das portas 443 e 80;
* URL estar apta a receber POST com o body vazio (para etapa de cadastro da Workspace com Webhook);
* URL estar apta a receber POST com o CONTENT_TYPE application/json;
* Envie uma reposta HTTP adequada para o remetente do Webhook, como um código de status 200 (OK), para indicar que o recebimento foi bem-sucedido. O envio deve ser realizado imediatamente após a recepção da mensagem;
* Tratativa de notificações duplicadas.


== Ambiente de testes - Santander ==

Atualmente não é disponibilizado o ambiente de testes do Santander, para registrar títulos nesta modalidade é necessário utilizar a opção “Teste” disponível nos parâmetros open banking no campo “Etapa Processo do Boleto”, neste formato os títulos são enviados para um ambiente de testes onde é possível realizar o registro, mas não alteração e retorno de títulos.


== Registro de cobrança - Santander ==

O registro do Santander é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Santander ===

'''- Protesto e Negativação:''' O Santander possui apenas o serviço de protesto.
 

- '''Convenio:''' tenha o convênio informado corretamente conforme recebido através do e-mail do Santander, essa informação é essenciais para a correta geração do workspace. Para mais informações sobre a geração do workspace consulte a [[Open Banking Santander - Retorno em branco ou "Invalid client credentials" | FAQ]].
 

=== Impressão de QR Code no Boleto - Santander ===

Uma empresa que queira emitir QR Codes em seus boletos deve possuir credenciais com pix e seguir os itens abaixo:


* marcar a opção “PIX” dos parâmetros open banking;
* possuir a TAG qrcode_pix no seu modelo de boleto caminho para modelo padrão salvo em: ''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098 - Santander_pix.rtf''


A Chave pix será obtida no cadastro do portador de remessa:

[[Arquivo:Open Banking Santander 0014.png|centro]]

'''Observação 1:''' Necessário direito de Menu GF Configurações e configuração 3099 - GF - GE Permitir acesso aos Parâmetros PIX marcada para o usuário para acesso ao botão Parâmetros PIX.


'''Observação 2:''' Caso o tipo de chave seja "Celular" deve-se utilizar a seguinte mácara: +55DDDNUMERO. Exemplo: +5551998899776.


'''Impressão do boleto com QR Code:'''

[[Arquivo:Open Banking Santander 0012.png|centro]]

=== Particularidades de baixa - Santander ===

O Santander permite a baixa do título após 1 minuto do registro.


== Retorno de cobrança - Santander ==

A rotina de retorno do Santander funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Open Banking Santander 0015.png|centro]]
 
[[Arquivo:Open Banking Santander 0016.png|centro]]
 

'''Busca Liquidações por:'''


* '''Vencimento e/ou Data Emissão:''' habilita os filtros UN, Empresa, Lançamento, Vencimento, Data e Situação do Boleto.
**<ref group="Versão 231002.d>Liberado a partir da OS 816822/4.</ref> '''Situação do Boleto:''' Neste filtro teremos duas opções.
*** Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
*** Somente Abertos: retornará somente lançamentos registrados com situação em aberto (entrada).


* <ref group="Versão 241007.d>Liberado a partir da OS 816834/11.</ref> '''Data Liquidação:''' Este retorno funciona na modalidade “listagem” e mostrará todos os títulos encontrados no Santander com a data de liquidação informada, independente dele existir no CIGAM. Este formato de retorno somente está disponível para os clientes que possuem o serviço WEBHOOK ativo e somente retorna títulos registrados após a sua ativação, títulos anteriores à sua ativação não serão apresentados. É importante destacar que esta funcionalidade somente foi liberada na versão '''241007.d''' e que se as suas credenciais tiverem sido geradas em versões anteriores, ou seja, sem a informação da [[#Requisitos para o Site a ser apontado como Webhook|URL Webhook]], você precisará excluir as credenciais atuais e parametrizá-las novamente. [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Como_excluir_uma_parametriza%C3%A7%C3%A3o_Open_Banking Aqui] você encontra informações de como excluir e reinserir credenciais.


= Alterações de títulos registrados Via Open Banking =
== Abatimento de títulos ==

<ref group="Versão 251103">Liberado a partir da OS 816297/7.</ref>Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.

=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].

=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Abatimento de títulos|Como Fazer - Open Banking - Cancelamento de abatimento]].

= Retenção P/C/C - PIS, COFINS, CSLL =

Para quem utiliza o recurso de Controlar Retenções na Saída, ou seja, configuração [[GF - GE - 2505 - Código de imposto para controlar retenção de CSLL na saída]], e deseja registrar o lançamento financeiro no valor líquido, já descontando as retenções, é necessário:
*Parametrizar a configuração [[GF - GE - 3214 - Diminuir valor das retenções do valor total do boleto]], como '''1 - Sempre''' ou '''2 - Por Empresa''', e
*Se a configuração estiver como '''2 - Por Empresa''', deve-se marcar as empresas desejadas no campo '''Descontar Retenção no Boleto'''.

Para mais informações de como funciona esse recurso, consulte a WIKI [[OS 816297/10 – Retenções P/C/C + Boletos + CNAB e Open Banking]].

Para informações sobre o uso do Controle das Retenções na Saída, consulte [[GF - Como Fazer - Controlar Retenções de PIS-COFINS-CSSL-IRRF-INSS-ISS para Nota Fiscal de Saída]].

= CNPJ Alfanumérico =

Campo CNPJ, já é atendido no formato Alfanumérico.

= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [http://ww2.cigam.com.br/mediawiki/index.php/FAQ_GF#Open_Banking FAQs - Open Banking]
* [[Open Banking - Em qual tabela fica gravado o registro do campo "Situação Open Banking" do lançamento financeiro]]
* [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado?]]
* [[Open Banking Santander - Ao tentar registrar boletos através banco Santander via Open Banking (pela primeira vez após implementação), o banco está rejeitando boletos com o motivo de convênio não encontrado na workspace informada]]
*[[Open Banking Santander - Retorno em branco ou "Invalid client credentials"]]
*[[Open Banking - O que é Endpoint, Request e Response?]]

= Documentação Santander =

* [https://www.santander.com.br/atendimento-santander/?ic=homepf-footer-centraldeatendimento Central de Atendimento]
* [https://developer.santander.com.br/api/user-guide/emissao-de-boletos-visao-geral Portal Developer]


= Versões =
== Versão 231002 ==
<references group="Versão 231002"/>
=== Patch 'd' ===
<references group="Versão 231002.d"/>
== Versão 241007 ==
<references group="Versão 241007"/>
=== Patch 'd' ===
<references group="Versão 241007.d"/>
== Versão 251103 ==
<references group="Versão 251103"/>

Arquivo:Open Santander Webhook atualizado.png

2026-09-15T18:57:07Z

Tais.felles:

Open Santander Webhook atualizado

GF - Como Fazer - Open Banking para Banco Santander

2026-09-15T18:46:17Z

Tais.felles: /* Assistente Open Banking - Santander */

[[categoria:Como_Fazer_Finanças]]

= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso da '''API bancária do Santander'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Santander''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =

<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e Multa
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| 240603.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 251103.BETA
|-
|}

</center>

= Open Banking Santander =

== Obtenção de credenciais - Santander ==

As credenciais do Santander são geradas através do [https://developer.santander.com.br/ Portal Developers]. Para maiores informações, entre em contato com o seu gerente de cash e siga os passos do manual [https://developer.santander.com.br/sites/default/files/2023-10/user_guide_api_de_cobranca_pt_br_v2_3_10_10_23.pdf API de Cobrança Santander] para obtenção do token.


'''IMPORTANTE:''' na seção "2.1 Portal do Desenvolvedor" no trecho ''"Na aba de criação da “Nova aplicação” temos dois tipos de aplicações. Verifique abaixo as regras de cada tipo, para decidir a qual será a opção ideal para você (Sou um desenvolvedor | Utilizo um parceiro):"'' utilize a opção '''sou um desenvolvedor''' e carregue seu proprio certificado A1 (mesmo certificado da nota fiscal).


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Instruções para troca/renovação do certificado digital - Santander ==

A renovação do certificado digital utilizado nas credenciais do Santander é composta por ações semelhantes às do primeiro credenciamento. Contate o seu gerente de Cash para maiores informações.


Refere-se ao certificado A1, o mesmo da NF. Ao gerar as credenciais, é necessário adicionar o certificado, via Portal Developers do Banco.

Para a troca do certificado no CIGAM em cenários onde o novo certificado '''manter o CN e alterar somente sua validade''' basta remover o antigo e instalar o atual. Para validar se a configuração Open Banking está utilizando o novo certificado entre nas Credenciais dos Parâmetros Open Banking e verifique se o campo "Status do Certificado" foi atualizado:

[[Arquivo:Open Banking Santander 0008.png|centro]]
 
[[Arquivo:Parametros Santander - Status do Certificado.png|centro]]

Para mais informações de instalação do certificado acesse a [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado? | FAQ]] sobre instalação e revisão do certificado digital.


== Assistente Open Banking - Santander ==

'''Abertura do assistente: '''Ao abrir o assistente serão apresentadas as informações necessárias para a configuração do Santander.

[[Arquivo:Open Banking Santander 0001.png|centro]]
 


'''Passo 1: '''Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um. O Santander não disponibiliza ambientes de teste, desta forma, preencha apenas os dados da guia "Produção", caso você tenha a necessidade de cadastrar alguns títulos de teste, utilize o campo “Etapa Processo do Boleto" como '''Teste'''.

<ul>

'''a. Client Id: ''' cole aqui a informação obtida no [https://developer.santander.com.br/ Portal Developers] do santander conforme o item [[#Obtenção de credenciais - Santander|Obtenção de credenciais]] deste manual;
 
'''b. Client Secret: ''' cole aqui a informação obtida no [https://developer.santander.com.br/ Portal Developers] do santander conforme o item [[#Obtenção de credenciais - Santander|Obtenção de credenciais]] deste manual;
 
'''c. Etapa Processo do Boleto: ''' Aqui é onde existe a possibilidade de realizar registros de testes no Santander, a opção “etapa processo” permite realizar registros em ambiente não produtivo conforme abaixo:
 
<ul>
01 – Produção: este é o formato oficial onde os títulos serão registrados em ambiente de produção.
 
02 – Teste: mantendo este parâmetro, os títulos serão enviados para um ambiente de testes restritos (apenas registro, sem possibilidade de alteração uma vez que o título não fica registrado, apenas é feita uma validação inicial).
</ul>

'''d. Versão da API: ''' campo preenchido automaticamente pelo CIGAM;
 
'''e. Certificado: ''' informe aqui o “subject/requerente” do certificado digital do cliente. Essa informação é obtida no campo de mesmo nome na guia “detalhes” do certificado digital conforme abaixo:
[[Arquivo:CN Certificado Bradesco.png|centro]]

'''f. Status do Certificado: ''' este campo será preenchido automaticamente com a data e hora de expiração do certificado informado no item acima. Caso não haja este preenchimento, significa que o mesmo não se encontra instalado corretamente, revise a sua instalação e tente novamente.
 
'''g. URL Webhook:''' informe o site que irá receber os retornos do Santander quanto às alterações dos títulos. Esta informação é imprescindível para o uso do retorno de liquidação via data de liquidação, sem ela, o Santander somente permite o retorno via data de vencimento ou emissão. Os requisitos para um site ser aceito como WebHook estão listados na seção [[#Requisitos para o Site a ser apontado como Webhook|Requisitos para o Site a ser apontado como Webhook]]. A sugestão é utilizar o site da sua própria empresa, porém este ainda pode não ser aceito. Para saber se o site foi aceito, deve-se checar o campo “workspace” nos parâmetros open banking do Santander após a configuração, se ele estiver preenchido, o processo teve sucesso.
 
'''h. Usuário para Alerta: ''' informe aqui o usuário que receberá os alertas de vencimento do certificado digital utilizado na parametrização. Esta informação é muito importante pois o processo de renovação junto ao SANTANDER pode levar alguns dias e não será possível registrar títulos com um certificado vencido.
 
'''i. Url Autorização: ''' campo preenchido automaticamente pelo CIGAM;
 
'''j. Url API: ''' campo preenchido automaticamente pelo CIGAM.

</ul>
[[Arquivo:Open Banking Santander 0017.png|centro]]
 


'''Passo 2: '''Este passo diz respeito à seleção de convênios, ela é uma característica do Santander e serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco é “033”.

[[Arquivo:Open Banking Santander 0003.png|centro]]
 


'''Passo 3: '''Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira DESCONTADA e ambos utilizarão a mesma instancia de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Santander 0004.png|centro]]

A opção “Direto” está detalhada no manual de funcionalidades Open Banking, já a opção PIX será detalhada mais a frente neste manual.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Passo_4_Assistente_Bradesco.png|centro]]

'''Pronto! '''Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Open Banking Santander 0006.png|centro]]

'''Atenção: Criação do Workspace Santander'''


Ao concluir a configuração dos bancos, caso as credenciais sejam validadas com sucesso, mas ocorra um erro na criação do Workspace Santander, será apresentada a mensagem:


''CGM-7827: Credenciais validadas com sucesso, porém houve erro na criação do Workspace Santander. O problema ocorre quando a URL do Web Hook é inválida nos parâmetros de Open Banking e/ou o convênio do portador de remessa difere do contratado no banco.''


Nessa situação, revise a [[#Requisitos para o Site a ser apontado como Webhook|URL Webhook]] informada nos parâmetros Open Banking e o convênio cadastrado no portador de remessa, verificando se estão de acordo com os dados contratados no banco.


Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no [http://ww2.cigam.com.br/mediawiki/index.php/GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela de parâmetros Open Banking] no manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].

[[Arquivo:Open Banking Santander 0007.png|centro]]

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco Santander, os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Nas sessões a seguir estarão descritas apenas as características específicas do '''Santander'''. Demais instruções de uso do open banking estão no manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].


'''Atenção:''' Revise se na tela de credenciais o workspace foi gerado corretamente, caso esteja em branco consulte a [[Open Banking Santander - Retorno em branco ou "Invalid client credentials" | FAQ]] sobre erro de credenciais.

[[Arquivo:Open Banking Santander 0019.png|centro]]

== Requisitos para o Site a ser apontado como Webhook ==

* URL ativa em GET e POST;
* Categorizada no site https://talosintelligence.com/;
* A URL tem que ser https, não pode ser http, por conta do mTLS;
* Ela precisa aceitar qualquer requisição em GET para cadastro.


Devem ser previstas do lado da empresa a implementação de boas práticas relacionadas as configurações da URL:
* Monitoramento da URL. Certificar-se de que esteja online, ativa e devidamente categorizada;
* Registro de URLs HTTPs;
* Liberação das portas 443 e 80;
* URL estar apta a receber POST com o body vazio (para etapa de cadastro da Workspace com Webhook);
* URL estar apta a receber POST com o CONTENT_TYPE application/json;
* Envie uma reposta HTTP adequada para o remetente do Webhook, como um código de status 200 (OK), para indicar que o recebimento foi bem-sucedido. O envio deve ser realizado imediatamente após a recepção da mensagem;
* Tratativa de notificações duplicadas.


== Ambiente de testes - Santander ==

Atualmente não é disponibilizado o ambiente de testes do Santander, para registrar títulos nesta modalidade é necessário utilizar a opção “Teste” disponível nos parâmetros open banking no campo “Etapa Processo do Boleto”, neste formato os títulos são enviados para um ambiente de testes onde é possível realizar o registro, mas não alteração e retorno de títulos.


== Registro de cobrança - Santander ==

O registro do Santander é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Santander ===

'''- Protesto e Negativação:''' O Santander possui apenas o serviço de protesto.
 

- '''Convenio:''' tenha o convênio informado corretamente conforme recebido através do e-mail do Santander, essa informação é essenciais para a correta geração do workspace. Para mais informações sobre a geração do workspace consulte a [[Open Banking Santander - Retorno em branco ou "Invalid client credentials" | FAQ]].
 

=== Impressão de QR Code no Boleto - Santander ===

Uma empresa que queira emitir QR Codes em seus boletos deve possuir credenciais com pix e seguir os itens abaixo:


* marcar a opção “PIX” dos parâmetros open banking;
* possuir a TAG qrcode_pix no seu modelo de boleto caminho para modelo padrão salvo em: ''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098 - Santander_pix.rtf''


A Chave pix será obtida no cadastro do portador de remessa:

[[Arquivo:Open Banking Santander 0014.png|centro]]

'''Observação 1:''' Necessário direito de Menu GF Configurações e configuração 3099 - GF - GE Permitir acesso aos Parâmetros PIX marcada para o usuário para acesso ao botão Parâmetros PIX.


'''Observação 2:''' Caso o tipo de chave seja "Celular" deve-se utilizar a seguinte mácara: +55DDDNUMERO. Exemplo: +5551998899776.


'''Impressão do boleto com QR Code:'''

[[Arquivo:Open Banking Santander 0012.png|centro]]

=== Particularidades de baixa - Santander ===

O Santander permite a baixa do título após 1 minuto do registro.


== Retorno de cobrança - Santander ==

A rotina de retorno do Santander funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Open Banking Santander 0015.png|centro]]
 
[[Arquivo:Open Banking Santander 0016.png|centro]]
 

'''Busca Liquidações por:'''


* '''Vencimento e/ou Data Emissão:''' habilita os filtros UN, Empresa, Lançamento, Vencimento, Data e Situação do Boleto.
**<ref group="Versão 231002.d>Liberado a partir da OS 816822/4.</ref> '''Situação do Boleto:''' Neste filtro teremos duas opções.
*** Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
*** Somente Abertos: retornará somente lançamentos registrados com situação em aberto (entrada).


* <ref group="Versão 241007.d>Liberado a partir da OS 816834/11.</ref> '''Data Liquidação:''' Este retorno funciona na modalidade “listagem” e mostrará todos os títulos encontrados no Santander com a data de liquidação informada, independente dele existir no CIGAM. Este formato de retorno somente está disponível para os clientes que possuem o serviço WEBHOOK ativo e somente retorna títulos registrados após a sua ativação, títulos anteriores à sua ativação não serão apresentados. É importante destacar que esta funcionalidade somente foi liberada na versão '''241007.d''' e que se as suas credenciais tiverem sido geradas em versões anteriores, ou seja, sem a informação da [[#Requisitos para o Site a ser apontado como Webhook|URL Webhook]], você precisará excluir as credenciais atuais e parametrizá-las novamente. [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Como_excluir_uma_parametriza%C3%A7%C3%A3o_Open_Banking Aqui] você encontra informações de como excluir e reinserir credenciais.


= Alterações de títulos registrados Via Open Banking =
== Abatimento de títulos ==

<ref group="Versão 251103">Liberado a partir da OS 816297/7.</ref>Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.

=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].

=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Abatimento de títulos|Como Fazer - Open Banking - Cancelamento de abatimento]].

= Retenção P/C/C - PIS, COFINS, CSLL =

Para quem utiliza o recurso de Controlar Retenções na Saída, ou seja, configuração [[GF - GE - 2505 - Código de imposto para controlar retenção de CSLL na saída]], e deseja registrar o lançamento financeiro no valor líquido, já descontando as retenções, é necessário:
*Parametrizar a configuração [[GF - GE - 3214 - Diminuir valor das retenções do valor total do boleto]], como '''1 - Sempre''' ou '''2 - Por Empresa''', e
*Se a configuração estiver como '''2 - Por Empresa''', deve-se marcar as empresas desejadas no campo '''Descontar Retenção no Boleto'''.

Para mais informações de como funciona esse recurso, consulte a WIKI [[OS 816297/10 – Retenções P/C/C + Boletos + CNAB e Open Banking]].

Para informações sobre o uso do Controle das Retenções na Saída, consulte [[GF - Como Fazer - Controlar Retenções de PIS-COFINS-CSSL-IRRF-INSS-ISS para Nota Fiscal de Saída]].

= CNPJ Alfanumérico =

Campo CNPJ, já é atendido no formato Alfanumérico.

= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [http://ww2.cigam.com.br/mediawiki/index.php/FAQ_GF#Open_Banking FAQs - Open Banking]
* [[Open Banking - Em qual tabela fica gravado o registro do campo "Situação Open Banking" do lançamento financeiro]]
* [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado?]]
* [[Open Banking Santander - Ao tentar registrar boletos através banco Santander via Open Banking (pela primeira vez após implementação), o banco está rejeitando boletos com o motivo de convênio não encontrado na workspace informada]]
*[[Open Banking Santander - Retorno em branco ou "Invalid client credentials"]]
*[[Open Banking - O que é Endpoint, Request e Response?]]

= Documentação Santander =

* [https://www.santander.com.br/atendimento-santander/?ic=homepf-footer-centraldeatendimento Central de Atendimento]
* [https://developer.santander.com.br/api/user-guide/emissao-de-boletos-visao-geral Portal Developer]


= Versões =
== Versão 231002 ==
<references group="Versão 231002"/>
=== Patch 'd' ===
<references group="Versão 231002.d"/>
== Versão 241007 ==
<references group="Versão 241007"/>
=== Patch 'd' ===
<references group="Versão 241007.d"/>
== Versão 251103 ==
<references group="Versão 251103"/>

GF - Como Fazer - Open Banking para Banco Santander

2026-09-15T18:42:57Z

Tais.felles: /* Assistente Open Banking - Santander */

[[categoria:Como_Fazer_Finanças]]

= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso da '''API bancária do Santander'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Santander''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =

<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e Multa
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| 240603.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 251103.BETA
|-
|}

</center>

= Open Banking Santander =

== Obtenção de credenciais - Santander ==

As credenciais do Santander são geradas através do [https://developer.santander.com.br/ Portal Developers]. Para maiores informações, entre em contato com o seu gerente de cash e siga os passos do manual [https://developer.santander.com.br/sites/default/files/2023-10/user_guide_api_de_cobranca_pt_br_v2_3_10_10_23.pdf API de Cobrança Santander] para obtenção do token.


'''IMPORTANTE:''' na seção "2.1 Portal do Desenvolvedor" no trecho ''"Na aba de criação da “Nova aplicação” temos dois tipos de aplicações. Verifique abaixo as regras de cada tipo, para decidir a qual será a opção ideal para você (Sou um desenvolvedor | Utilizo um parceiro):"'' utilize a opção '''sou um desenvolvedor''' e carregue seu proprio certificado A1 (mesmo certificado da nota fiscal).


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Instruções para troca/renovação do certificado digital - Santander ==

A renovação do certificado digital utilizado nas credenciais do Santander é composta por ações semelhantes às do primeiro credenciamento. Contate o seu gerente de Cash para maiores informações.


Refere-se ao certificado A1, o mesmo da NF. Ao gerar as credenciais, é necessário adicionar o certificado, via Portal Developers do Banco.

Para a troca do certificado no CIGAM em cenários onde o novo certificado '''manter o CN e alterar somente sua validade''' basta remover o antigo e instalar o atual. Para validar se a configuração Open Banking está utilizando o novo certificado entre nas Credenciais dos Parâmetros Open Banking e verifique se o campo "Status do Certificado" foi atualizado:

[[Arquivo:Open Banking Santander 0008.png|centro]]
 
[[Arquivo:Parametros Santander - Status do Certificado.png|centro]]

Para mais informações de instalação do certificado acesse a [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado? | FAQ]] sobre instalação e revisão do certificado digital.


== Assistente Open Banking - Santander ==

'''Abertura do assistente: '''Ao abrir o assistente serão apresentadas as informações necessárias para a configuração do Santander.

[[Arquivo:Open Banking Santander 0001.png|centro]]
 


'''Passo 1: '''Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um. O Santander não disponibiliza ambientes de teste, desta forma, preencha apenas os dados da guia "Produção", caso você tenha a necessidade de cadastrar alguns títulos de teste, utilize o campo “Etapa Processo do Boleto" como '''Teste'''.

<ul>

'''a. Client Id: ''' cole aqui a informação obtida no [https://developer.santander.com.br/ Portal Developers] do santander conforme o item [[#Obtenção de credenciais - Santander|Obtenção de credenciais]] deste manual;
 
'''b. Client Secret: ''' cole aqui a informação obtida no [https://developer.santander.com.br/ Portal Developers] do santander conforme o item [[#Obtenção de credenciais - Santander|Obtenção de credenciais]] deste manual;
 
'''c. Etapa Processo do Boleto: ''' Aqui é onde existe a possibilidade de realizar registros de testes no Santander, a opção “etapa processo” permite realizar registros em ambiente não produtivo conforme abaixo:
 
<ul>
01 – Produção: este é o formato oficial onde os títulos serão registrados em ambiente de produção.
 
02 – Teste: mantendo este parâmetro, os títulos serão enviados para um ambiente de testes restritos (apenas registro, sem possibilidade de alteração uma vez que o título não fica registrado, apenas é feita uma validação inicial).
</ul>

'''d. Versão da API: ''' campo preenchido automaticamente pelo CIGAM;
 
'''e. Certificado: ''' informe aqui o “subject/requerente” do certificado digital do cliente. Essa informação é obtida no campo de mesmo nome na guia “detalhes” do certificado digital conforme abaixo:
[[Arquivo:CN Certificado Bradesco.png|centro]]

'''f. Status do Certificado: ''' este campo será preenchido automaticamente com a data e hora de expiração do certificado informado no item acima. Caso não haja este preenchimento, significa que o mesmo não se encontra instalado corretamente, revise a sua instalação e tente novamente.
 
'''g. URL Webhook:''' informe o site que irá receber os retornos do Santander quanto às alterações dos títulos. Esta informação é imprescindível para o uso do retorno de liquidação via data de liquidação, sem ela, o Santander somente permite o retorno via data de vencimento ou emissão. Os requisitos para um site ser aceito como WebHook estão listados na seção [[#Requisitos para o Site a ser apontado como Webhook|Requisitos para o Site a ser apontado como Webhook]]. A sugestão é utilizar o site da sua própria empresa, porém este ainda pode não ser aceito. Para saber se o site foi aceito, deve-se checar o campo “workspace” nos parâmetros open banking do Santander após a configuração, se ele estiver preenchido, o processo teve sucesso.
 
'''h. Usuário para Alerta: ''' informe aqui o usuário que receberá os alertas de vencimento do certificado digital utilizado na parametrização. Esta informação é muito importante pois o processo de renovação junto ao SANTANDER pode levar alguns dias e não será possível registrar títulos com um certificado vencido.
 
'''i. Url Autorização: ''' campo preenchido automaticamente pelo CIGAM;
 
'''j. Url API: ''' campo preenchido automaticamente pelo CIGAM.

</ul>
[[Arquivo:Open Banking Santander 0017.png|centro]]
 


'''Passo 2: '''Este passo diz respeito à seleção de convênios, ela é uma característica do Santander e serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco é “033”.

[[Arquivo:Open Banking Santander 0003.png|centro]]
 


'''Passo 3: '''Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira DESCONTADA e ambos utilizarão a mesma instancia de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Santander 0004.png|centro]]

A opção “Direto” está detalhada no manual de funcionalidades Open Banking, já a opção PIX será detalhada mais a frente neste manual.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Passo_4_Assistente_Bradesco.png|centro]]

'''Pronto! '''Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Open Banking Santander 0006.png|centro]]

'''Atenção: Criação do Workspace Santander'''


Ao concluir a configuração dos bancos, caso as credenciais sejam validadas com sucesso, mas ocorra um erro na criação do Workspace Santander, será apresentada a mensagem:


''CGM-7827: Credenciais validadas com sucesso, porém houve erro na criação do Workspace Santander. O problema ocorre quando a URL do Web Hook é inválida nos parâmetros de Open Banking e/ou o convênio do portador de remessa difere do contratado no banco.''


Nessa situação, revise a URL Webhook informada nos parâmetros Open Banking e o convênio cadastrado no portador de remessa, verificando se estão de acordo com os dados contratados no banco.


Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no [http://ww2.cigam.com.br/mediawiki/index.php/GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela de parâmetros Open Banking] no manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].

[[Arquivo:Open Banking Santander 0007.png|centro]]

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco Santander, os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Nas sessões a seguir estarão descritas apenas as características específicas do '''Santander'''. Demais instruções de uso do open banking estão no manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].


'''Atenção:''' Revise se na tela de credenciais o workspace foi gerado corretamente, caso esteja em branco consulte a [[Open Banking Santander - Retorno em branco ou "Invalid client credentials" | FAQ]] sobre erro de credenciais.

[[Arquivo:Open Banking Santander 0019.png|centro]]

== Requisitos para o Site a ser apontado como Webhook ==

* URL ativa em GET e POST;
* Categorizada no site https://talosintelligence.com/;
* A URL tem que ser https, não pode ser http, por conta do mTLS;
* Ela precisa aceitar qualquer requisição em GET para cadastro.


Devem ser previstas do lado da empresa a implementação de boas práticas relacionadas as configurações da URL:
* Monitoramento da URL. Certificar-se de que esteja online, ativa e devidamente categorizada;
* Registro de URLs HTTPs;
* Liberação das portas 443 e 80;
* URL estar apta a receber POST com o body vazio (para etapa de cadastro da Workspace com Webhook);
* URL estar apta a receber POST com o CONTENT_TYPE application/json;
* Envie uma reposta HTTP adequada para o remetente do Webhook, como um código de status 200 (OK), para indicar que o recebimento foi bem-sucedido. O envio deve ser realizado imediatamente após a recepção da mensagem;
* Tratativa de notificações duplicadas.


== Ambiente de testes - Santander ==

Atualmente não é disponibilizado o ambiente de testes do Santander, para registrar títulos nesta modalidade é necessário utilizar a opção “Teste” disponível nos parâmetros open banking no campo “Etapa Processo do Boleto”, neste formato os títulos são enviados para um ambiente de testes onde é possível realizar o registro, mas não alteração e retorno de títulos.


== Registro de cobrança - Santander ==

O registro do Santander é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Santander ===

'''- Protesto e Negativação:''' O Santander possui apenas o serviço de protesto.
 

- '''Convenio:''' tenha o convênio informado corretamente conforme recebido através do e-mail do Santander, essa informação é essenciais para a correta geração do workspace. Para mais informações sobre a geração do workspace consulte a [[Open Banking Santander - Retorno em branco ou "Invalid client credentials" | FAQ]].
 

=== Impressão de QR Code no Boleto - Santander ===

Uma empresa que queira emitir QR Codes em seus boletos deve possuir credenciais com pix e seguir os itens abaixo:


* marcar a opção “PIX” dos parâmetros open banking;
* possuir a TAG qrcode_pix no seu modelo de boleto caminho para modelo padrão salvo em: ''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098 - Santander_pix.rtf''


A Chave pix será obtida no cadastro do portador de remessa:

[[Arquivo:Open Banking Santander 0014.png|centro]]

'''Observação 1:''' Necessário direito de Menu GF Configurações e configuração 3099 - GF - GE Permitir acesso aos Parâmetros PIX marcada para o usuário para acesso ao botão Parâmetros PIX.


'''Observação 2:''' Caso o tipo de chave seja "Celular" deve-se utilizar a seguinte mácara: +55DDDNUMERO. Exemplo: +5551998899776.


'''Impressão do boleto com QR Code:'''

[[Arquivo:Open Banking Santander 0012.png|centro]]

=== Particularidades de baixa - Santander ===

O Santander permite a baixa do título após 1 minuto do registro.


== Retorno de cobrança - Santander ==

A rotina de retorno do Santander funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Open Banking Santander 0015.png|centro]]
 
[[Arquivo:Open Banking Santander 0016.png|centro]]
 

'''Busca Liquidações por:'''


* '''Vencimento e/ou Data Emissão:''' habilita os filtros UN, Empresa, Lançamento, Vencimento, Data e Situação do Boleto.
**<ref group="Versão 231002.d>Liberado a partir da OS 816822/4.</ref> '''Situação do Boleto:''' Neste filtro teremos duas opções.
*** Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
*** Somente Abertos: retornará somente lançamentos registrados com situação em aberto (entrada).


* <ref group="Versão 241007.d>Liberado a partir da OS 816834/11.</ref> '''Data Liquidação:''' Este retorno funciona na modalidade “listagem” e mostrará todos os títulos encontrados no Santander com a data de liquidação informada, independente dele existir no CIGAM. Este formato de retorno somente está disponível para os clientes que possuem o serviço WEBHOOK ativo e somente retorna títulos registrados após a sua ativação, títulos anteriores à sua ativação não serão apresentados. É importante destacar que esta funcionalidade somente foi liberada na versão '''241007.d''' e que se as suas credenciais tiverem sido geradas em versões anteriores, ou seja, sem a informação da [[#Requisitos para o Site a ser apontado como Webhook|URL Webhook]], você precisará excluir as credenciais atuais e parametrizá-las novamente. [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Como_excluir_uma_parametriza%C3%A7%C3%A3o_Open_Banking Aqui] você encontra informações de como excluir e reinserir credenciais.


= Alterações de títulos registrados Via Open Banking =
== Abatimento de títulos ==

<ref group="Versão 251103">Liberado a partir da OS 816297/7.</ref>Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.

=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].

=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Abatimento de títulos|Como Fazer - Open Banking - Cancelamento de abatimento]].

= Retenção P/C/C - PIS, COFINS, CSLL =

Para quem utiliza o recurso de Controlar Retenções na Saída, ou seja, configuração [[GF - GE - 2505 - Código de imposto para controlar retenção de CSLL na saída]], e deseja registrar o lançamento financeiro no valor líquido, já descontando as retenções, é necessário:
*Parametrizar a configuração [[GF - GE - 3214 - Diminuir valor das retenções do valor total do boleto]], como '''1 - Sempre''' ou '''2 - Por Empresa''', e
*Se a configuração estiver como '''2 - Por Empresa''', deve-se marcar as empresas desejadas no campo '''Descontar Retenção no Boleto'''.

Para mais informações de como funciona esse recurso, consulte a WIKI [[OS 816297/10 – Retenções P/C/C + Boletos + CNAB e Open Banking]].

Para informações sobre o uso do Controle das Retenções na Saída, consulte [[GF - Como Fazer - Controlar Retenções de PIS-COFINS-CSSL-IRRF-INSS-ISS para Nota Fiscal de Saída]].

= CNPJ Alfanumérico =

Campo CNPJ, já é atendido no formato Alfanumérico.

= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [http://ww2.cigam.com.br/mediawiki/index.php/FAQ_GF#Open_Banking FAQs - Open Banking]
* [[Open Banking - Em qual tabela fica gravado o registro do campo "Situação Open Banking" do lançamento financeiro]]
* [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado?]]
* [[Open Banking Santander - Ao tentar registrar boletos através banco Santander via Open Banking (pela primeira vez após implementação), o banco está rejeitando boletos com o motivo de convênio não encontrado na workspace informada]]
*[[Open Banking Santander - Retorno em branco ou "Invalid client credentials"]]
*[[Open Banking - O que é Endpoint, Request e Response?]]

= Documentação Santander =

* [https://www.santander.com.br/atendimento-santander/?ic=homepf-footer-centraldeatendimento Central de Atendimento]
* [https://developer.santander.com.br/api/user-guide/emissao-de-boletos-visao-geral Portal Developer]


= Versões =
== Versão 231002 ==
<references group="Versão 231002"/>
=== Patch 'd' ===
<references group="Versão 231002.d"/>
== Versão 241007 ==
<references group="Versão 241007"/>
=== Patch 'd' ===
<references group="Versão 241007.d"/>
== Versão 251103 ==
<references group="Versão 251103"/>

GF - Como Fazer - Open Banking para Banco Santander

2026-09-15T18:02:08Z

Tais.felles: /* Assistente Open Banking - Santander */

[[categoria:Como_Fazer_Finanças]]

= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso da '''API bancária do Santander'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Santander''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =

<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e Multa
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| 240603.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 251103.BETA
|-
|}

</center>

= Open Banking Santander =

== Obtenção de credenciais - Santander ==

As credenciais do Santander são geradas através do [https://developer.santander.com.br/ Portal Developers]. Para maiores informações, entre em contato com o seu gerente de cash e siga os passos do manual [https://developer.santander.com.br/sites/default/files/2023-10/user_guide_api_de_cobranca_pt_br_v2_3_10_10_23.pdf API de Cobrança Santander] para obtenção do token.


'''IMPORTANTE:''' na seção "2.1 Portal do Desenvolvedor" no trecho ''"Na aba de criação da “Nova aplicação” temos dois tipos de aplicações. Verifique abaixo as regras de cada tipo, para decidir a qual será a opção ideal para você (Sou um desenvolvedor | Utilizo um parceiro):"'' utilize a opção '''sou um desenvolvedor''' e carregue seu proprio certificado A1 (mesmo certificado da nota fiscal).


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Instruções para troca/renovação do certificado digital - Santander ==

A renovação do certificado digital utilizado nas credenciais do Santander é composta por ações semelhantes às do primeiro credenciamento. Contate o seu gerente de Cash para maiores informações.


Refere-se ao certificado A1, o mesmo da NF. Ao gerar as credenciais, é necessário adicionar o certificado, via Portal Developers do Banco.

Para a troca do certificado no CIGAM em cenários onde o novo certificado '''manter o CN e alterar somente sua validade''' basta remover o antigo e instalar o atual. Para validar se a configuração Open Banking está utilizando o novo certificado entre nas Credenciais dos Parâmetros Open Banking e verifique se o campo "Status do Certificado" foi atualizado:

[[Arquivo:Open Banking Santander 0008.png|centro]]
 
[[Arquivo:Parametros Santander - Status do Certificado.png|centro]]

Para mais informações de instalação do certificado acesse a [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado? | FAQ]] sobre instalação e revisão do certificado digital.


== Assistente Open Banking - Santander ==

'''Abertura do assistente: '''Ao abrir o assistente serão apresentadas as informações necessárias para a configuração do Santander.

[[Arquivo:Open Banking Santander 0001.png|centro]]
 


'''Passo 1: '''Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um. O Santander não disponibiliza ambientes de teste, desta forma, preencha apenas os dados da guia "Produção", caso você tenha a necessidade de cadastrar alguns títulos de teste, utilize o campo “Etapa Processo do Boleto" como '''Teste'''.

<ul>

'''a. Client Id: ''' cole aqui a informação obtida no [https://developer.santander.com.br/ Portal Developers] do santander conforme o item [[#Obtenção de credenciais - Santander|Obtenção de credenciais]] deste manual;
 
'''b. Client Secret: ''' cole aqui a informação obtida no [https://developer.santander.com.br/ Portal Developers] do santander conforme o item [[#Obtenção de credenciais - Santander|Obtenção de credenciais]] deste manual;
 
'''c. Etapa Processo do Boleto: ''' Aqui é onde existe a possibilidade de realizar registros de testes no Santander, a opção “etapa processo” permite realizar registros em ambiente não produtivo conforme abaixo:
 
<ul>
01 – Produção: este é o formato oficial onde os títulos serão registrados em ambiente de produção.
 
02 – Teste: mantendo este parâmetro, os títulos serão enviados para um ambiente de testes restritos (apenas registro, sem possibilidade de alteração uma vez que o título não fica registrado, apenas é feita uma validação inicial).
</ul>

'''d. Versão da API: ''' campo preenchido automaticamente pelo CIGAM;
 
'''e. Certificado: ''' informe aqui o “subject/requerente” do certificado digital do cliente. Essa informação é obtida no campo de mesmo nome na guia “detalhes” do certificado digital conforme abaixo:
[[Arquivo:CN Certificado Bradesco.png|centro]]

'''f. Status do Certificado: ''' este campo será preenchido automaticamente com a data e hora de expiração do certificado informado no item acima. Caso não haja este preenchimento, significa que o mesmo não se encontra instalado corretamente, revise a sua instalação e tente novamente.
 
'''g. URL Webhook:''' informe o site que irá receber os retornos do Santander quanto às alterações dos títulos. Esta informação é imprescindível para o uso do retorno de liquidação via data de liquidação, sem ela, o Santander somente permite o retorno via data de vencimento ou emissão. Os requisitos para um site ser aceito como WebHook estão listados na seção [[#Requisitos para o Site a ser apontado como Webhook|Requisitos para o Site a ser apontado como Webhook]]. A sugestão é utilizar o site da sua própria empresa, porém este ainda pode não ser aceito. Para saber se o site foi aceito, deve-se checar o campo “workspace” nos parâmetros open banking do Santander após a configuração, se ele estiver preenchido, o processo teve sucesso.
 
'''h. Usuário para Alerta: ''' informe aqui o usuário que receberá os alertas de vencimento do certificado digital utilizado na parametrização. Esta informação é muito importante pois o processo de renovação junto ao SANTANDER pode levar alguns dias e não será possível registrar títulos com um certificado vencido.
 
'''i. Url Autorização: ''' campo preenchido automaticamente pelo CIGAM;
 
'''j. Url API: ''' campo preenchido automaticamente pelo CIGAM.

</ul>
[[Arquivo:Open Banking Santander 0017.png|centro]]
 


'''Passo 2: '''Este passo diz respeito à seleção de convênios, ela é uma característica do Santander e serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco é “033”.

[[Arquivo:Open Banking Santander 0003.png|centro]]
 


'''Passo 3: '''Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira DESCONTADA e ambos utilizarão a mesma instancia de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Santander 0004.png|centro]]

A opção “Direto” está detalhada no manual de funcionalidades Open Banking, já a opção PIX será detalhada mais a frente neste manual.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Passo_4_Assistente_Bradesco.png|centro]]

'''Pronto! '''Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Open Banking Santander 0006.png|centro]]

Atenção: Criação do Workspace Santander

Ao concluir a configuração dos bancos, caso as credenciais sejam validadas com sucesso, mas ocorra um erro na criação do Workspace Santander, será apresentada a mensagem:

CGM-7827: Credenciais validadas com sucesso, porém houve erro na criação do Workspace Santander. O problema ocorre quando a URL do Web Hook é inválida nos parâmetros de Open Banking e/ou o convênio do portador de remessa difere do contratado no banco.

Nessa situação, revise a URL Webhook informada nos parâmetros Open Banking e o convênio cadastrado no portador de remessa, verificando se estão de acordo com os dados contratados no banco.

A validação das credenciais, por si só, não garante que o Workspace tenha sido criado corretamente.


Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no [http://ww2.cigam.com.br/mediawiki/index.php/GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela de parâmetros Open Banking] no manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].

[[Arquivo:Open Banking Santander 0007.png|centro]]

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco Santander, os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Nas sessões a seguir estarão descritas apenas as características específicas do '''Santander'''. Demais instruções de uso do open banking estão no manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].


'''Atenção:''' Revise se na tela de credenciais o workspace foi gerado corretamente, caso esteja em branco consulte a [[Open Banking Santander - Retorno em branco ou "Invalid client credentials" | FAQ]] sobre erro de credenciais.

[[Arquivo:Open Banking Santander 0019.png|centro]]

== Requisitos para o Site a ser apontado como Webhook ==

* URL ativa em GET e POST;
* Categorizada no site https://talosintelligence.com/;
* A URL tem que ser https, não pode ser http, por conta do mTLS;
* Ela precisa aceitar qualquer requisição em GET para cadastro.


Devem ser previstas do lado da empresa a implementação de boas práticas relacionadas as configurações da URL:
* Monitoramento da URL. Certificar-se de que esteja online, ativa e devidamente categorizada;
* Registro de URLs HTTPs;
* Liberação das portas 443 e 80;
* URL estar apta a receber POST com o body vazio (para etapa de cadastro da Workspace com Webhook);
* URL estar apta a receber POST com o CONTENT_TYPE application/json;
* Envie uma reposta HTTP adequada para o remetente do Webhook, como um código de status 200 (OK), para indicar que o recebimento foi bem-sucedido. O envio deve ser realizado imediatamente após a recepção da mensagem;
* Tratativa de notificações duplicadas.


== Ambiente de testes - Santander ==

Atualmente não é disponibilizado o ambiente de testes do Santander, para registrar títulos nesta modalidade é necessário utilizar a opção “Teste” disponível nos parâmetros open banking no campo “Etapa Processo do Boleto”, neste formato os títulos são enviados para um ambiente de testes onde é possível realizar o registro, mas não alteração e retorno de títulos.


== Registro de cobrança - Santander ==

O registro do Santander é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Santander ===

'''- Protesto e Negativação:''' O Santander possui apenas o serviço de protesto.
 

- '''Convenio:''' tenha o convênio informado corretamente conforme recebido através do e-mail do Santander, essa informação é essenciais para a correta geração do workspace. Para mais informações sobre a geração do workspace consulte a [[Open Banking Santander - Retorno em branco ou "Invalid client credentials" | FAQ]].
 

=== Impressão de QR Code no Boleto - Santander ===

Uma empresa que queira emitir QR Codes em seus boletos deve possuir credenciais com pix e seguir os itens abaixo:


* marcar a opção “PIX” dos parâmetros open banking;
* possuir a TAG qrcode_pix no seu modelo de boleto caminho para modelo padrão salvo em: ''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098 - Santander_pix.rtf''


A Chave pix será obtida no cadastro do portador de remessa:

[[Arquivo:Open Banking Santander 0014.png|centro]]

'''Observação 1:''' Necessário direito de Menu GF Configurações e configuração 3099 - GF - GE Permitir acesso aos Parâmetros PIX marcada para o usuário para acesso ao botão Parâmetros PIX.


'''Observação 2:''' Caso o tipo de chave seja "Celular" deve-se utilizar a seguinte mácara: +55DDDNUMERO. Exemplo: +5551998899776.


'''Impressão do boleto com QR Code:'''

[[Arquivo:Open Banking Santander 0012.png|centro]]

=== Particularidades de baixa - Santander ===

O Santander permite a baixa do título após 1 minuto do registro.


== Retorno de cobrança - Santander ==

A rotina de retorno do Santander funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Open Banking Santander 0015.png|centro]]
 
[[Arquivo:Open Banking Santander 0016.png|centro]]
 

'''Busca Liquidações por:'''


* '''Vencimento e/ou Data Emissão:''' habilita os filtros UN, Empresa, Lançamento, Vencimento, Data e Situação do Boleto.
**<ref group="Versão 231002.d>Liberado a partir da OS 816822/4.</ref> '''Situação do Boleto:''' Neste filtro teremos duas opções.
*** Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
*** Somente Abertos: retornará somente lançamentos registrados com situação em aberto (entrada).


* <ref group="Versão 241007.d>Liberado a partir da OS 816834/11.</ref> '''Data Liquidação:''' Este retorno funciona na modalidade “listagem” e mostrará todos os títulos encontrados no Santander com a data de liquidação informada, independente dele existir no CIGAM. Este formato de retorno somente está disponível para os clientes que possuem o serviço WEBHOOK ativo e somente retorna títulos registrados após a sua ativação, títulos anteriores à sua ativação não serão apresentados. É importante destacar que esta funcionalidade somente foi liberada na versão '''241007.d''' e que se as suas credenciais tiverem sido geradas em versões anteriores, ou seja, sem a informação da [[#Requisitos para o Site a ser apontado como Webhook|URL Webhook]], você precisará excluir as credenciais atuais e parametrizá-las novamente. [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Como_excluir_uma_parametriza%C3%A7%C3%A3o_Open_Banking Aqui] você encontra informações de como excluir e reinserir credenciais.


= Alterações de títulos registrados Via Open Banking =
== Abatimento de títulos ==

<ref group="Versão 251103">Liberado a partir da OS 816297/7.</ref>Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.

=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].

=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Abatimento de títulos|Como Fazer - Open Banking - Cancelamento de abatimento]].

= Retenção P/C/C - PIS, COFINS, CSLL =

Para quem utiliza o recurso de Controlar Retenções na Saída, ou seja, configuração [[GF - GE - 2505 - Código de imposto para controlar retenção de CSLL na saída]], e deseja registrar o lançamento financeiro no valor líquido, já descontando as retenções, é necessário:
*Parametrizar a configuração [[GF - GE - 3214 - Diminuir valor das retenções do valor total do boleto]], como '''1 - Sempre''' ou '''2 - Por Empresa''', e
*Se a configuração estiver como '''2 - Por Empresa''', deve-se marcar as empresas desejadas no campo '''Descontar Retenção no Boleto'''.

Para mais informações de como funciona esse recurso, consulte a WIKI [[OS 816297/10 – Retenções P/C/C + Boletos + CNAB e Open Banking]].

Para informações sobre o uso do Controle das Retenções na Saída, consulte [[GF - Como Fazer - Controlar Retenções de PIS-COFINS-CSSL-IRRF-INSS-ISS para Nota Fiscal de Saída]].

= CNPJ Alfanumérico =

Campo CNPJ, já é atendido no formato Alfanumérico.

= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [http://ww2.cigam.com.br/mediawiki/index.php/FAQ_GF#Open_Banking FAQs - Open Banking]
* [[Open Banking - Em qual tabela fica gravado o registro do campo "Situação Open Banking" do lançamento financeiro]]
* [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado?]]
* [[Open Banking Santander - Ao tentar registrar boletos através banco Santander via Open Banking (pela primeira vez após implementação), o banco está rejeitando boletos com o motivo de convênio não encontrado na workspace informada]]
*[[Open Banking Santander - Retorno em branco ou "Invalid client credentials"]]
*[[Open Banking - O que é Endpoint, Request e Response?]]

= Documentação Santander =

* [https://www.santander.com.br/atendimento-santander/?ic=homepf-footer-centraldeatendimento Central de Atendimento]
* [https://developer.santander.com.br/api/user-guide/emissao-de-boletos-visao-geral Portal Developer]


= Versões =
== Versão 231002 ==
<references group="Versão 231002"/>
=== Patch 'd' ===
<references group="Versão 231002.d"/>
== Versão 241007 ==
<references group="Versão 241007"/>
=== Patch 'd' ===
<references group="Versão 241007.d"/>
== Versão 251103 ==
<references group="Versão 251103"/>

GF - Como Fazer - Open Banking para Banco Santander

2026-09-15T17:34:49Z

Tais.felles: /* Instruções para troca/renovação do certificado digital - Santander */

[[categoria:Como_Fazer_Finanças]]

= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso da '''API bancária do Santander'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Santander''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].


= APIs disponíveis e serviços atendidos pelo CIGAM =

<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e Multa
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto
|| 231002.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| 240603.b
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 251103.BETA
|-
|}

</center>

= Open Banking Santander =

== Obtenção de credenciais - Santander ==

As credenciais do Santander são geradas através do [https://developer.santander.com.br/ Portal Developers]. Para maiores informações, entre em contato com o seu gerente de cash e siga os passos do manual [https://developer.santander.com.br/sites/default/files/2023-10/user_guide_api_de_cobranca_pt_br_v2_3_10_10_23.pdf API de Cobrança Santander] para obtenção do token.


'''IMPORTANTE:''' na seção "2.1 Portal do Desenvolvedor" no trecho ''"Na aba de criação da “Nova aplicação” temos dois tipos de aplicações. Verifique abaixo as regras de cada tipo, para decidir a qual será a opção ideal para você (Sou um desenvolvedor | Utilizo um parceiro):"'' utilize a opção '''sou um desenvolvedor''' e carregue seu proprio certificado A1 (mesmo certificado da nota fiscal).


== Responsabilidades na obtenção de credenciais, escopos e certificados ==

As integrações Open Banking dependem de credenciais, escopos de acesso (scopes), certificados digitais e demais permissões disponibilizadas pela instituição financeira.

É importante destacar que essas informações fazem parte do relacionamento entre o cliente e o banco, não sendo definições ou parametrizações do ERP. Portanto, a solicitação, geração, liberação e gerenciamento desses recursos são de responsabilidade do cliente junto à instituição financeira.

Para mais detalhes, consulte a FAQ:
*[[Credenciais Open Banking]]

== Instruções para troca/renovação do certificado digital - Santander ==

A renovação do certificado digital utilizado nas credenciais do Santander é composta por ações semelhantes às do primeiro credenciamento. Contate o seu gerente de Cash para maiores informações.


Refere-se ao certificado A1, o mesmo da NF. Ao gerar as credenciais, é necessário adicionar o certificado, via Portal Developers do Banco.

Para a troca do certificado no CIGAM em cenários onde o novo certificado '''manter o CN e alterar somente sua validade''' basta remover o antigo e instalar o atual. Para validar se a configuração Open Banking está utilizando o novo certificado entre nas Credenciais dos Parâmetros Open Banking e verifique se o campo "Status do Certificado" foi atualizado:

[[Arquivo:Open Banking Santander 0008.png|centro]]
 
[[Arquivo:Parametros Santander - Status do Certificado.png|centro]]

Para mais informações de instalação do certificado acesse a [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado? | FAQ]] sobre instalação e revisão do certificado digital.


== Assistente Open Banking - Santander ==

'''Abertura do assistente: '''Ao abrir o assistente serão apresentadas as informações necessárias para a configuração do Santander.

[[Arquivo:Open Banking Santander 0001.png|centro]]
 


'''Passo 1: '''Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um. O Santander não disponibiliza ambientes de teste, desta forma, preencha apenas os dados da guia "Produção", caso você tenha a necessidade de cadastrar alguns títulos de teste, utilize o campo “Etapa Processo do Boleto" como '''Teste'''.

<ul>

'''a. Client Id: ''' cole aqui a informação obtida no [https://developer.santander.com.br/ Portal Developers] do santander conforme o item [[#Obtenção de credenciais - Santander|Obtenção de credenciais]] deste manual;
 
'''b. Client Secret: ''' cole aqui a informação obtida no [https://developer.santander.com.br/ Portal Developers] do santander conforme o item [[#Obtenção de credenciais - Santander|Obtenção de credenciais]] deste manual;
 
'''c. Etapa Processo do Boleto: ''' Aqui é onde existe a possibilidade de realizar registros de testes no Santander, a opção “etapa processo” permite realizar registros em ambiente não produtivo conforme abaixo:
 
<ul>
01 – Produção: este é o formato oficial onde os títulos serão registrados em ambiente de produção.
 
02 – Teste: mantendo este parâmetro, os títulos serão enviados para um ambiente de testes restritos (apenas registro, sem possibilidade de alteração uma vez que o título não fica registrado, apenas é feita uma validação inicial).
</ul>

'''d. Versão da API: ''' campo preenchido automaticamente pelo CIGAM;
 
'''e. Certificado: ''' informe aqui o “subject/requerente” do certificado digital do cliente. Essa informação é obtida no campo de mesmo nome na guia “detalhes” do certificado digital conforme abaixo:
[[Arquivo:CN Certificado Bradesco.png|centro]]

'''f. Status do Certificado: ''' este campo será preenchido automaticamente com a data e hora de expiração do certificado informado no item acima. Caso não haja este preenchimento, significa que o mesmo não se encontra instalado corretamente, revise a sua instalação e tente novamente.
 
'''g. URL Webhook:''' informe o site que irá receber os retornos do Santander quanto às alterações dos títulos. Esta informação é imprescindível para o uso do retorno de liquidação via data de liquidação, sem ela, o Santander somente permite o retorno via data de vencimento ou emissão. Os requisitos para um site ser aceito como WebHook estão listados na seção [[#Requisitos para o Site a ser apontado como Webhook|Requisitos para o Site a ser apontado como Webhook]]. A sugestão é utilizar o site da sua própria empresa, porém este ainda pode não ser aceito. Para saber se o site foi aceito, deve-se checar o campo “workspace” nos parâmetros open banking do Santander após a configuração, se ele estiver preenchido, o processo teve sucesso.
 
'''h. Usuário para Alerta: ''' informe aqui o usuário que receberá os alertas de vencimento do certificado digital utilizado na parametrização. Esta informação é muito importante pois o processo de renovação junto ao SANTANDER pode levar alguns dias e não será possível registrar títulos com um certificado vencido.
 
'''i. Url Autorização: ''' campo preenchido automaticamente pelo CIGAM;
 
'''j. Url API: ''' campo preenchido automaticamente pelo CIGAM.

</ul>
[[Arquivo:Open Banking Santander 0017.png|centro]]
 


'''Passo 2: '''Este passo diz respeito à seleção de convênios, ela é uma característica do Santander e serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco é “033”.

[[Arquivo:Open Banking Santander 0003.png|centro]]
 


'''Passo 3: '''Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira DESCONTADA e ambos utilizarão a mesma instancia de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Open Banking Santander 0004.png|centro]]

A opção “Direto” está detalhada no manual de funcionalidades Open Banking, já a opção PIX será detalhada mais a frente neste manual.

 


'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Passo_4_Assistente_Bradesco.png|centro]]

'''Pronto! '''Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Open Banking Santander 0006.png|centro]]

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no [http://ww2.cigam.com.br/mediawiki/index.php/GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela de parâmetros Open Banking] no manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].

[[Arquivo:Open Banking Santander 0007.png|centro]]

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco Santander, os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Nas sessões a seguir estarão descritas apenas as características específicas do '''Santander'''. Demais instruções de uso do open banking estão no manual [[GF - Como Fazer - Open Banking|Open Banking Geral]].


'''Atenção:''' Revise se na tela de credenciais o workspace foi gerado corretamente, caso esteja em branco consulte a [[Open Banking Santander - Retorno em branco ou "Invalid client credentials" | FAQ]] sobre erro de credenciais.

[[Arquivo:Open Banking Santander 0019.png|centro]]

== Requisitos para o Site a ser apontado como Webhook ==

* URL ativa em GET e POST;
* Categorizada no site https://talosintelligence.com/;
* A URL tem que ser https, não pode ser http, por conta do mTLS;
* Ela precisa aceitar qualquer requisição em GET para cadastro.


Devem ser previstas do lado da empresa a implementação de boas práticas relacionadas as configurações da URL:
* Monitoramento da URL. Certificar-se de que esteja online, ativa e devidamente categorizada;
* Registro de URLs HTTPs;
* Liberação das portas 443 e 80;
* URL estar apta a receber POST com o body vazio (para etapa de cadastro da Workspace com Webhook);
* URL estar apta a receber POST com o CONTENT_TYPE application/json;
* Envie uma reposta HTTP adequada para o remetente do Webhook, como um código de status 200 (OK), para indicar que o recebimento foi bem-sucedido. O envio deve ser realizado imediatamente após a recepção da mensagem;
* Tratativa de notificações duplicadas.


== Ambiente de testes - Santander ==

Atualmente não é disponibilizado o ambiente de testes do Santander, para registrar títulos nesta modalidade é necessário utilizar a opção “Teste” disponível nos parâmetros open banking no campo “Etapa Processo do Boleto”, neste formato os títulos são enviados para um ambiente de testes onde é possível realizar o registro, mas não alteração e retorno de títulos.


== Registro de cobrança - Santander ==

O registro do Santander é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Santander ===

'''- Protesto e Negativação:''' O Santander possui apenas o serviço de protesto.
 

- '''Convenio:''' tenha o convênio informado corretamente conforme recebido através do e-mail do Santander, essa informação é essenciais para a correta geração do workspace. Para mais informações sobre a geração do workspace consulte a [[Open Banking Santander - Retorno em branco ou "Invalid client credentials" | FAQ]].
 

=== Impressão de QR Code no Boleto - Santander ===

Uma empresa que queira emitir QR Codes em seus boletos deve possuir credenciais com pix e seguir os itens abaixo:


* marcar a opção “PIX” dos parâmetros open banking;
* possuir a TAG qrcode_pix no seu modelo de boleto caminho para modelo padrão salvo em: ''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098 - Santander_pix.rtf''


A Chave pix será obtida no cadastro do portador de remessa:

[[Arquivo:Open Banking Santander 0014.png|centro]]

'''Observação 1:''' Necessário direito de Menu GF Configurações e configuração 3099 - GF - GE Permitir acesso aos Parâmetros PIX marcada para o usuário para acesso ao botão Parâmetros PIX.


'''Observação 2:''' Caso o tipo de chave seja "Celular" deve-se utilizar a seguinte mácara: +55DDDNUMERO. Exemplo: +5551998899776.


'''Impressão do boleto com QR Code:'''

[[Arquivo:Open Banking Santander 0012.png|centro]]

=== Particularidades de baixa - Santander ===

O Santander permite a baixa do título após 1 minuto do registro.


== Retorno de cobrança - Santander ==

A rotina de retorno do Santander funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Open Banking Santander 0015.png|centro]]
 
[[Arquivo:Open Banking Santander 0016.png|centro]]
 

'''Busca Liquidações por:'''


* '''Vencimento e/ou Data Emissão:''' habilita os filtros UN, Empresa, Lançamento, Vencimento, Data e Situação do Boleto.
**<ref group="Versão 231002.d>Liberado a partir da OS 816822/4.</ref> '''Situação do Boleto:''' Neste filtro teremos duas opções.
*** Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
*** Somente Abertos: retornará somente lançamentos registrados com situação em aberto (entrada).


* <ref group="Versão 241007.d>Liberado a partir da OS 816834/11.</ref> '''Data Liquidação:''' Este retorno funciona na modalidade “listagem” e mostrará todos os títulos encontrados no Santander com a data de liquidação informada, independente dele existir no CIGAM. Este formato de retorno somente está disponível para os clientes que possuem o serviço WEBHOOK ativo e somente retorna títulos registrados após a sua ativação, títulos anteriores à sua ativação não serão apresentados. É importante destacar que esta funcionalidade somente foi liberada na versão '''241007.d''' e que se as suas credenciais tiverem sido geradas em versões anteriores, ou seja, sem a informação da [[#Requisitos para o Site a ser apontado como Webhook|URL Webhook]], você precisará excluir as credenciais atuais e parametrizá-las novamente. [https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking#Como_excluir_uma_parametriza%C3%A7%C3%A3o_Open_Banking Aqui] você encontra informações de como excluir e reinserir credenciais.


= Alterações de títulos registrados Via Open Banking =
== Abatimento de títulos ==

<ref group="Versão 251103">Liberado a partir da OS 816297/7.</ref>Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.

=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].

=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Abatimento de títulos|Como Fazer - Open Banking - Cancelamento de abatimento]].

= Retenção P/C/C - PIS, COFINS, CSLL =

Para quem utiliza o recurso de Controlar Retenções na Saída, ou seja, configuração [[GF - GE - 2505 - Código de imposto para controlar retenção de CSLL na saída]], e deseja registrar o lançamento financeiro no valor líquido, já descontando as retenções, é necessário:
*Parametrizar a configuração [[GF - GE - 3214 - Diminuir valor das retenções do valor total do boleto]], como '''1 - Sempre''' ou '''2 - Por Empresa''', e
*Se a configuração estiver como '''2 - Por Empresa''', deve-se marcar as empresas desejadas no campo '''Descontar Retenção no Boleto'''.

Para mais informações de como funciona esse recurso, consulte a WIKI [[OS 816297/10 – Retenções P/C/C + Boletos + CNAB e Open Banking]].

Para informações sobre o uso do Controle das Retenções na Saída, consulte [[GF - Como Fazer - Controlar Retenções de PIS-COFINS-CSSL-IRRF-INSS-ISS para Nota Fiscal de Saída]].

= CNPJ Alfanumérico =

Campo CNPJ, já é atendido no formato Alfanumérico.

= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [http://ww2.cigam.com.br/mediawiki/index.php/FAQ_GF#Open_Banking FAQs - Open Banking]
* [[Open Banking - Em qual tabela fica gravado o registro do campo "Situação Open Banking" do lançamento financeiro]]
* [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado?]]
* [[Open Banking Santander - Ao tentar registrar boletos através banco Santander via Open Banking (pela primeira vez após implementação), o banco está rejeitando boletos com o motivo de convênio não encontrado na workspace informada]]
*[[Open Banking Santander - Retorno em branco ou "Invalid client credentials"]]
*[[Open Banking - O que é Endpoint, Request e Response?]]

= Documentação Santander =

* [https://www.santander.com.br/atendimento-santander/?ic=homepf-footer-centraldeatendimento Central de Atendimento]
* [https://developer.santander.com.br/api/user-guide/emissao-de-boletos-visao-geral Portal Developer]


= Versões =
== Versão 231002 ==
<references group="Versão 231002"/>
=== Patch 'd' ===
<references group="Versão 231002.d"/>
== Versão 241007 ==
<references group="Versão 241007"/>
=== Patch 'd' ===
<references group="Versão 241007.d"/>
== Versão 251103 ==
<references group="Versão 251103"/>

Arquivo:Parametros Santander - Status do Certificado.png

2026-09-15T17:24:27Z

Tais.felles:

Parametros Santander - Status do Certificado

Quais bancos o CIGAM emite boleto?

2026-09-09T14:38:03Z

Tais.felles: /* Quais bancos o CIGAM emite boleto? */

[[FAQ_CIGAM]] > [[FAQ_Finanças]] > [[FAQ_GF|Gestão Financeira]] > [[Quais bancos o CIGAM emite boleto?]]
 


=Palavras-Chave=
Boletos no Cigam. Boletos gerados no Cigam. Quais boletos o Cigam gera. Quais bancos emitem boleto.

=Quais bancos o CIGAM emite boleto?=
Bancos que possuem emissão de boletos pelo CIGAM:

<center>
{| class="wikitable"
|-
! Código !! Banco
|-
|001 || Banco do Brasil
|-
|004 || Banco do Nordeste
|-
|033 || Santander
|-
|041 || Banrisul
|-
|070 || BRB - Banco de Brasilia
|-
|085 || Cecred - Ailos - Viacred
|-
|099 || Uniprime
|-
|104 || CEF
|-
|136 || Unicred
|-
|237 || Bradesco
|-
|133 || Cresol
|-
|246 || ABC
|-
|341 || Itaú
|-
|389 || Banco Mercantil do Brasil
|-
|422 || Safra
|-
|634 || Tribanco - Banco Triângulo
|-
|707 || Daycoval
|-
|743 || Semear
|-
|745 || Citybank
|-
|748 || Sicredi
|-
|756 || Sicoob - Bancoob
|-
|752 || BNP Paribas
|-
|274 || Grafeno/BMP Money Plus <ref group="Versão 241007.b"> Liberado a partir da OS 911591/1. </ref>
|-
|329 || QI <ref group="Versão 260601.c"> Liberado a partir da OS 1030118/1. </ref>
|-
|594 || ASA <ref group="Versão 260601.c"> Liberado a partir da OS 1030118/1. </ref>
|-
|208 || BTG Pactual <ref group="Versão 260601.c"> Liberado a partir da OS 1034938/1. </ref>
|}
</center>

 

=Manuais Referenciados=
*[[GF - Como Fazer - Emissão de Múltiplos Modelos de Boletos|Como Fazer - Emissão de Múltiplos Modelos de Boletos]]
*[[GF - Como Fazer - Parametrização de Envio de Boletos por e-mail|Como Fazer - Parametrização de Envio de Boletos por e-mail]]
*[[GF - Como Fazer - Envio de Boleto por e-mail com Assunto editável na rotina Emissão de Boletos Personalizados]]
*[[Envio de Boletos por E-mail: Configurações e rotinas que podem ser utilizadas]]
*[[GF - Como Fazer - Envio de Boleto por e-mail com Assunto editável na rotina Emissão de Boletos Personalizados|Como Fazer - Envio de Boleto por e-mail com Assunto editável na rotina Emissão de Boletos Personalizados]]
*[[GF - Como Fazer - Envio de Boletos com Modelo HTML]]

==Cecred, Ailos, Viacred==
*[[Origem dos dados na composição da linha digitável/IPTE do boleto do banco 085 Cecred/Ailos]]
*[[GF - Como Fazer - Boleto CECRED|Como Fazer - Boleto CECRED]]

==Sicredi==
*[[GF - Como Fazer - Boleto Sicredi|Como Fazer - Boleto Sicredi]]

==Banco do Brasil==
*[[Linha Digitável/IPTE do boleto Banco do Brasil]]

= Versões =
== Versão 241007 ==
<references group="Versão 241007"/>
=== Patch 'b' ===
<references group="Versão 241007.b"/>
== Versão 260601 ==
<references group="Versão 260601"/>
=== Patch 'c' ===
<references group="Versão 260601.c"/>

Open Banking Itaú: Orientações referente comunicado do Banco Itaú, sobre alteração de URLs, para evitar interrupções nas cobranças

2026-09-08T14:00:03Z

Tais.felles: /* Versões */

[[FAQ_CIGAM]] > [[FAQ_Finanças]] > [[FAQ_GF|Gestão Financeira]] > [[Open Banking Itaú: Orientações referente comunicado do Banco Itaú, sobre alteração de URLs, para evitar interrupções nas cobranças]]
 

=Palavras-Chave=

Open Banking. Itaú. URL. Comunicado. Evite Interrupções. API. Cobrança. Boletos.

=Comunicado Banco Itaú=

O Banco Itaú emitiu um comunicado orientando seus clientes a prepararem seus ambientes para uma mudança que ocorrerá em '''15/09/2026''', relacionada à sua cadeia de certificados digitais e aos endereços de conexão utilizados nas interações com o Itaú BBA.

Dessa forma, esta FAQ tem como objetivo '''orientar sobre as alterações que devem ser realizadas no ERP CIGAM''', especialmente em relação às '''URLs de conexão''', para acompanhar essa evolução de segurança estabelecida pelo banco e evitar possíveis interrupções nas integrações com o Itaú.

Para consultar as instruções completas emitidas pelo Banco Itaú, consulte o Portal '''Itaú for Developers''' em [https://devportal.itau.com.br/certificados-apis-expiracao-2026 Atualização de segurança e vencimento de certificados].

<center><pre>
Importante: Embora a data estipulada pelo banco seja 15/09/2026, a atualização das URLs no CIGAM já pode ser realizada antecipadamente. Recomenda-se que a alteração seja efetuada com antecedência, evitando que a atualização fique para o último momento e garantindo a continuidade das integrações com o banco.
</pre></center>

==Orientações==

A necessidade de alteração das URLs depende da versão do ERP CIGAM e da presença da OS 816822/9.

Clientes que não possuem a OS 816822/9 <ref group="Versão 260504.b"> Liberado a partir da versão 260504.b. </ref> deverão realizar a atualização das URLs manualmente na tela de Parâmetros Open Banking. Já para os clientes que possuem a OS 816822/9, as novas URLs já estarão disponíveis automaticamente como sugestão no momento da parametrização do Open Banking Itaú, não sendo necessária a alteração manual.

A seguir, são apresentadas as orientações para cada um dos cenários possíveis.

===Cliente que já possuem o Open Banking Itaú parametrizado===

Para os clientes que já possuem o Open Banking Itaú parametrizado, '''será necessário atualizar as URLs na tela de Parâmetros Open Banking'''.

Em alguns casos, também poderá ser necessária a instalação da nova cadeia de certificados digitais. Caso isso seja necessário, acione a equipe de TI responsável pelo ambiente.

===Clientes que vão parametrizar o Open Banking e não tem em sua versão, a OS 816822/9===

Para os clientes que estão realizando a implementação do Open Banking Itaú e '''não possuem a OS 816822/9''' em sua versão, '''será necessário atualizar as URLs na tela de Parâmetros Open Banking''' após a parametrização do Assistente Open Banking.

Em alguns casos, também poderá ser necessária a instalação da nova cadeia de certificados digitais. Caso isso seja necessário, acione a equipe de TI responsável pelo ambiente.

===Clientes que vão parametrizar o Open Banking e tem em sua versão, a OS 816822/9===

Para os clientes que estão realizando a implementação do Open Banking Itaú e '''possuem a OS 816822/9''' em sua versão, '''não será necessária nenhuma alteração nas URLs'''.

Nesse caso, as URLs carregadas automaticamente como sugestão na tela de Parâmetros Open Banking já estarão atualizadas de acordo com a nova configuração.

==O que Alterar e Onde Alterar==

'''1.''' Acesse o programa [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]] , através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]]. 
'''2.'''Com o programa em '''modo Modificar''', clique no botão '''Open Banking'''.
 
[[Image: ComunicadoItau1.png|450px|centro]]
 
'''3.'''Na tela '''Parâmetros Open Banking''', acesse a opção '''Credenciais'''.
 
[[Image: ComunicadoItau2.png|350px|centro]]
 
'''4.'''Localize os campos '''URL API e URL Bolecode'''.
 
[[Image: ComunicadoItau3.png|750px|centro]]
 
'''5.'''Altere as URLs conforme indicado abaixo:
{| class="wikitable"
|-
! Campo URL !! URL Atual (De) !! Nova URL (Para)
|-
| URL API|| <nowiki>https://api.itau.com.br</nowiki> || <nowiki>https://api.gateway.itau.com.br</nowiki>
|-
| URL Bolecode|| <nowiki>https://secure.api.itau</nowiki> || <nowiki>https://secure.gateway.api.itau</nowiki>
|}
'''Importante:''' altere somente os campos indicados acima, mantendo os demais parâmetros das credenciais inalterados.
 

Atenção: informe a URL exatamente como apresentada na coluna “Nova URL (Para)”, sem adicionar uma barra ( / ) ao final.

===Aos clientes que utilizam o PIX na Frente de Caixa/Gestão de Lojas===

'''1.''' Acesse o programa [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]] , através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]]. 
'''2.'''Com o programa em '''modo Modificar''', clique no botão '''Dados PIX'''.
 
[[Image: ComunicadoItau4.png|450px|centro]]
 
'''3.'''Na tela '''Parâmetros PIX''', localize o campo '''URL Producao'''.
 
[[Image: ComunicadoItau6.png|750px|centro]]
 
'''4.'''Altere a URL conforme indicado abaixo:
{| class="wikitable"
|-
! Campo URL !! URL Atual (De) !! Nova URL (Para)
|-
| URL Producao|| <nowiki>https://secure.api.itau/pix_recebimentos</nowiki> || <nowiki>https://secure.gateway.api.itau/pix_recebimentos</nowiki>
|}
'''Importante:''' altere somente os campos indicados acima, mantendo os demais parâmetros das credenciais inalterados.

= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking para Banco Itaú]]


= Versões =
== Versão 260504 ==
<references group="Versão 260504"/>
=== Patch 'b' ===
<references group="Versão 260504.b"/>

GF - Como Fazer - Open Banking para Banco Itaú

2026-09-08T13:58:55Z

Tais.felles: /* Documentos Relacionados */

[[categoria:Como_Fazer_Finanças]]

= Objetivo =

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso das APIs '''bancárias do Itaú'''.


Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações '''específicas do Itaú''' para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o Manual [http://ww2.cigam.com.br/mediawiki/index.php/GF_-_Como_Fazer_-_Open_Banking Open Banking - Geral].


= APIs disponíveis e serviços atendidos pelo CIGAM =
<center>

{| style="border-spacing:0;width:14.993cm;"
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| '''Funcionalidade'''
|| '''Versão'''
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Registro de Cobrança Simples e vinculada
|| 220404 BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Vencimento
|| 220404 BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Alteração de Juros e multa
|| 220404 BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Baixa de título
|| 220404 BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Protesto e Negativação
|| 220404 BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Retorno de Cobrança
|| 221107.a BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Demais alterações (endereço, desconto por antecipação, etc)
|| Não tratados no CIGAM
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| QR CODE no Boleto (Bolecode)
|| 221107.a BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| API de PIX avulso (QR Code dinâmico ECF Lojas)
|| 231002 BETA
|- style="border:0.5pt solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"
|| Abatimentos
|| 251103.BETA
|-
|}

</center>

= Open Banking Itaú =

== Obtenção de credenciais - Itaú (versão atual V2 + BOLECODE) ==

As credenciais do Itaú são obtidas através de um processo realizado em conjunto com a equipe de implantação e acessos ao [https://devportal.itau.com.br/baas/#/ Portal Developers] desta instituição e seguir os passos do processo de credenciamento e geração do certificado digital.


'''IMPORTANTE: '''O Itaú utiliza credenciais e certificados digitais específicos para a API de cobrança, chamada CASH MANAGEMENT (registro sem QR Code e retorno de cobrança) e para a API BOLECODE (registro de cobrança com QR Code). Desta forma, um cliente que quiser possuir registro com QR Code e retorno via API, precisará das credenciais e certificados para as duas APIs. Tratam-se de certificados próprios, não sendo possível a utilização dos certificados da NFe.


O processo de obtenção de credenciais é totalmente de responsabilidade do cliente e sua equipe de TI juntamente com o Itaú. Para aqueles que desejarem auxílio, dispomos de um parceiro homologado na empresa [https://www.certidoc.com.br/ Certidoc] onde cabe ao cliente fazer este contato.



<ul>
<pre>
O Itaú a partir de setembro de 2024 possibilita que as credenciais geradas sejam 'unificadas', no sentido de que o scope de BOLECODE passa a poder ser adicionado a credencial de CASH_MANAGEMENT. Porém, para uso dessa modalidade de 'credenciais unificadas', é necessário que identifique a versão do Cigam para saber se a versão do Cigam em uso é a 241007 e posteriores ou 240506 patch 'c' ou posteriores, que são as versões que suportam esta modalidade. Caso sua versão de Cigam seja anterior as versões mencionadas e suas credenciais forem unificadas, apenas o registro de títulos irá funcionar, o retorno acusará o erro "Não encontrado".
</pre>
</ul>


== Instruções para troca/renovação do certificado digital - Itaú ==

As instruções para renovação do certificado digital utilizado nas credenciais do Itaú estão disponíveis no [https://devportal.itau.com.br/baas/#/ Portal Developers] e são compostas por ações semelhantes às do primeiro credenciamento. Contate o seu gerente de Cash (Itaú) para maiores informações e caso tenha dificuldade em realizar o processo, a CIGAM dispõe da [http://www.certidoc.com.br Certidoc] para prestar este auxílo.


Para a troca do certificado no CIGAM (seja Bolecode ou Cash) em cenários onde o novo certificado '''manter o CN e alterar somente sua validade''' basta remover o antigo e instalar o atual. Para validar se a configuração Open Banking está utilizando o novo certificado entre nas Credenciais dos Parâmetros Open Banking e verifique se o campo "Status do Certificado" foi atualizado.

O acesso as parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o banco desejado, e em modo modificar, acesse o botão '''Open Banking''':

[[Arquivo:Renovacao do Certificado Itau.png|centro]]
 
[[Arquivo:Renovacao do Certificado Itau 2.png|centro]]

Caso o certificado tenha o '''CN alterado''' será necessário a atualização no banco e no CIGAM informar o novo '''Client Id/Client Id BOLECODE'''. Para validar a atualização verifique se o campo "Status do Certificado" foi atualizado.

[[Arquivo:Renovacao do Certificado Itau 3.png|centro]]

Para mais informações de instalação do certificado acesse a [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado? | FAQ]] sobre instalação e revisão do certificado digital.


== Assistente Open Banking - Itaú ==

O acesso as parâmetros Open Banking serão realizados através do menu [[Finanças]] > [[GF_Gestão Financeira|Gestão Financeira]] > [[GF_Parâmetros|Parâmetros]] > [[GF_Parâmetros_Configuração de Bancos|Configuração de Bancos]]. Selecione o banco desejado, e em modo modificar, acesse o botão '''Open Banking''':

Conforme explicado no tópico anterior, a tela de boas-vindas do assistente do Itaú especifica os dados referentes às credenciais para as APIs do Itaú:

[[Arquivo:Abertura do Assistente Itau.png|centro]]
 

'''Passo 1: '''Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um. O Itaú a partir a versão 2 (atual) da sua API, deixou de disponibilizar ambientes de teste, desta forma, preencha apenas os dados da guia “Produção”, caso você tenha a necessidade de cadastrar alguns títulos de teste, utilize o campo “etapa processo do boleto = validação” conforme as instruções abaixo.

[[Arquivo:Passo 1 Assistente Itau.png|centro]]

<ul>
'''a. API Cobrança:''' 02 – API cash_management ou 03 – BOLECODE. Conforme explicado acima, utilize a opção 02 para registro e retorno de cobrança sem QR Code no boleto, para esta opção são necessárias apenas as informações com sufixo “CASH”. Já para utilizar a opção 03 que possui registro de cobrança com QR Code, é necessário utilizar as credenciais com sufixo “BOLECODE” e também as de sufixo “CASH” pois a API de retorno permanece nesta segunda API.
 
'''b. Client_id Remessa/Retorno Cobrança CASH:''' id da API cash Management para registro sem QR Code e retorno de cobrança;
 
'''c. Client_secret Remessa/Retorno Cobrança CASH:''' secret da API cash Management para registro sem QR Code e retorno de cobrança;
 
'''d. Chave Itaú:''' campo desabilitado, era utilizado na V1 já descontinuada;
 
'''e. Etapa Processo do Boleto:''' Aqui é onde existe a possibilidade de realizar registros de testes no Itaú, a opção “etapa processo” permite realizar registros em ambiente não produtivo conforme abaixo:
 
<ul>
01 – Efetivação: este é o formato oficial onde os títulos serão registrados em ambiente de produção.
 
02 – Validação: mantendo este parâmetro, os títulos serão enviados para um ambiente de testes restritos (apenas registro, sem possibilidade de alteração uma vez que o título não fica registrado, apenas é feita uma validação inicial).
</ul>
'''f. Status Certificado Cobrança CASH:''' campo preenchido automaticamente pelo CIGAM ao localizar um certificado nomeado com o seu CN=Client_id da API de CASH. Exemplo:
<ul>
Client_ID Remessa/Retorno CASH: 1234567891011121314
 
Nome do Certificado: “1234567891011121314”
</ul>
'''g. Identificador (CNPJ/CPF):''' campo desabilitado, era utilizado na V1 já descontinuada;
 
'''h. Versão da API:''' campo preenchido automaticamente pelo CIGAM;
 
'''i. Client_id BOLECODE:''' id da API BOLECODE para registro de cobrança com QR Code;
 
'''j. Client_Secret BOLECODE:''' secret da API BOLECODE para registro de cobrança com QR Code;
 
'''k. Status Certificado BOLECODE:''' campo preenchido automaticamente pelo CIGAM ao localizar um certificado nomeado com o seu CN=Client_id da API BOLECODE. Exemplo:
<ul>
Client_ID BOLECODE: 1234567891011121314
 
Nome do Certificado: “1234567891011121314”
</ul>
'''l. x-apigw-api-id:''' campo desabilitado, era utilizado na V1 já descontinuada;
 
'''m. Scope:''' campo desabilitado, era utilizado na V1 já descontinuada;
 
'''n. URL Autorização:''' campo preenchido automaticamente pelo CIGAM;
 
'''o. URL API:''' campo preenchido automaticamente pelo CIGAM;
 
'''p. URL BOLECODE:''' campo preenchido automaticamente pelo CIGAM;
 
'''q. Usuário para Alerta:''' informe aqui o usuário que receberá os alertas de vencimento do certificado digital utilizado na parametrização. Esta informação é muito importante pois o processo de renovação junto ao Itaú pode levar alguns dias e não será possível registrar títulos com um certificado vencido.
</ul>

 

'''Passo 2: '''Este passo diz respeito à seleção de convênios, ela é uma característica do Itaú e serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco é “341”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

[[Arquivo:Passo 2 Assistente Itau.png|centro]]

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.

 

'''Passo 3: '''Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira VINCULADA e ambos utilizarão a mesma instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

[[Arquivo:Passo 3 Assistente Itau.png|centro]]

'''Importante:''' mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.


'''Importante 2:''' O Itaú possui as opções de envio direto e registro PIX no boleto disponíveis, esta última só está disponível caso tenha sido selecionada a opção 03 – BOLECODE no passo 1 do assistente, bem como está condicionada à existência de credenciais válidas para esta API.

 

'''Passo 4:''' o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

[[Arquivo:Passo 4 Relatorio SICOOB.png|centro]]

'''Pronto! '''Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

[[Arquivo:Assistente Conclusao Itau.png|centro]]

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no item [http://ww2.cigam.com.br/mediawiki/index.php/GF_-_Como_Fazer_-_Open_Banking#Tela_de_par%C3%A2metros_Open_Banking Tela parâmetros Open Banking] do manual Open Banking Geral.

[[Arquivo:Parametros Open Banking Itau .png|centro]]

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco Itaú, os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Nas sessões a seguir estarão descritas apenas as características específicas do '''Itaú'''. Demais instruções de uso do open banking estão no [http://ww2.cigam.com.br/mediawiki/index.php/GF_-_Como_Fazer_-_Open_Banking Manual Open Banking - Geral].


== Ambiente de testes - Itaú ==

A partir da V2 (01/01/2022) não está mais disponível o ambiente de testes do Itaú, para registrar títulos nesta modalidade é necessário utilizar a opção “validação” disponível nos parâmetros open banking (campo “etapa processo do boleto”), neste formato os títulos são enviados para um ambiente de testes onde é possível realizar o registro, mas não o retorno de títulos.

[[Arquivo:Botao Credenciais Parametros Open Banking Itau.png|centro]]

== Registro de cobrança - Itaú ==

O registro do Itaú é, de maneira geral realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.


=== Particularidades do cadastro de Portador - Itaú ===

'''- Agência e Conta:''' O portador do Itaú precisa de 12 caracteres entre Agência + Conta (completar com zeros a esquerda), do contrário, o erro abaixo será apresentado:

[[Arquivo:Erro Itau 12 Caracteres.png|centro]]
 
[[Arquivo:Cadastro de Portadores 12 Caracteres.png|centro]]
 


'''- Recebimentos divergentes da cobrança:''' Para portadores do Itaú (341) disponibilizamos o campo <ref group="Versão 231002.a"> Liberado a partir da OS 816822/2. </ref>"Aceita recebimento divergente da cobrança". Se o checkbox for marcado, a tag "codigo_tipo_autorizacao" do envio para registro no banco será enviada com o dado "01", permitindo que o título aceite recebimentos divergentes, caso contrário, a tag será enviada como "03" e o título não permitirá este tipo de recebimento.

[[Arquivo:Aceita recebimento divergente da cobranca Itau.png|centro]]
 


'''- Espécie:''' Para portadores do Itaú (341) no campo Espécie na guia CNAB do cadastro de Portadores, utilize uma das opções da coluna '''Código''' listadas abaixo a partir da documentação técnica fornecida pelo banco.

[[Arquivo:Especie itau.png|centro]]

=== Protesto e Negativação ===

'''Protesto e negativação:''' O Itaú possui os serviços de protesto e negativação e apenas um destes serviços pode ficar ativo.

Conforme Manual BoleCode via API, disponibilizado pelo Itaú, os códigos das instruções para Protesto e Negativação são:
{| class="wikitable"
|-
! Código !! Instrução
|-
| 1 || Protestar
|-
| 2|| Negativar
|-
| 4 || Não protestar
|-
| 5|| Não negativar
|-
| 7|| Não receber após o vencimento
|-
| 8|| Baixar após vencimento
|}

No mesmo manual, não está prevista instrução para envio dos dias de protesto ou negativação, como úteis ou corridos, sendo assim consulte seu gerente de cash ou o suporte de API do Banco.

Fonte: [https://www.cigam.com.br/wiki/images/a/a3/Manual_API_EmissaoBoleCode.pdf Manual BoleCode Itaú via API]

=== Impressão de QR Code no Boleto - Itaú (Bolecode) ===

Conforme já demonstrado na área de parametrização do assistente open banking do Itaú, uma empresa que queira emitir QR Codes em seus boletos deve possuir credenciais e certificado digital para a API - 03 BOLECODE. Adicionalmente, ela precisa:
* Marcar a opção “PIX” dos parâmetros open banking;
* Informar a sua chave PIX (tipo e dado) no cadastro do portador de remessa;
* Possuir a TAG qrcode_pix no seu modelo de boleto caminho para modelo padrão salvo em: ''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098 - Itau_pix.rtf''


Chave obtida no cadastro do portador de remessa:
 
Necessário direito de ''Menu GF Configurações'' e configuração ''3099 - GF - GE Permitir acesso aos Parâmetros PIX'' marcada para o usuário para acesso ao botão ''Parâmetros PIX''.

[[Arquivo:Dado Pix Portador Itau.png|centro]]

Identificação no arquivo JSON de remessa:

[[Arquivo:Dados QRCode Itau JSON.png|centro]]

Impressão do boleto com QR Code (Bolecode):

[[Arquivo:Impressao Bolecode Itau.png|centro]]

=== Particularidades de baixa - Itaú ===

O Itaú só permite a baixa de títulos após passado pelo menos um dia do registro.


'''Descrição do Erro (Banco):'''


''"Erro na validação de Campos.''
 
''Atualização não permitida na mesma data de emissão do título."''

[[Arquivo:Particularidades de baixa.png|centro]]

Observação: o registro de títulos do itaú é instantâneo, mas as alterações serão processadas somente no dia seguinte.


===Alterações de títulos registrados Via Open Banking - Alteração de Multa===

De acordo com as orientações do Portal Developers do Itaú, a tag obrigatória '''codigo_tipo_multa''', poderá ser:
*'''01''' - Quando se deseja cobrar um valor fixo de multa após o vencimento
*'''02''' - Quando se deseja cobrar um percentual do valor do título de multa após o vencimento
*'''03''' - Quando não se deseja cobrar multa caso o pagamento seja feito após o vencimento (isento)
 
[[Image: OpenItau_codigo_tipo_multa.png|750px|centro]]
 

=== Origem das tags ===
{| class="wikitable"
|-
! Tag !! Origem no Cigam
|-
| texto_seu_numero|| Número da NF + desdobramento da duplicata, do lançamento financeiro
|}

== Retorno de cobrança - Itaú ==

A rotina de retorno do Itaú funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:

[[Arquivo:Open Banking Itau 0001.png|centro]]
 
[[Arquivo:Open Banking Itau 0002.png|centro]]
 
===Guia Filtros===

====Busca Liquidações por "Detalhamento"====


'''Unidade de Negócio''': Filtro para a unidade de negócio do lançamento financeiro.

'''Empresa:''' Filtro para a empresa do lançamento financeiro.

'''Lançamento:''' Filtro para o número do lançamento financeiro.

'''Vencimento:''' Filtro para o vencimento do lançamento financeiro.

'''Data:''' Filtro para a data do lançamento financeiro. É possível executar com filtro inicial de data zerado e data final como a data que está executando a rotina.

<ref group="Versão 240506"> Liberado a partir da OS 816822/4. </ref>'''Situação do Boleto:''' Neste filtro teremos duas opções.
* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Somente Abertos: retornará somente lançamentos registrados com situação em aberto (entrada). '''Observação:''' Nessa opção também serão retornados os títulos pagos via QRCode que ainda não foram liquidados manualmente no CIGAM. Feita a liquidação, o título não será mais apresentado no relatório, somente se o filtro for alterado para "Todos".


====<ref group="Versão 251103"> Liberado a partir da OS 816822/8. </ref>Busca Liquidações por "Listagem"====

'''Data:''' Filtro para a data do título.


'''Situação do Boleto:''' Neste filtro teremos quatro opções:
* Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
* Em aberto: retornará somente lançamentos registrados com situação em aberto.
* Liquidado: retornará somente lançamentos pagos.
* Baixado: retornará somente lançamentos baixados. Observação: como o pagamento via qrcode efetua a liquidacao e baixa do boleto físico, ele será retornado tanto na baixa quanto na liquidação.


'''Pesquisa por Data:''' Neste filtro teremos cinco opções:
* Data de Entrada;
* Data de Emissão;
* Data de Vencimento;
* Data de Pagamento - esta opção será habilitada apenas quando "Situação do Boleto" estiver como "Liquidado";
* Data de Pagamento(Baixa) - esta opção será habilitada apenas quando "Situação do Boleto" estiver como "Baixado".


A opção selecionada no campo "Pesquisa por Data" determinará qual data será utilizada na busca. Por exemplo, se o usuário selecionar “Data de Vencimento” e informar 29/10/2025, o sistema irá buscar todos os títulos cuja data de vencimento seja 29/10/2025.


Lembrando que o retorno de títulos do Itaú é realizado pela API “CASH MANAGEMENT” que possui credenciais próprias, dessa forma, mesmo um cliente que use a forma de consumo 03 – BOLECODE, irá precisar de credenciais da V2 para realizar os seus retornos. Além disso, o banco não retorna os títulos pagos via QR CODE com status de liquidado quando a busca de liquidações for "Detalhamento", desta forma, a rotina de retorno neste formato apenas indica que o título foi pago via QR Code, mas não o liquida, mesmo utilizando a opção “Retorno”. Os títulos recebidos via QR Code no Itaú quando utilizada a busca de liquidações por '''Detalhamento''' devem ser liquidados manualmente dentro do CIGAM ou via retorno CNAB. Já se a busca for por '''Listagem''' então a liquidação do QRCode será automática'''.

[[Arquivo:Retorno Itau pago por QRCode.png|centro]]

= Alterações de títulos registrados Via Open Banking =
== Abatimento de títulos ==

<ref group="Versão 251103">Liberado a partir da OS 816297/7.</ref>Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.

=== Registro de Abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Registro de abatimento|Como Fazer - Open Banking - Abatimento de títulos]].

=== Cancelamento de abatimento ===

Para instruções completas de uso, consulte o manual [[GF - Como Fazer - Open Banking#Cancelamento de abatimento|Como Fazer - Open Banking - Cancelamento de abatimento]].

= Retenção P/C/C - PIS, COFINS, CSLL =

Para quem utiliza o recurso de Controlar Retenções na Saída, ou seja, configuração [[GF - GE - 2505 - Código de imposto para controlar retenção de CSLL na saída]], e deseja registrar o lançamento financeiro no valor líquido, já descontando as retenções, é necessário:
*Parametrizar a configuração [[GF - GE - 3214 - Diminuir valor das retenções do valor total do boleto]], como '''1 - Sempre''' ou '''2 - Por Empresa''', e
*Se a configuração estiver como '''2 - Por Empresa''', deve-se marcar as empresas desejadas no campo '''Descontar Retenção no Boleto'''.

Para mais informações de como funciona esse recurso, consulte a WIKI [[OS 816297/10 – Retenções P/C/C + Boletos + CNAB e Open Banking]].

Para informações sobre o uso do Controle das Retenções na Saída, consulte [[GF - Como Fazer - Controlar Retenções de PIS-COFINS-CSSL-IRRF-INSS-ISS para Nota Fiscal de Saída]].

= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking|Manual Open Banking - Geral]]
* [[FAQ_GF#Open Banking|FAQs Open Banking]]
* [[Open Banking - Em qual tabela fica gravado o registro do campo "Situação Open Banking" do lançamento financeiro]]
* [[OpenBanking - Como fazer/revisar a instalação, para que o certificado digital, apareça nas configurações de banco em Parâmetros em seguida Status do certificado?]]
* [[Open Banking Itaú - Retorno de títulos acusando erro "Não encontrado"]]
* [[Open Banking - O que é Endpoint, Request e Response?]]
* [[Open Banking Itaú: Orientações referente comunicado do Banco Itaú, sobre alteração de URLs, para evitar interrupções nas cobranças]]


= Documentação Itaú =

* [https://devportal.itau.com.br/baas/#/ Portal Developers Itaú]
* [https://www.itau.com.br/atendimento-itau/para-voce/telefones Atendimento Itaú]


= Versões =
== Versão 231002 ==
<references group="Versão 231002"/>
=== Patch 'a' ===
<references group="Versão 231002.a"/>
== Versão 240506 ==
<references group="Versão 240506"/>
== Versão 251103 ==
<references group="Versão 251103"/>

Quais bancos o CIGAM emite boleto?

2026-09-08T11:54:12Z

Tais.felles: /* Quais bancos o CIGAM emite boleto? */

[[FAQ_CIGAM]] > [[FAQ_Finanças]] > [[FAQ_GF|Gestão Financeira]] > [[Quais bancos o CIGAM emite boleto?]]
 


=Palavras-Chave=
Boletos no Cigam. Boletos gerados no Cigam. Quais boletos o Cigam gera. Quais bancos emitem boleto.

=Quais bancos o CIGAM emite boleto?=
Bancos que possuem emissão de boletos pelo CIGAM:

<center>
{| class="wikitable"
|-
! Código !! Banco
|-
|001 || Banco do Brasil
|-
|004 || Banco do Nordeste
|-
|033 || Santander
|-
|041 || Banrisul
|-
|070 || BRB - Banco de Brasilia
|-
|085 || Cecred - Ailos - Viacred
|-
|099 || Uniprime
|-
|104 || CEF
|-
|136 || Unicred
|-
|237 || Bradesco
|-
|133 || Cresol
|-
|246 || ABC
|-
|341 || Itaú
|-
|389 || Banco Mercantil do Brasil
|-
|422 || Safra
|-
|634 || Tribanco - Banco Triângulo
|-
|707 || Daycoval
|-
|743 || Semear
|-
|745 || Citybank
|-
|748 || Sicredi
|-
|756 || Sicoob - Bancoob
|-
|752 || BNP Paribas
|-
|274 || Grafeno/BMP Money Plus <ref group="Versão 241007.b"> Liberado a partir da OS 911591/1. </ref>
|-
|329 || QI <ref group="Versão 260601.c"> Liberado a partir da OS 1030118/1. </ref>
|-
|594 || ASA <ref group="Versão 260601.c"> Liberado a partir da OS 1030118/1. </ref>
|}
</center>

 

=Manuais Referenciados=
*[[GF - Como Fazer - Emissão de Múltiplos Modelos de Boletos|Como Fazer - Emissão de Múltiplos Modelos de Boletos]]
*[[GF - Como Fazer - Parametrização de Envio de Boletos por e-mail|Como Fazer - Parametrização de Envio de Boletos por e-mail]]
*[[GF - Como Fazer - Envio de Boleto por e-mail com Assunto editável na rotina Emissão de Boletos Personalizados]]
*[[Envio de Boletos por E-mail: Configurações e rotinas que podem ser utilizadas]]
*[[GF - Como Fazer - Envio de Boleto por e-mail com Assunto editável na rotina Emissão de Boletos Personalizados|Como Fazer - Envio de Boleto por e-mail com Assunto editável na rotina Emissão de Boletos Personalizados]]
*[[GF - Como Fazer - Envio de Boletos com Modelo HTML]]

==Cecred, Ailos, Viacred==
*[[Origem dos dados na composição da linha digitável/IPTE do boleto do banco 085 Cecred/Ailos]]
*[[GF - Como Fazer - Boleto CECRED|Como Fazer - Boleto CECRED]]

==Sicredi==
*[[GF - Como Fazer - Boleto Sicredi|Como Fazer - Boleto Sicredi]]

==Banco do Brasil==
*[[Linha Digitável/IPTE do boleto Banco do Brasil]]

= Versões =
== Versão 241007 ==
<references group="Versão 241007"/>
=== Patch 'b' ===
<references group="Versão 241007.b"/>
== Versão 260601 ==
<references group="Versão 260601"/>
=== Patch 'c' ===
<references group="Versão 260601.c"/>

Quais bancos o CIGAM emite boleto?

2026-09-08T11:53:12Z

Tais.felles: /* Versões */

[[FAQ_CIGAM]] > [[FAQ_Finanças]] > [[FAQ_GF|Gestão Financeira]] > [[Quais bancos o CIGAM emite boleto?]]
 


=Palavras-Chave=
Boletos no Cigam. Boletos gerados no Cigam. Quais boletos o Cigam gera. Quais bancos emitem boleto.

=Quais bancos o CIGAM emite boleto?=
Bancos que possuem emissão de boletos pelo CIGAM:

<center>
{| class="wikitable"
|-
! Código !! Banco
|-
|001 || Banco do Brasil
|-
|004 || Banco do Nordeste
|-
|033 || Santander
|-
|041 || Banrisul
|-
|070 || BRB - Banco de Brasilia
|-
|085 || Cecred - Ailos - Viacred
|-
|099 || Uniprime
|-
|104 || CEF
|-
|136 || Unicred
|-
|237 || Bradesco
|-
|133 || Cresol
|-
|246 || ABC
|-
|341 || Itaú
|-
|389 || Banco Mercantil do Brasil
|-
|422 || Safra
|-
|634 || Tribanco - Banco Triângulo
|-
|707 || Daycoval
|-
|743 || Semear
|-
|745 || Citybank
|-
|748 || Sicredi
|-
|756 || Sicoob - Bancoob
|-
|752 || BNP Paribas
|-
|274 || Grafeno/BMP Money Plus <ref group="Versão 241007.b"> Liberado a partir da OS 911591/1. </ref>
|-
|329 || QI
|-
|594 || ASA
|}
</center>

 

=Manuais Referenciados=
*[[GF - Como Fazer - Emissão de Múltiplos Modelos de Boletos|Como Fazer - Emissão de Múltiplos Modelos de Boletos]]
*[[GF - Como Fazer - Parametrização de Envio de Boletos por e-mail|Como Fazer - Parametrização de Envio de Boletos por e-mail]]
*[[GF - Como Fazer - Envio de Boleto por e-mail com Assunto editável na rotina Emissão de Boletos Personalizados]]
*[[Envio de Boletos por E-mail: Configurações e rotinas que podem ser utilizadas]]
*[[GF - Como Fazer - Envio de Boleto por e-mail com Assunto editável na rotina Emissão de Boletos Personalizados|Como Fazer - Envio de Boleto por e-mail com Assunto editável na rotina Emissão de Boletos Personalizados]]
*[[GF - Como Fazer - Envio de Boletos com Modelo HTML]]

==Cecred, Ailos, Viacred==
*[[Origem dos dados na composição da linha digitável/IPTE do boleto do banco 085 Cecred/Ailos]]
*[[GF - Como Fazer - Boleto CECRED|Como Fazer - Boleto CECRED]]

==Sicredi==
*[[GF - Como Fazer - Boleto Sicredi|Como Fazer - Boleto Sicredi]]

==Banco do Brasil==
*[[Linha Digitável/IPTE do boleto Banco do Brasil]]

= Versões =
== Versão 241007 ==
<references group="Versão 241007"/>
=== Patch 'b' ===
<references group="Versão 241007.b"/>
== Versão 260601 ==
<references group="Versão 260601"/>
=== Patch 'c' ===
<references group="Versão 260601.c"/>

Quais bancos o CIGAM emite boleto?

2026-09-08T11:51:41Z

Tais.felles: /* Quais bancos o CIGAM emite boleto? */

[[FAQ_CIGAM]] > [[FAQ_Finanças]] > [[FAQ_GF|Gestão Financeira]] > [[Quais bancos o CIGAM emite boleto?]]
 


=Palavras-Chave=
Boletos no Cigam. Boletos gerados no Cigam. Quais boletos o Cigam gera. Quais bancos emitem boleto.

=Quais bancos o CIGAM emite boleto?=
Bancos que possuem emissão de boletos pelo CIGAM:

<center>
{| class="wikitable"
|-
! Código !! Banco
|-
|001 || Banco do Brasil
|-
|004 || Banco do Nordeste
|-
|033 || Santander
|-
|041 || Banrisul
|-
|070 || BRB - Banco de Brasilia
|-
|085 || Cecred - Ailos - Viacred
|-
|099 || Uniprime
|-
|104 || CEF
|-
|136 || Unicred
|-
|237 || Bradesco
|-
|133 || Cresol
|-
|246 || ABC
|-
|341 || Itaú
|-
|389 || Banco Mercantil do Brasil
|-
|422 || Safra
|-
|634 || Tribanco - Banco Triângulo
|-
|707 || Daycoval
|-
|743 || Semear
|-
|745 || Citybank
|-
|748 || Sicredi
|-
|756 || Sicoob - Bancoob
|-
|752 || BNP Paribas
|-
|274 || Grafeno/BMP Money Plus <ref group="Versão 241007.b"> Liberado a partir da OS 911591/1. </ref>
|-
|329 || QI
|-
|594 || ASA
|}
</center>

 

=Manuais Referenciados=
*[[GF - Como Fazer - Emissão de Múltiplos Modelos de Boletos|Como Fazer - Emissão de Múltiplos Modelos de Boletos]]
*[[GF - Como Fazer - Parametrização de Envio de Boletos por e-mail|Como Fazer - Parametrização de Envio de Boletos por e-mail]]
*[[GF - Como Fazer - Envio de Boleto por e-mail com Assunto editável na rotina Emissão de Boletos Personalizados]]
*[[Envio de Boletos por E-mail: Configurações e rotinas que podem ser utilizadas]]
*[[GF - Como Fazer - Envio de Boleto por e-mail com Assunto editável na rotina Emissão de Boletos Personalizados|Como Fazer - Envio de Boleto por e-mail com Assunto editável na rotina Emissão de Boletos Personalizados]]
*[[GF - Como Fazer - Envio de Boletos com Modelo HTML]]

==Cecred, Ailos, Viacred==
*[[Origem dos dados na composição da linha digitável/IPTE do boleto do banco 085 Cecred/Ailos]]
*[[GF - Como Fazer - Boleto CECRED|Como Fazer - Boleto CECRED]]

==Sicredi==
*[[GF - Como Fazer - Boleto Sicredi|Como Fazer - Boleto Sicredi]]

==Banco do Brasil==
*[[Linha Digitável/IPTE do boleto Banco do Brasil]]

= Versões =
== Versão 241007 ==
<references group="Versão 241007"/>
=== Patch 'b' ===
<references group="Versão 241007.b"/>

Release 260504.b

2026-09-03T11:22:20Z

Tais.felles:

[[MediaWiki:Noticias_sidebar|Noticias]] > [[Versoes_produto|Versões]] > [[Release 260504.b|260504.b]]
 
<table width="100%">
<tr>
<th height="50" bgcolor="#3D4E68">RELEASE 260504.b - CIGAM 11</th>
</tr>
</table>
<table width="100%">
<tr>
<th height="50" bgcolor="#307DA2">Gestão de Armazéns</th>
</tr>
</table>
<table width="100%">
<tr>
<td>Agronegócio - Gestão de Armazéns - Movimentos - Painel de Pesagem</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1021889/2    Descrição da Alteração: Conectores: GestaoAgronegocio - Programa 98 - InformaKmHoraEncerraCarga #TPI EX_GA00098InformaKmHoraEncerraCargaTPI EX_GA00098InformaKmHoraEncerraCargaTPICab EX_GA00098InformaKmHoraEncerraCargaTPICabPrg #TPF EX_GA00098InformaKmHoraEncerraCargaTPF EX_GA00098InformaKmHoraEncerraCargaTPFCab EX_GA00098InformaKmHoraEncerraCargaTPFCabPrg</td>
</tr>
</table>

<table width="100%">
<tr>
<th height="50" bgcolor="#307DA2">Contabilidade</th>
</tr>
</table>

<table width="100%">
<tr>
<td></td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1014306/2    Descrição da Alteração: Feita alteração para que o relatório Balancete seja gerado de forma plena. O.S.: 1015849/2    Descrição da Alteração: Alterado a ECD para validar e trazer as contas contábeis das unidades de negócio filiais.O.S.: 1014260/1    Descrição da Alteração: O sistema passa a exibir a descrição "Mudança de Qualificação da Pessoa Jurídica" na opção 7 do campo 'Situação Especial' da ECF.</td>
</tr>
</table>

<table width="100%">
<tr>
<th height="50" bgcolor="#307DA2">Compras</th>
</tr>
</table>

<table width="100%">
<tr>
<td>Suprimentos - Compras</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 800325/89    Descrição da Alteração: Ralizada melhoria no Portal Aprovações, que passa a apresentar somente os registros de Solicitações de Compras, na opção 'Solicitações' do menu lateral.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Suprimentos - Compras - Movimentos - Notas Fiscais - Entradas</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1016361/3    Descrição da Alteração: Revisada a criação de 'Notas Fiscais - Entrada' por efetivação de 'Ordens de Compra' através do botão 'Ordens' da capa da NFE, para garantir que os impostos recebam a mesma data de emissão da nota gerada.O.S.: 1016612/3    Descrição da Alteração: Evoluido o validador de Chave NFe, para que também considere CNPJs alfanuméricos no momento de criação da chave.O.S.: 1025016/2    Descrição da Alteração: Revisada a replicação das Observações das 'Notas Fiscais - Entrada' para 'Notas Fiscais - Saída' quando a opção 'Gerar NF no Faturamento/Compras' está marcada no Tipo de Operação do documento. Agora a replicação será realizada ao sair da tela das observações, executando a procura com a Unidade de Negócio que está em tela.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Suprimentos - Compras - Movimentos - Solicitações de Compras</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1021074/2    Descrição da Alteração: Readequado estrutura de conector botão disponibilizado na subtask 'Selecione itens a gerar'.O.S.: 1021612/3    Descrição da Alteração: Implementado alteração para que o campo 'Custo Unitário' das Cotações de Compras e no programa 'Atualiza Controle em Lote' represente o mesmo valor que consta no zoom deste mesmo campo. Junto a isso, foi implementado uma alteração para que o resultado do cálculo visto no zoom não seja referente a divisão do custo unitário pela quantidade total.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Suprimentos - Compras - Rotinas - Operacionais - Devolução de Entradas</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1017334/2    Descrição da Alteração: Atualizada a rotina de Devolução de Entradas, para quando realizado o processo de devolução e marcada a opção “Buscar incidências e percentuais da nota de origem”, o campo "Enquadramento do IPI", seja gerado na nota de devolução conforme consta na nota de origem.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Suprimentos - Recebimento/Pré Nota - Movimentos - Pré Nota</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 953835/27    Descrição da Alteração: Visando manter a integridade do sistema, foi realizado tratamento para que sejam gravados os impostos das tabelas do Calculo Imposto 4.0, nas tabelas antigas do Prenota.O.S.: 1013076/3    Descrição da Alteração: Alinhado a tela de vinculos 'Grade Item Pré-Nota x Grade Item OC' da efetivação da 'Pré-Nota', visando mostrar o devido saldo do existente no item da OC a ser vinculado no Lote que está sendo informada em tela.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Suprimentos - Recebimento/Pré Nota - Movimentos - Gerenciamento XML NFe/CTe</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 962304/2    Descrição da Alteração: Realizada evolução na impressão do DACTE de XMLs de CTes, para que sejam consideradas as tags de ICMS ST, sendo somadas e impressas nas tags de Base ICMS, Aliquota ICMS e Valor ICMS.O.S.: 1019661/2    Descrição da Alteração: No Gerenciador XML NFe, realizada melhoria no filtro interno para que na importação de XMLs de Notas de Importação, ao gerar a Pré Nota, seja possível selecionar a Unidade de Negócio desejada, quando existir mais de uma UN com mesmo CNPJ.</td>
</tr>
</table>

<table width="100%">
<tr>
<th height="50" bgcolor="#307DA2">Escrita Fiscal</th>
</tr>
</table>

<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Parâmetros - Cálculo Impostos 4.0</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 607358/601    Descrição da Alteração: Visando manter a integridade do sistema e constante evolução, foram criados novos índices na tabela "AUXILIAR IMPOSTOS CALCULADOS" do CI 4.0, para podermos filtrar cada documento com maior eficiencia. Realizado tratamento nos scripts que utilizam a tabela "AUXILIAR IMPOSTOS CALCULADOS".</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Movimentos</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 607358/614    Descrição da Alteração: A partir dessa evolução, será possível realizar os testes do cálculo de imposto de forma automatizada. Essa alteração visa evoluir o CIGAM e tornar as entregas ainda mais rápidas e íntegras.O.S.: 607358/616    Descrição da Alteração: Visando evoluir o CIGAM para atendimento da Reforma Tributária do Consumo, foram disponibilizados os seguintes novos campos: - Percentual Efetivo ZFM - Valor Efetivo ZFM Os novos campos estão disponíveis para serem parametrizados na Regra Fiscal do Cálculo de Imposto 4.0, e se referem ao "Grupo de operações em áreas incentivadas (ALC/ZFM) - CBS (alíquota zero)", presente na Nota Técnica 2025.002-RTC - Versão 1.50. Para mais informações sobre o Cálculo de Imposto 4.0 e a Reforma Tributária do Consumo, consultar: LF - Como fazer - Reforma Tributária.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Rotinas - Legais - GIA - GIAS Federais - EFD - Contribuições</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 733543/28    Descrição da Alteração: Como parte do nosso compromisso com a qualidade e a excelência dos serviços prestados, substituímos uma variável inválida que causava divergências no processo de atualização em ambientes que utilizam o banco de dados MSSQL.O.S.: 903767/3    Descrição da Alteração: Realizado alteração no registro C170, C191 e C915 referente ao campo 'VL_DESC'. Caso a configuração de Tipo de Operação 325 esteja marcada, será considerado o valor de ICMS Outros Não Destacado.O.S.: 969670/1    Descrição da Alteração: Com o objetivo de atender à exigência que entrará em vigor a partir de julho de 2026, que permite a inclusão de caracteres alfanuméricos nos cadastros de CNPJ, as rotinas fiscais passam a considerar a identificação da matriz através do parâmetro disponível no cadastro das unidades de negócio, deixando de utilizar a validação pelo sufixo "0001" do CNPJ.O.S.: 1012007/1    Descrição da Alteração: Evoluímos a geração do registro C120 do EFD ICMS/IPI e da EFD-Contribuições para preencher o campo COD_DOC_IMP com os códigos "0" (Declaração de Importação - DI) ou "2" (Declaração Única de Importação - DUIMP), conforme a quantidade de caracteres informada no número do documento de importação da nota fiscal. Documentos com até 12 caracteres são considerados DI e documentos com mais de 12 caracteres são considerados DUIMP.O.S.: 1027853/1    Descrição da Alteração: Disponbilizada solução no EFD Contribuições quanto ao Campo 09 (CHV_NFSE) do Registro A100, para apresentar a chave de acesso com os 50 digitos da NFS-e.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Relatórios - Operacionais - Apurações - PIS/COFINS/CSLL - EFD - PIS/COFINS</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1018010/2    Descrição da Alteração: Com objetivo de manter a integridade dos valores na Apuração EFD Contribuições, ajustada validação para que caso a unidade de negócio esteja com o campo "Apropriação de Créditos regime não- cumulativo" = 2.Método de Rateio Proporcional (Receita Bruta), e não possua valor no campo "Receita Bruta Cumulativa" da aba 0111, seja apresentada mensagem de alerta.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Parâmetros - Cálculo Impostos 4.0 - Gerenciador Cálculo Imposto</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1002004/81    Descrição da Alteração: Visando manter a integridade do sistema, a tela "Informe Parte NBS/NCM" da funcionalidade "Múltiplos Relacionamentos - NCM/NBS" passa a validar a existência da Classificação Fiscal e a considerar o salvamento dos códigos informados.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Movimentos - Notas Fiscais - Saídas</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 607358/599    Descrição da Alteração: Com o objetivo de atender às novas validações e aos novos campos publicados na versão 1.40 da NT 2025.002, incluímos a nova configuração de Tipo de Operação 335 - Indicador de movimento para fim industrial para ALC/ZFM. Também adicionamos o campo 'Código Processo Suframa' nos Parâmetros do Material, na guia Compl. Fiscal.O.S.: 607358/606    Descrição da Alteração: Visando manter a integridade do sistema e constante evolução, passamos a buscar os campos "Valor Transferido", "Valor Ajuste" e "Valor Estornado" de CBS e IBS das tabelas do CI 4.0.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Comercial - Faturamento/Pedidos - Movimentos - Pedidos</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1021235/2    Descrição da Alteração: Visando manter a integridade do sistema, passamos a considerar o percentual de PIS/COFINS com 4 casas decimais na conferência de impostos do pedido e na efetivação do pedido.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Suprimentos - Compras - Movimentos - Notas Fiscais - Entradas</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1021164/2    Descrição da Alteração: Visando manter a integridade do sistema, passamos a não gravar na tabela "ENTRADA" no script que realizar a sincronização dos dados dos impostos das tabelas do CI 4.0 na NFE, para as tabelas dos impostos "antigas".</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Movimentos - Notas Fiscais - Entradas</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1015218/2    Descrição da Alteração: Visando manter a integridade do sistema, na Nota Fiscal de Entrada com a opção "Impostos Ajustados" marcada, passamos a não exibir o botão "Incluir" da tela "Conferência de Impostos" quando estiver em modo pesquisa.O.S.: 1015296/2    Descrição da Alteração: Visando manter a integridade do sistema, foi implementado o arredondamento do percentual de ICMS no Tipo de Operação quando a Incidência do ICMS estiver definida como "9 - Outras" e a Escrituração de Entrada como "3 - Outras".</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Comercial - Faturamento/Pedidos - Rotinas - Operacionais - Devolução de Saídas</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1002004/82    Descrição da Alteração: Visando manter a integridade das informações fiscais, as observações das notas de Devolução de Saída passam a constar a apresentação do código FCI.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Suprimentos - Compras - Rotinas - Operacionais - Devolução de Entradas</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1017334/3    Descrição da Alteração: Visando manter a integridade do sistema, na rotina de "Devolução de Nota fiscal de Entrada", quando marcada opção "Buscar incidências e percentuais da nota fiscal de origem", passamos a buscar o complemento de IPI da nota fiscal de entrada.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Gestão Fiscal Municipal - Movimentos - Gerenciamento NFS-e Configurável</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 601901/168    Descrição da Alteração: Visando adequar a ferramenta CIGAM as normas de validação do ambiente de NFSe Nacional que estão em constante mudança, passamos a gerar as tags tpOper e tpEnteGov. Conforme a config de TO 328 estiver com valor, será levado para a tag tpOper esse valor. E para a tpEnteGov é conforme cadastro de entidade governamental na Empresa. Para serem geradas essas tags, o layout da NFSe deve ser maior que 1.01O.S.: 1022308/2    Descrição da Alteração: Para manter sempre atualiado o CIGAM e em conformidade com as regras de validação da SEFAZ, realizadas alterações na geração do xml da NFSe ambiente nacional. Agora a tag de cObra é gerada conforme o cadastro de Obra no Endereço de Entrega e também a tag regApTribSN gera com valor '2' para casos de empresa que tem marcada a opção 'Sim com sublimite' no simples nacional.O.S.: 1028781/2    Descrição da Alteração: Com o objetivo de adequar a emissão de Notas Fiscais de Serviço destinadas ao ambiente nacional de validação, foi realizado um ajuste na geração do valor de INSS no XML.A partir desta atualização, a tag <vRetCP>, responsável por informar o valor da contribuição previdenciária retida, será gerada somente quando a incidência de INSS definida no Tipo de Operação do item da nota fiscal estiver configurada como “Retenção”. Com essa alteração, o XML passa a refletir corretamente a tributação configurada para o item, evitando o envio indevido da tag em operações nas quais não há retenção de INSS.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Rotinas - Legais - GIA - GIAS Federais - EFD - REINF</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 944882/3    Descrição da Alteração: Evoluído o sistema para que sejam levados para o R-4020 do EFD Reinf, somente lançamentos de retenção que foram liquidados no período informado.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Rotinas - Legais - GIA - GIAs Estaduais - SCANC</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 954641/2    Descrição da Alteração: Evoluímos o sistema para tratar a geração dos campos 22 - "Valor do ICMS sobre a Gasolina A" e 23 - "Valor do ICMS sobre o Etanol Anidro". Quando o item da nota fiscal, de entrada ou saída, possuir o campo "Percentual Biocombustível" informado nos parâmetros do material e o CST da nota for igual a 61, o valor do campo 23 passa a ser calculado aplicando o percentual de biocombustível sobre o valor integral do ICMS. Nessa condição, o campo 22 será gerado com o valor do ICMS integral deduzido do valor apurado para o campo 23. Caso o percentual de biocombustível não esteja informado ou seja igual a zero, a geração permanece conforme a regra atual.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Rotinas - Legais - GIA - GIAS Federais - PER/DCOMP - 09/06</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 969670/1    Descrição da Alteração: Com o objetivo de atender à exigência que entrará em vigor a partir de julho de 2026, que permite a inclusão de caracteres alfanuméricos nos cadastros de CNPJ, as rotinas fiscais passam a considerar a identificação da matriz através do parâmetro disponível no cadastro das unidades de negócio, deixando de utilizar a validação pelo sufixo "0001" do CNPJ.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Rotinas - Legais - GIA - GIAS Federais - MIT - Módulo de Inclusão de Tributos</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 969670/1    Descrição da Alteração: Com o objetivo de atender à exigência que entrará em vigor a partir de julho de 2026, que permite a inclusão de caracteres alfanuméricos nos cadastros de CNPJ, as rotinas fiscais passam a considerar a identificação da matriz através do parâmetro disponível no cadastro das unidades de negócio, deixando de utilizar a validação pelo sufixo "0001" do CNPJ.O.S.: 1004517/180    Descrição da Alteração: Com o intuito de realizar o tratamento ao buscar os dados do contabilista para o MIT, foi realizado o tratamento onde a sequência de busca procura primeiramente no 'Cadastro da Unidade de Negócio', caso não tenha um cadastro de 'Responsável' (aba Padrão) na empresa da Unidade de Negócio, então é realizada a busca dentro do 'Cadastro de Empresa' do campo 'Responsável' da Unidade de Negócio (aba Unidade de Negócio). </td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Rotinas - Legais - GIA - GIAS Federais - Sped Fiscal</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 969670/1    Descrição da Alteração: Com o objetivo de atender à exigência que entrará em vigor a partir de julho de 2026, que permite a inclusão de caracteres alfanuméricos nos cadastros de CNPJ, as rotinas fiscais passam a considerar a identificação da matriz através do parâmetro disponível no cadastro das unidades de negócio, deixando de utilizar a validação pelo sufixo "0001" do CNPJ.O.S.: 1002004/39    Descrição da Alteração: Com o objetivo de garantir a correta impressão da descrição complementar do material informada no item da NF no registro C170, quando houver registro C176 com valores de ressarcimento, o sistema passa a considerar a geração da descrição com mais de 60 caracteres.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Suprimentos - Recebimento/Pré Nota - Movimentos - Pré Nota</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 607358/598    Descrição da Alteração: Visando manter a integridade do sistema e constante evolução, na importação do XML para criação da Pre Nota, passamos a calcular os totais do documento a nível do documento e não mais a nível de item, visando melhorar performance do sistema.O.S.: 1018612/6    Descrição da Alteração: Visando manter a integridade do sistema, ao importar um XML com a opção "Calculados", gerando assim uma Prá Nota, na tela de "Conferência de Impostos" dos itens, passamos a apresentar na coluna "XML" as informações vindas dos XML da nota fiscal importada.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Relatórios - Legais - Apurações - ICMS</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1004517/197    Descrição da Alteração: Disponibilizada solução para correta apresentação dos valores de Crédito Presumido quanto a opção 'Considerar Estorno de Crédito de ICMS e Transferência para a Sub-Apuração do Crédito Presumido' na aba Apurações Complementares da Apuração de ICMS, sendo validada apenas nas movimentações de Entradas (Devoluções).</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Relatórios - Legais - Apurações - CSLL/IRPJ Lucro Presumido</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1012149/3    Descrição da Alteração: Realizado tratamento para garantir a integridade das informações na impressão do relatório quando informada alíquota de 100% nas configurações de TO 90 - "Lucro Presumido Percentual sobre a Receita Bruta IRPJ" e TO 92 - "Lucro Presumido Percentual sobre a Receita Bruta CSLL".O.S.: 1013465/1    Descrição da Alteração: Disponibilizada solução na rotina de Apuração de IRPJ e CSLL Lucro Presumido para o critério de escrituração como Competência, prevendo as devidas adequações para os valores de devoluções no demonstrativo de Apuração do IRPJ / CSLL seguindo a LC 224/25, Decreto 12.808/25 e IN 2.305/25.O.S.: 1026799/2    Descrição da Alteração: Disponibilizado solução para atender a geração da Apuração de IRPJ/CSLL quando não existe Receita Bruta, apenas Receitas Financeiras.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Relatórios - Legais - Registros - Entradas</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1018418/1    Descrição da Alteração: Realizado tratamento na impressão do Relatório de Registro de Entradas, passando a apresentar o período selecionado com datas inicial e final completas, em vez da exibição apenas de mês e ano.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Relatórios - Operacionais - Conferências - Relatório de Simples Conferência PIS/COFINS</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1004517/83    Descrição da Alteração: Com o objetivo de facilitar a identificação dos emitentes das Notas Fiscais, foi adicionado ao relatório .RTF as tags merge que informam o código e o nome fantasia da empresa e foi adicionada a opção de adicionar ao relatório Gráfico, o Código ou o Nome Fantasia do emitente da Nota</td>
</tr>
</table>

<table width="100%">
<tr>
<th height="50" bgcolor="#307DA2">Gestão Fiscal Municipal</th>
</tr>
</table>

<table width="100%">
<tr>
<td>Fiscal - Gestão Fiscal Municipal - Movimentos - Gerenciamento NFS-e Configurável</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 837071/31    Descrição da Alteração: Visando atender as necessidades da NT 008 versão 1.0 página 23, foi disponibilizado um modelo de impressão da nota fiscal de serviço contendo as marcas d'agua de ""Cancelada" e "Substituída". Essas marcas serão impressas conforme o status da nota fiscal onde, caso ela apenas esteja cancelada, será impresso a marca "Cancelada" e, caso ela esteja cancelada porém uma nova nota tenha sido criada e confirmada, a marca "Substituída" será apresentada.</td>
</tr>
</table>

<table width="100%">
<tr>
<th height="50" bgcolor="#307DA2">Faturamento/Pedidos</th>
</tr>
</table>

<table width="100%">
<tr>
<td>Comercial - Faturamento/Pedidos - Movimentos - Notas Fiscais</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 601901/175    Descrição da Alteração: Visando deixar a ferramenta CIGAM funcional, feito tratamento na geração das tags <dup> na geração do xml da nota fiscal, pois em alguns casos não estava criando corretamente um grupo por lançamento.O.S.: 799521/10    Descrição da Alteração: Existem clientes que realizam o processo de venda fora do estabelecimento, ou seja, o representante/vendedor carrega o veículo com os produtos e realiza as visitas e vendas aos clientes finais. Após esse processo, são criadas as notas de vendas referente aos produtos que foram efetivamente vendidos, devolvendo os que não foram. Neste processo de realizar a criação das notas de vendas, existe a necessidade de realizar o vínculo entre a nota de venda e sua referida nota de remessa. Esse vínculo passa a ser possível através do botão 'NF Referencia' dos itens da nota fiscal. Este botão somente estará habilitado caso a configuração de tipo de operação '332 - Referenciar notas de venda efetuada fora do estabelecimento' esteja marcada.O.S.: 1002456/2    Descrição da Alteração: Visando a melhoria contínua do Sistema CIGAM, foi implementado um tratamento para remoção de caracteres especiais na geração da tag <infCpl>, evitando possíveis rejeições por parte da SEFAZ e garantindo maior conformidade na formação do XML da NF-e.O.S.: 1013593/4    Descrição da Alteração: Visando a melhoria constante da ferramenta CIGAM, disponibilizado a geração da tag nItem do grupo DFeReferenciado para notas de devolução.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Movimentos - Notas Fiscais - Saídas</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1013593/2    Descrição da Alteração: Visando a evolução constante da ferramenta CIGAM, foram disponibilizadas as seguintes adequações para atendimento à Nota Técnica 2025.002 versão 1.40 da NF-e/NFC-e: Compras Governamentais: Inclusão de novos tipos de ente governamental disponíveis para parametrização. Disponibilização de novas opções de tipo de operação com ente governamental. Inclusão da geração da referência ao documento fiscal anterior quando aplicável. Notas de Devolução: Disponibilizado o referenciamento de documentos fiscais por item conforme exigência da Nota Técnica. Disponível através do botão <NF Referência> na tela dos itens da nota fiscal. Notas de Crédito: Inclusão dos novos tipos de Nota de Crédito: Transferência de crédito na sucessão. Retorno por recusa parcial na entrega. Indicador da Operação de Fornecimento: Disponibilizada parametrização para geração do Código Indicador da Operação de Fornecimento (cIndOp) na NF-e, conforme regras da Nota Técnica. Emitente com Inscrição SUFRAMA: Disponibilizada a geração da identificação da inscrição SUFRAMA (ISUFEmit) do emitente quando cadastrada. Estrutura do XML: Adequação da estrutura de geração do XML conforme os novos grupos definidos pela versão 1.40 da Nota Técnica. Atualização da organização dos grupos e campos exigidos para emissão da NF-e.O.S.: 1013593/5    Descrição da Alteração: Visando a evolução constante da ferramenta CIGAM, realizado a geração das tags de XML, "vIBS" e "vCBS" do grupo gTransfCred.O.S.: 1024256/3    Descrição da Alteração: Visando a evolução constante da ferramenta CIGAM, realizado tratamento para as tags "vDevTrib" de CBS/IBS para não gerar obrigatoriamente quando for CST 200, 210 e 515.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Comercial - COMEX Exportação - Movimentos - Pedidos</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 910483/2    Descrição da Alteração: Visando a melhoria constante da ferramenta, retirado a tratativa que fazia com que o sistema sempre arredondasse o valor da quantidade convertida.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Comercial - Faturamento/Pedidos - Movimentos - Pedidos</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1020521/2    Descrição da Alteração: Com o objetivo de aprimorar os processos de criação de demandas e ordens de compra durante a inclusão de itens em pedidos, foi implementada uma nova validação no programa responsável pela geração das grades e dos registros de demanda. A melhoria é aplicada aos materiais controlados por lote/grade e tem como finalidade garantir maior consistência na geração das informações. A partir desta atualização, não será mais gerado o registro de Ordem de Compra quando for identificada uma divergência, seja forçada ou ocasional, entre as quantidades registradas na grade e itens do pedido durante a modificação do pedido.</td>
</tr>
</table>

<table width="100%">
<tr>
<th height="50" bgcolor="#307DA2">Gestão de Frotas</th>
</tr>
</table>

<table width="100%">
<tr>
<td>Serviços - Gestão de Frotas - Movimentos - Abastecimento - Abastecimento saída</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1020517/2    Descrição da Alteração: Considerando a possibilidade de modificar um abastecimento que possui odometro ou horimetro inferior ao informado no veículo, o sistema passa a considerar esse histórico exibindo-o através do boão 'Histórico' no cadastro do veículo.</td>
</tr>
</table>

<table width="100%">
<tr>
<th height="50" bgcolor="#307DA2">Genéricos</th>
</tr>
</table>

<table width="100%">
<tr>
<td></td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 584093/218    Descrição da Alteração: Disponibilizado novo dashboard 'Comodatos x Vendas', desenvolvido com base nas informações da fonte de dados 'FA - Vendas - GR', permitindo o acompanhamento e controle das operações relacionadas a comodatos em comparação com as vendas realizadas. Para garantir o correto funcionamento e a efetividade das análises, foram implementadas parametrizações específicas, incluindo a criação da operação de resultado “COMODATO” e a definição nos filtros do dashboard de um grupo de materiais dedicado para demonstração dos itens relacionados.O.S.: 947038/2    Descrição da Alteração: Com o objetivo de compatibilizar as fontes de dados de Centro de Custo e Conta Contábil com as configurações do CIGAM, passou-se a considerar as parametrizações de Tipo Contábil (80021, 80024, 80027, 80030, 80033, 80036, 80039, 80042 e 80045) e Grupo Contábil (80022, 80025, 80028, 80031, 80034, 80037, 80040, 80043 e 80046). Essa alteração amplia a flexibilidade na utilização das contas contábeis, permitindo contemplar estruturas que não seguem um padrão específico de nomenclatura ou classificação.O.S.: 970021/182    Descrição da Alteração: Com o objetivo de proporcionar maior flexibilidade na análise das informações e facilitar a construção de dashboards mais aderentes às necessidades dos usuários, o sistema passa a disponibilizar a opção de 'tipo filtro múltipla seleção' na edição do Filtro Dimensão na Web.O.S.: 1006809/46    Descrição da Alteração: A visualização dos dashboards foi aprimorada para aplicar as configurações de borda e separadores na versão web, além de ampliar as opções de personalização disponíveis no modo edição.O.S.: 1006809/54    Descrição da Alteração: Com o objetivo de proporcionar uma experiência visual mais consistente nos dashboards da web, o sistema passa a padronizar o tamanho dos tiles independentemente da forma de visualização utilizada. Dessa forma, as informações são apresentadas de maneira mais uniforme, favorecendo a organização e a leitura dos dados.O.S.: 1006809/60    Descrição da Alteração: Ajustado o layout e usabilidade da criação de métrica com filtro comparativo na versão web do CIGAM BI.O.S.: 1006809/74    Descrição da Alteração: Otimizada a abertura do dashboard e da tela de seleção de registros do filtro de dimensão quando ele possui muitos registros.O.S.: 1006809/75    Descrição da Alteração: Melhorada a atualização dos filtros de dimensão quando eles recebem publicação de outros filtros no CIGAM BI web.O.S.: 1006809/80    Descrição da Alteração: Ajustado a exibição do loader quando o item recebe publicação, para mostrar que uma ação está em execução.O.S.: 1006809/85    Descrição da Alteração: Ajustada a versão do CIGAM BI para 26.08.O.S.: 1006809/94    Descrição da Alteração: Corrigido a duplicação de borda do item selecionado quando ele tem espaçamento interno.O.S.: 1006809/124    Descrição da Alteração: Ajustada a versão do CIGAM BI para 26.08.21.O.S.: 1006809/126    Descrição da Alteração: Com o objetivo de proporcionar maior agilidade e consistência na gestão dos itens favoritos, o sistema passa a atualizar automaticamente a lista de favoritos após a remoção de um item na versão Web do CIGAM BI.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Utilidades/Diversos - Genéricos</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 607358/622    Descrição da Alteração: Tratado para que as importação de formulas não exclua as regras personalizadas.O.S.: 1001972/41    Descrição da Alteração: Implementado para que a verificação dos acessos de usuário seja controlado no componente de licenciamento.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Finanças - Gestão Financeira</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1014662/2    Descrição da Alteração: Realizado ajuste no processo de consulta das informações utilizadas no resumo de comissões da Nota Fiscal, garantindo sua correta exibição.</td>
</tr>
</table>
<table width="100%">
<tr>
<td></td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1006054/2    Descrição da Alteração: Alterado o relatório "*Extrato de Contas" para que exiba o saldo anterior quando a configuração 80218 estiver marcada.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Movimentos - Notas Fiscais - Saídas</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1020177/2    Descrição da Alteração: Visando melhoria do Sistema CIGAM, foi implementada a validação para garantir que a tag <indIntermed/> gere somente nos casos em que a tag <indPres/> tenha os valores 2, 3, 4 ou 9 informados.O.S.: 1024256/4    Descrição da Alteração: Visando a evolução constante da ferramenta CIGAM, tirado a obrigatoriedade da tag vDevTrib para CBS e IBS do CST 510.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Comercial - Faturamento/Pedidos - Parâmetros - Séries</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 837071/33    Descrição da Alteração: Com o objetivo de aprimorar o sistema CIGAM, foi implementado um novo campo para o cadastro da Série utilizada na impressão da NFSe Nacional. Essa melhoria atende aos casos em que o provedor aceita apenas valores numéricos para a identificação da série.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Finanças - Gestão Financeira - Rotinas - Operacionais - Liberar para Contabilidade</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1015894/2    Descrição da Alteração: Foi alterada a rotina "Liberar para Contabilidade" para, após a contabilização, liberar os lotes criados tanto no processo manual quanto no automatizado.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Gestão Fiscal Municipal - Movimentos - Gerenciamento NFS-e Configurável</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 996417/7    Descrição da Alteração: Visando aprimorar a ferramenta CIGAM e entregar sempre um produto mais completo para nossos clientes, criamos mais uma opção no envio de notas fiscais de serviço nacional (NFS-e Nacional). Essa opção é um checkbox nas configurações de NFS-e, no Gerenciamento NFS-e Configurável. ' Não gerar tag de Inscrição Municipal - NFSe Nacional - #17' - quando estiver marcada essa opção a tag de xml prest.IM não será gerada.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Finanças - Conciliação de Cartões - Movimentos - Exibe dados de Conciliação - API Conciliadora</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 923239/253    Descrição da Alteração: Foi realizada uma melhoria na rotina de conciliação de cartões para contemplar corretamente os lançamentos de antecipação. A partir deste ajuste, a conciliação passa a considerar as informações de antecipação e a data prevista de pagamento na identificação dos lançamentos, permitindo que registros antecipados sejam apresentados corretamente, mesmo quando as parcelas possuem vencimentos em datas futuras.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Rotinas - Legais - GIA - GIAS Federais - Sped Fiscal</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 879911/2    Descrição da Alteração: Implementado tratamento na geração do EFD ICMS/IPI e da Apuração do ICMS para que as Notas Fiscais Complementares de Importação, quando possuírem somente valor de ICMS Tributado informado, sejam escrituradas com todos os campos relacionados ao ICMS zerados.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Fiscal - Escrita Fiscal - Relatórios - Legais - Apurações - ICMS</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 879911/2    Descrição da Alteração: Implementado tratamento na geração do EFD ICMS/IPI e da Apuração do ICMS para que as Notas Fiscais Complementares de Importação, quando possuírem somente valor de ICMS Tributado informado, sejam escrituradas com todos os campos relacionados ao ICMS zerados.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Suprimentos - Gestão de Materiais - Rotinas - Operacionais - Valorizar Estoque - Painel do Valoriza Estoque</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1017342/3    Descrição da Alteração: Realizada alteração na rotina "Gerar Tempos Operacionais" para que na leitura de Movimentos de Produção de Defeito ou Perdido estes sejam considerados somente se possuírem Entrada, para que a Valorização de Estoque tenha onde distribuir os Custos Operacionais. Essa alteração é para garantir a total distribuição dos Custos Operacionais quando há OP com Movimentos de Produção de Defeito ou Perdido que não possuem movimentação, nos casos onde foi utilizado um Tipo de Operação com Espécie de Estoque Nula.</td>
</tr>
</table>

<table width="100%">
<tr>
<th height="50" bgcolor="#307DA2">Gestão Financeira</th>
</tr>
</table>

<table width="100%">
<tr>
<td>Finanças - Gestão Financeira</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 944882/5    Descrição da Alteração: Adicionada a opção "1ª Liquidação" na configuração "GF GE 3277 - Atualizar datas das retenções em liquidações parciais" para atualizar as datas da retenção apenas na primeira liquidação parcial realizada para o lançamento.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Finanças - Gestão Financeira - Relatórios - Legais - Posição em Aberto de Empresas</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1013088/2    Descrição da Alteração: Feita alteração para que o relatório "Posição em aberto de empresas" seja gerado de forma plena.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Finanças - Gestão Financeira - Relatórios - Operacionais - Liquidados - Efetivos</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 942120/43    Descrição da Alteração: Implementadas com a reforma tributária brasileira, as novas Notas Fiscais de Débito e Crédito servem, respectivamente, para formalizar acréscimos ou reduções nos impostos devidos (IBS e CBS) decorrentes de ajustes posteriores na operação. Com o relatório Efetivos estruturado na visão de Notas de Débito e Crédito disponibilizado no ERP Cigam, você apura com precisão os lançamentos financeiros com demandas tributárias necessárias, para que assim, de posse das informações, possam ser geradas as ações para garantir a conformidade inicial da sua empresa em relação à este contexto legal.O.S.: 942120/46    Descrição da Alteração: Alterada a nomenclatura das colunas de "Valor Indexado" para apenas "Valor", para melhor entendimento. Importante, não se trata de alteração de tag's, nem mesmo no relatório de Efetivos e nem mesmo no modelo merge, é apenas alteração do texto fixo dos modelos merges.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Finanças - Gestão Financeira - Rotinas - Operacionais - Liberar para Contabilidade</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1024485/2    Descrição da Alteração: A rotina 'Liberar para Contabilidade' passa a executar de forma plena, sem apresentar a mensagem 'ORA-01400'.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Finanças - Conciliação de Cartões - Movimentos - Exibe dados de Conciliação - API Conciliadora</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1018612/13    Descrição da Alteração: Visando manter a integridade com as evoluções do módulo de Conciliação de Cartões, realizou-se a alteração na chamada ao objeto de banco de dados responsável pela padronização de textos de motivos, observações e outros advindos da integração com a API da Conciliadora.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Finanças - Gestão Financeira - Rotinas - EDI - Transmite - Remessa Pagamentos Bancários - Sicoob</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1017971/2    Descrição da Alteração: Ajustado o CNAB de pagamento do Sicoob para que gere o "Dígito Verificador da Conta" (posição 42 do Segmento A) como "0" quando o DV da conta no cadastro de conta corrente da empresa estiver em branco, a alteração é válida a partir da versão "3.4 - Pix".O.S.: 1018612/17    Descrição da Alteração: Foi ajustada a geração do arquivo de remessa de pagamentos do Sicoob para corrigir o preenchimento do DV da conta na coluna 42 do segmento A.O tratamento do campo foi revisado para considerar corretamente o dígito da conta conforme a versão do layout utilizada. Quando o DV não estiver informado, o campo passa a ser preenchido com zero a partir da versão 3.4 - PIX.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Finanças - Gestão Financeira - Rotinas - Operacionais - Conciliações Bancárias - Conciliação de Extrato Automatizada 2.0</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 997321/56    Descrição da Alteração: Realizado ajuste na rotina de Conciliação de Extrato Automatizada para adequar o tratamento dos lançamentos vinculados e das variações cambiais no processo de conciliação, garantindo a correta composição dos valores apresentados.</td>
</tr>
</table>


<table width="100%">
<tr>
<td>Finanças - Gestão Financeira - Rotinas - Operacionais - Open Banking</td>
</tr>

<tr>
<td height="20" align="justify">O.S.: 816822/9    Descrição da Alteração: Adequação da integração Itaú devido à atualização da infraestrutura de APIs do banco. Foram atualizadas as URLs impactadas conforme orientação oficial do Itaú, visando garantir a continuidade da comunicação após a expiração dos endereços atuais. A alteração contempla os novos endpoints disponibilizados pelo banco, mantendo as demais configurações da integração inalteradas.</td>
</tr>
</table>

<table width="100%">
<tr>
<th height="50" bgcolor="#307DA2">Gestão de Lojas</th>
</tr>
</table>

<table width="100%">
<tr>
<td>Comercial - Gestão de Lojas - Rotinas - Operacionais - Conferência Itens OC</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1015952/2    Descrição da Alteração: Para garantir a integridade das informações no sistema, foi implementada uma camada de segurança para que, durante a geração da Nota Fiscal de Entrada pela rotina de Conferência de Itens OC do Módulo de Lojas (Comercial -> Gestão de Lojas -> Rotinas -> Operacionais -> Conferência Itens OC), o Código NFE seja sempre obtido da respectiva Nota Fiscal de Saída e replicado corretamente na Nota Fiscal de Entrada. </td>
</tr>
</table>

<table width="100%">
<tr>
<th height="50" bgcolor="#307DA2">Gestão de Materiais</th>
</tr>
</table>

<table width="100%">
<tr>
<td>Suprimentos - Gestão de Materiais - Movimentos - Estoque</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1012793/2    Descrição da Alteração: Realizada melhoria sobre o programa de movimentos de estoque (CG00343), de forma que o valor do preço unitário sugerido com base no preço médio apresente todas as casas decimais de forma equivalente ao estoque e grade do material utilizado.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Suprimentos - Gestão de Materiais - Parâmetros - Regras de preços</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 952451/3    Descrição da Alteração: Feita alteração no sistema para evoluir a tela de Conferência do Custo do Item na nota de entrada para atender a Reforma Tributária.O.S.: 1018612/11    Descrição da Alteração: Feita alteração no sistema para que a tela de Conferência do Custo e as Regras de Preço sejam exibidas conforme o esperado.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Suprimentos - Gestão de Materiais - Movimentos - Notas de Entrada - Compras</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1018612/16    Descrição da Alteração: Feita alteração no sistema para tratar a NF de Referência no Movimento de Estoque de Entrada ao abrir a nova tela de Conferência do Custo.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Suprimentos - Gestão de Materiais - Rotinas - Operacionais - Valorizar Estoque - Painel do Valoriza Estoque</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1013175/2    Descrição da Alteração: Realizadas alterações na Valorização de Estoque para garantir de forma plena a ordenação dos Movimentos que serão valorizados, a fim de que as Entradas de Produção (OP) recebem os Custos de todos os Insumos movimentados.</td>
</tr>
</table>

<table width="100%">
<tr>
<th height="50" bgcolor="#307DA2">Gestão de Serviços</th>
</tr>
</table>

<table width="100%">
<tr>
<td>Serviços - Gestão de Serviços</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1020744/3    Descrição da Alteração: Visando o uso do Orçamento pela Ordem de Serviço foi tratada a criação de novas versão considerando Materiais com situação como 'Baixado', mantendo ou excluindo os correlatos de movimentos vinculados a este conforme escolha do usuário.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Serviços - Gestão de Serviços - Movimentos - Ordem de Serviço</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 961321/58    Descrição da Alteração: Considerando a possibilidade de criar Ordem de Serviço a partir do Pedido que contenha materiais que controlam número de série, passou a ser gravado o número de série selecionado na tabela de Complemento de Item da OS possibilitando consulta em diferentes pequisas.O.S.: 1009001/3    Descrição da Alteração: Com o objetivo de melhorar o desempenho, foi realizada uma revisão do processo de abertura da tela de Materiais da OS, visando sua otimização.O.S.: 1009001/4    Descrição da Alteração: Com o objetivo de melhorar o desempenho, foi realizada uma revisão do processo de abertura dos registro na tela de Ordens de Serviço, visando sua otimização.O.S.: 1030228/1    Descrição da Alteração: Considerando a nova opção para criação de Remessa de Materiais e Recursos da OS sendo o tipo como 'Demais Remessas' em que os campos disponíveis no grupo 'Dados transferência' não são exibidos, passado a não disparar mensagens de validações sobre esses campos.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Serviços - Gestão de Serviços - Parâmetros - Produtos</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1013819/2    Descrição da Alteração: Considerando a possibilidade de criação automática de produto na venda foi ajustado para os dados do Cliente e Unidade de Negócio do Produto sem espaços.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Serviços - Gestão de Serviços - Rotinas - Operacionais - Gerar faturamento de OS</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1020744/2    Descrição da Alteração: Visando garantir a integridade do faturamento dos serviços realizados em Ordens de Serviço, foi implementada uma validação na geração da Nota de Serviço. A partir desta melhoria, os itens de serviço não serão incluídos na nota quando a quantidade informada for igual a 0 (zero) ou quando o desconto aplicado for de 100%, evitando cobranças indevidas e assegurando maior consistência no processo de faturamento.</td>
</tr>
</table>

<table width="100%">
<tr>
<th height="50" bgcolor="#307DA2">Multiendereçamentos</th>
</tr>
</table>

<table width="100%">
<tr>
<td></td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 923482/96    Descrição da Alteração: Realizada alteração no Portal ERP para que, ao utilizar o recurso de Multiendereçamento, a bipagem com confirmação de quantidades na lista de materiais gere apenas uma movimentação por bipagem, considerando a quantidade informada pelo usuário.O.S.: 1016580/2    Descrição da Alteração: Alterada a Lista de Materiais do Multiendereçamento do Portal ERP para considerar a validade do lote na apuração da disponibilidade de materiais com controle por lote.</td>
</tr>
</table>

<table width="100%">
<tr>
<th height="50" bgcolor="#307DA2">Controle Patrimonial</th>
</tr>
</table>

<table width="100%">
<tr>
<td></td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1013038/2    Descrição da Alteração: Feita alteração no sistema para que o relatório Razão Auxiliar Coluna seja gerado de forma plena.</td>
</tr>
</table>

<table width="100%">
<tr>
<th height="50" bgcolor="#307DA2">Programação e Controle de Produção</th>
</tr>
</table>

<table width="100%">
<tr>
<td>Manufatura - Programação e Controle de Produção - Movimentos - Ordens de Desmontagem</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1024385/2    Descrição da Alteração: Na rotina Ordem de desmontagem foi implementada funcionalidade para permitir cadastrar mesmo entrando em modo pesquisar e posteriormente mudando para modo criar.</td>
</tr>
</table>
<table width="100%">
<tr>
<td>Manufatura - Programação e Controle de Produção - Movimentos - Leitor de movimentos de produção</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1019811/2    Descrição da Alteração: Implementada revisão das condições de geração de movimentos de produção no leitor de movimentos de produção do portal indústria com objetivo de aproximar a versão do leitor desktop.</td>
</tr>
</table>
<table width="100%">
<tr>
<td></td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1026411/2    Descrição da Alteração: No 'Leitor de Produção', equalizado o comportamento dos botões 'Concluir' e 'Próximo' entre dispositivos móveis e desktop, considerando a existência de demandas para o talão antes do encerramento da leitura. Realizada validação após a confirmação do aviso de preenchimento do 'Questionário', impedindo o acesso à etapa de 'Edição de Demandas' quando o talão não possuir demandas pendentes.</td>
</tr>
</table>

<table width="100%">
<tr>
<th height="50" bgcolor="#307DA2">Gestão de Projetos</th>
</tr>
</table>

<table width="100%">
<tr>
<td>BPM - Gestão de Projetos - Movimentos - Projeto Estruturado</td>
</tr>
</table>

<table width="100%">
<tr>
<td height="20" align="justify">O.S.: 1025934/2    Descrição da Alteração: Otimização realizada para garantir a correta cópia da estrutura das etapas do projeto modelo ao criar um novo projeto a partir dele ou ao vinculá-lo a um projeto existente.</td>
</tr>
</table>

GF - Como Fazer - Open Banking

2026-08-27T19:41:28Z

Tais.felles: /* Protesto e Negativação */

[[categoria:Como_Fazer_Finanças]]

= Objetivo =


O open banking CIGAM é um projeto que visa implementar as APIs bancárias (interfaces online de comunicação) nos módulos financeiros do ERP CIGAM. O maior benefício obtido com estas integrações é a eliminação do uso de arquivos CNAB (*.txt) e a migração para uma conexão direta com o banco. Assim o usuário passa a fazer tudo dentro do CIGAM sem precisar entrar no gerenciador financeiro do banco.


Com base em estatísticas colhidas com nossos clientes, após a implementação do open banking CIGAM é possível reduzir cerca de 5 a 8 horas semanais de envolvimento com os gerenciadores bancários! Isso é mais tempo para o que realmente importa!


O presente manual visa apresentar o escopo completo do projeto Open Banking para tudo aquilo que é comum a todos os bancos. Para as dicas e orientações de instituições específicas, acesse o manual de cada banco.


==Introdução ao Open Banking==
<center><youtube>=Kdz-eqPaJj4&list=PLzmuT6ANAEw8F2yYpYiWH8lvJaL0cDmng&index=6</youtube></center> 

= APIs atendidas por instituição =

No quadro abaixo são apresentadas as instituições participantes do escopo do open banking e os serviços disponibilizados pelas mesmas bem como se este serviço já está sendo atendido no CIGAM.


[[Arquivo:Open Banking Geral 00011.png|centro]]
'''*''' Ainda não disponível no CIGAM

= Migrando um cliente do CNAB para a API Open Banking =

A migração para o Open Banking de um cliente que hoje está utilizando CNAB deve ocorrer de forma transparente, o que está mudando é a forma de registro e não o registro em si. '''Pense no CNAB como um envio via carta, e o Open Banking como um e-mail, a mensagem chegará de ambas as formas, porém na primeira você precisa levar a mensagem escrita à mão até o correio, já a segunda você digita e envia de casa.'''


Essa troca de formato possibilita que quando um cliente tiver o seu CIGAM configurado no open banking ele poderá imediatamente realizar o retorno via API e irá obter as informações dos títulos registrados na instituição independentemente da forma de registro previamente utilizada. Inclusive, o método de registro via CNAB continua valendo simultaneamente ao uso da API. Desta forma, embora alguns bancos disponibilizem ambientes de homologação, não recomendamos a criação de movimentos de teste nestes uma vez que existem restrições de CPF/CNPJ exclusivos para teste.


= Configurando APIs Open Banking para clientes novos em período de implementação =

Para clientes novos (em projeto), que não tem como registrar títulos oficiais no CIGAM, recomendamos avaliar a sessão “testes em homologação” nos manuais de cada banco para verificar as parametrizações necessárias.


= Obtenção de credenciais - Instruções Gerais =


A comunicação entre o CIGAM e as APIs Open Banking é iniciada através da validação de credenciais entre as duas partes. Estas credenciais podem variar de códigos de identificação como Client_ID e Client_Secret até o uso conjunto de certificados digitais, de forma semelhante à comunicação entre CIGAM e SEFAZ da Nota Fiscal Eletrônica (NFe).


Invariavelmente, para obter as suas credenciais, você deverá acessar primeiro o seu Gerente Cash ou gerente de conta PJ na instituição em que está buscando as credenciais. Em muitos casos, ele irá abrir um chamado técnico junto à área responsável para iniciar o seu processo de credenciamento seja através de um portal ou e-mail.


<ul>'''NOTA AOS SETORES DE ATENDIMENTO E IMPLEMENTAÇÃO CIGAM: '''é imprescindível ter os dados de credenciais, certificados digitais, scopes etc. em mãos, a primeira página do assistente open banking irá indicar as informações necessárias para cada banco. Recomendamos que o trabalho de implementação/atendimento só seja iniciado após a confirmação da existência de tais dados, uma vez que não está dentro das nossas possibilidades obter tais informações.</ul>


== Uso e Gestão dos certificados digitais nas credenciais Open Banking ==

Itens como “Client_ID” e “Client_secret” tem validade indeterminada e não sofrem alteração a não ser a pedido do próprio cliente. Porém um item que vêm sendo bastante difundido e incorporado ao grupo de credenciais para utilização das APIs Open Banking é o '''CERTIFICADO DIGITAL,''' no CIGAM será sempre utilizado o certificado com extensão *.pfx (contendo chave privada) com CN (common name) formado pela sua Razão Social + CNPJ. A grande maioria dos nossos clientes já possui um certificado com estas características sendo utilizado para a assinatura dos arquivos legais (SPED e EFD) e das NFes (Notas Eletrônicas) de modo que deve ser este o certificado a ser utilizado também no Open Banking.


O common name (CN) é obtido dentro da aba detalhes no item “Subject/Requerente” do certificado digital e o dado utilizado pelo CIGAM nos parâmetros de credenciais do Open Banking é sempre o que está após o texto “CN = “, ou seja, apenas a razão social + CNPJ conforme a imagem abaixo:

[[Image:Subject Certificado.png|center]]

'''IMPORTANTE:''' O cliente deve estar atento '''ao período de expiração''' (data de validade) do certificado instalado e compartilhado (chave pública) com a instituição financeira. Um certificado vencido irá implicar diretamente na comunicação com as APIs até que seja realizada a substituição por um certificado válido. O processo de substituição dos certificados irá variar conforme o banco e pode ser revisado neste manual no item correspondente a cada instituição. O CIGAM também possui a função de criar alertas a partir da versão 221107 que irá alertar o usuário indicado no assistente open banking ou a qualquer usuário que utilizar as rotinas open banking durante o período de 30 dias que anteceder o vencimento do certificado.


== Instruções para troca/renovação do certificado digital ==

As instruções para renovação do certificado digital utilizado nas credenciais dos bancos membros do projeto Open Banking variam de uma instituição para a outra para maiores instruções de como proceder, acesse o manual Open Banking de cada banco. Lembre-se de que sempre é possível contatar o seu gerente de Cash (gerente de contas do banco) para maiores informações e caso tenha dificuldade em realizar o processo, a CIGAM dispõe da [http://www.certidoc.com.br Certidoc] para prestar este auxílio.


= Configurando o Open Banking (informações gerais) =

Apesar de cada banco possuir o seu jeito de ser parametrizado, o processo de configuração do Open Banking CIGAM se dá através de apenas dois cadastros, sendo: cadastro de configuração de Bancos, onde todas as informações de credenciais e gerais daquela instituição serão concentradas; e o cadastro de portador, onde serão apontadas as informações referentes a cada uma das contas correntes de cada instituição.


'''IMPORTANTE:''' Recomendamos que antes de realizar a parametrização de bancos para o open banking CIGAM você revise todos os portadores que serão utilizados no processo, eles precisam existir e estarem prontos para serem utilizados.


== Configuração do portador ==

O cadastro do Portador, como no processo CNAB tem o objetivo de apontar os dados de cobrança/pagamento para uma Conta Corrente. De forma geral, todos os dados já informados funcionam da mesma maneira no Open Banking.

[[Image:Cadastro de Portador 221107.png|center]]

Dados como carteira e variação permanecem no mesmo formato uma vez que estas são informações de domínio do banco. Outro ponto de alerta é que para o Open Banking a opção “Processar retornos pelo número do boleto” deve estar marcada. (a rotina já realiza esta marcação, mas é importante verificar em caso de dúvidas).


Além disso, deve ser observado o campo Espécie do cadastro de Portadores, onde deverá ter o valor informado de acordo com as opções disponíveis listadas na Cigam Wiki no tópico de Open Banking de cada banco na seção '''Particularidades do cadastro de Portador''' ou através da documentação técnica atualizada fornecida por cada instituição bancária.

[[Image:Especie portador.png|center]]

Caso tenha sido realizada movimentação com esta opção desmarcada, não será possível realizar baixas, pois o sistema não consegue localizar títulos devido a não haver '''Nosso Número''' gravado nas tabelas envolvidas.


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


* Identificar o '''Nosso Número''' do registro a ser baixado (Lançamento Financeiro);
* 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.


Outro ponto importante a considerar é o campo “auditoria” do portador, no open banking é mandatório que ele esteja configurado como “'''Detalhada'''” para que o log de auditoria seja registrado.

[[Image:Auditoria Detalhada Portador Open Banking.png|center]]

Além disso, a configuração '''348 - Sincronismo lançamento''' precisa estar diferente de “Nenhum”.

[[Image:Configuracao 348 Ambos 221107.png|center]]


'''IMPORTANTE:''' Tanto no Banco do Brasil quanto nos demais bancos parametrizados no Open Banking, sugerimos a remoção dos ZEROS à esquerda nos campos de identificação do Portador (Agência, Conta, Convênio e Cedente), embora haja tratamentos no CIGAM, em alguns casos esse é o motivo de erros de comunicação, principalmente na rotina de retorno do Open Banking. Nestes pontos é comum acontecer erro de comunicação, falha de assinatura e derivados.



'''IMPORTANTE 2:''' o CIGAM atualmente não utiliza comandos de remessa no Open Banking.


== Protesto e Negativação ==

Os comandos “Protestar” e “Negativar” no Open Banking CIGAM são parametrizadas no cadastro do portador através do combo box abaixo:

[[Arquivo:Protestar e Negativar redimensionado.png|centro]]

É possível selecionar apenas uma das opções (negativar ou protestar) e no campo ao lado é possível informar a quantidade de dias a ser utilizado como regra para o comando.


Além da parametrização do portador, é possível definir o tratamento de protesto e negativação individualmente para cada cliente através do campo <ref group="Versão 260601.b"> Liberado a partir da OS 858471/13. </ref>“Negativar/Protestar”, disponível na guia Geral do cadastro de Empresas/Pessoas.


O campo possui as seguintes opções:


* Cfe. Portador: o título seguirá a parametrização de protesto ou negativação definida no cadastro do portador.
* Dispensar: o título não será enviado para protesto ou negativação, independentemente da parametrização definida no portador.


Dessa forma, é possível utilizar a mesma parametrização de portador para diferentes clientes, permitindo que alguns sigam a regra definida no portador e outros sejam dispensados do procedimento.


'''IMPORTANTE:''' O CIGAM apenas envia a instrução de protesto/negativação no momento do registro do título. Os serviços de inclusão posterior, bem como a remoção do comando, se necessárias, precisam ser realizadas no gerenciador bancário.


'''IMPORTANTE 2:''' Podem existir regras de protesto e negativação específicas variando por banco, consulte a WIKI específica de cada um (na tabela de serviços disponíveis) para maiores informações.


== Configuração de bancos ==

No programa configuração de bancos, existe um tooltip que aponta quais os bancos estão disponíveis na sua versão do CIGAM:

[[Image:Tooltip Configuracao de Bancos.png|center]]


É no programa de configuração de bancos, dentro do botão “Open Banking” que serão informados os dados de credenciais, ambientes e serviços que serão utilizados via API para aquela instituição.


'''No primeiro acesso ao botão open banking, será chamado o assistente de configurações''' onde o usuário será acompanhado passo a passo no preenchimento das informações necessárias.


== Tela de parâmetros Open Banking ==

Caso você já possua uma parametrização open banking para o banco que você está entrando, a tela de parâmetros será aberta, aqui será possível visualizar os dados atuais parametrizados para o banco. Abaixo seguem as informações gerais de cada área da tela de parâmetros Open banking.

[[Image:Parametros Open Banking 221107_v2.png|center]]

=== [[Image:Icon Credenciais.png|top]] Botão “Credenciais” ===

A tela de credenciais apresentada poderá ter entre uma e duas abas. Conforme o banco, poderá existir uma aba para cada ambiente entre homologação e produção com credenciais distintas. Mas também existem bancos apenas com ambiente de produção, sem possibilidade de testes em ambiente de homologação; e ainda, aqueles que utilizam as mesmas credenciais para ambos, homologação e produção tendo o apontamento do ambiente como um combo em tela.

[[Image:Parametros Botao Credenciais.png|centro]]

Aqui são visualizadas todas as informações relacionadas às credenciais open banking do banco que se está pesquisando. As informações contidas aqui variam de acordo com a instituição e normalmente contém as credenciais (Client_secret e Client_ID), certificado digital (quando aplicável), versão da API que está sendo utilizada e dados de escopo (que são os serviços atendidos por aquelas credenciais).


As informações mais sensíveis estão protegidas por '''criptografia''' (representada pelo cadeado azul à direita) e não possuem nenhuma possibilidade de visualização. A partir do momento em que as informações são inseridas, o CIGAM as criptografa tanto em ambiente runtime quanto no banco de dados. A única forma de validar se as credenciais estão iguais às que você possui fora do CIGAM é através do botão [[Image:Icon Cadeado.png|top]], onde você pode reinseri-las e clicar em “validar”, caso estejam de acordo com os dados previamente gravados, será emitida uma mensagem confirmando.


[[Image:Criptografia Botao Credenciais.png|centro]]

[[Arquivo:Validacao Token Parametros v2.png|centro]]


Caso você queira utilizar um novo dado, basta inseri-lo e clicar em “confirmar”, o CIGAM irá checar novamente se é isso que você deseja fazer e substituir o dado antigo pelo novo.

[[Image:Alterar dado criptografado.png|centro]]

Ainda é possível remover uma credencial previamente informada através do botão “Excluir”:

[[Arquivo:Excluir dado criptografado.png|centro]]

=== Usuário de Alerta (alerta de vencimento de certificado digital) ===

Algumas instituições utilizam certificados digitais na composição e validação das credenciais das suas APIs open banking. Estes certificados por sua vez são vinculados às credenciais, desta forma, quando do seu vencimento, a sua substituição precisa ser realizada tanto no sistema interno do cliente quanto na instituição financeira. Ao utilizar o campo “usuário para alerta”, o CIGAM irá gerar uma mensagem para o usuário informado para alertá-lo a partir de 30 dias faltantes para o seu vencimento.


[[Arquivo:Parametros Open Banking Usuario Alerta.png|centro]]

[[Arquivo:Alerta Certificado.png|centro]]


'''OBS:''' caso nenhum usuário seja informado no momento da parametrização, será criado um alerta para qualquer usuário que utilizar uma funcionalidade open banking no período que anteceder 30 dias do vencimento do certificado.


=== [[Image:Icon_Enderecos.png|top]] Botão “Endereços” ===

Neste botão estão localizados os endereços de comunicação com as APIs bancárias do CIGAM para cada banco. Elas são geridas pela equipe de desenvolvimento CIGAM e não possuem possibilidade de alteração pelo usuário comum.

'''IMPORTANTE:''' Alguns bancos não fazem mais uso destas URL's, estando elas informadas diretamente nas informações de credenciamento nas parametrizações do Open Banking. Os bancos que ainda fazem uso das URL's do botão Endereços são os Banco do Brasil e Bradesco, que não possuem dados de URL's nas suas parametrizações.

[[Arquivo:Dados Endereco OB.png|centro]]

=== Abas Cobrança e Pagamento ===

Atualmente possuímos as abas Cobrança e Pagamento para configuração dos portadores destas APIs em separado, porém ainda não possuímos a função pagamento, desta forma ela ainda não está em uso e todas as informações contidas nesta sessão são relativas ao serviço de Cobrança. Inclusive a aba Pagamento foi removida a partir da versão 221107 e será novamente adicionada quando a funcionalidade for desenvolvida.


=== Grupo Convênios e Portadores ===

O grupo “convênios” pode ter N registros conforme o cliente os possuir, é comum que haja um convenio de cobrança e um convenio de pagamento em um cliente, porém pode ocorrer de haver mais de um convenio para um mesmo serviço de cobrança, por exemplo. O conteúdo do convenio é determinado durante a parametrização (no assistente do open banking) onde o usuário pode escolher apontar um convenio (localizado pelo CIGAM dentro do universo de portadores do banco que se está configurando), ou “pular” esta etapa. Se selecionado, será criada uma linha com aquele convenio selecionado, caso pulado, será criada uma linha com a informação “Geral”.

[[Arquivo:Convenios de Cobranca Pular.png|centro]]

Neste exemplo, foi localizado o convenio 946278214 dentre os portadores cadastrados para o banco SICREDI (746). Caso o usuário clique em “avançar”, os parâmetros Open Banking serão criados em uma linha com este convenio, caso seja selecionado o botão “pular”, a parametrização será criada como “Geral”.


Sempre que o Banco não especificar um convênio, sugerimos que esta etapa seja pulada para que as credenciais sejam criadas como “Geral”.

[[Arquivo:Parametros Open Banking Geral.png|centro]]

O grupo “Portadores” está amarrado ao grupo “Convênios”, ou seja, pode existir mais de uma linha de portadores para um mesmo convênio, essa situação é gerada quando o cliente possui mais de uma conta corrente que realiza cobranças.

[[Arquivo:Multiplos Portadores Parametros Open Banking.png|centro]]

No campo “Portador” está indicado o portador de registro a ser utilizado no registro dos boletos deste convenio, já o campo “Portador de Retorno” será trazido como sugestão de portador de liquidação na rotina de retorno open banking para os bancos que possuírem este serviço.


Aqui também existem alguns parâmetros relacionados ao comportamento do CIGAM como: “Direto” para que o registro seja feito diretamente na impressão do boleto; e “PIX” que irá indicar que os títulos registrados devem também registrar uma operação PIX e imprimi-la no boleto (atualmente disponível apenas no Banco do Brasil, Itaú e SICOOB). Já o campo “U.N. Ced” funciona como Empresa cedente na API de cobrança do Itaú. Maiores detalhes podem ser encontrados no manual Open Banking de cada banco.


=== Botão “Validar” ===

O botão validar permite consistir as credenciais atualmente informadas no convenio em que se está posicionado:

[[Arquivo:Botao Validar Parametros Geral.png|centro]]

Esta consulta, além de apresentar o resultado da tentativa de conexão em cada ambiente e nos serviços disponíveis para cada banco, também retorna o seu escopo de serviços das credenciais informadas. As informações apresentadas variam por banco.

[[Arquivo:Tela Valida Credenciais.png|centro]]
 

'''Os retornos possíveis serão:'''


* '''Conexão realizada com sucesso: '''As credenciais informadas conseguiram conectar no ambiente e serviços para os quais eles foram informados.

[[Arquivo:Conexao Realizada com Sucesso.png|centro]]
 

* '''Credenciais não fornecidas: '''O CIGAM não realizou o teste de conexão para esta API/Ambiente pois não foram informados dados de credencial.

[[Arquivo:Credenciais nao fornecidas v2.png|centro]]
 

* '''Erro de Conexão: '''Existe erro nas credenciais informadas. Confirme se estas credenciais são compatíveis com o escopo (API) ou ambiente (Homologação/Produção) que deseja configurar.

[[Arquivo:Erro na Conexao.png|centro]]

==== ''Botão Resposta API'' ====

Já o botão “Resposta API” apresenta especificamente a consulta feita pelo CIGAM, este dado é importante para avaliações dos setores de suporte e desenvolvimento da CIGAM.

[[Arquivo:Botao Resposta API.png|centro]]

=== Como excluir uma parametrização Open Banking ===

Por fim, cada grupo “Convenio” possui um conjunto de credenciais para si, ou seja, cada linha de convênio parametrizada terá credenciais específicas, desta forma, caso seja desejo '''EXCLUIR''' uma parametrização open banking, basta teclar F3 sobre o convênio desejado, com isso serão excluídos todos os registros de credenciais e portador vinculados a ele.


=== Como criar uma parametrização Open banking adicional para um mesmo Banco ===

É comum um mesmo banco possuir credenciais diferentes para mais de uma conta, neste caso, haverá mais de uma linha de convenio (A e B) ou até mesmo Geral + convenio específico. Neste caso, após realizar a primeira parametrização através do assistente, você poderá teclar “Ctrl+I” para invocar novamente o assistente e realizar a nova parametrização de dentro da tela “Parâmetros Open Banking”. Abaixo um exemplo:

[[Arquivo:Ctrl I Parametros Open Banking.png|centro]]

A primeira linha “Geral” valerá para qualquer convênio, menos para os portadores do convênio “1285184” que usarão suas credenciais específicas.


=== Como adicionar um novo portador para uma mesma credencial ===

Caso você precise incluir um novo portador, seja uma nova conta corrente ou uma nova carteira que compartilhe credenciais de uma parametrização de open banking que já exista. Basta em modo modificar na linha de convênio existente e, no bloco “Portadores” criar uma linha nova indicando os portadores adicionais. Não é necessário invocar o assistente.

[[Arquivo:Incluir novo portador open banking.png|centro]]

= Assistente de configuração Open Banking =

Como mencionado anteriormente, o assistente de parametrização do Open Banking será disparado sempre que se clicar no botão “Open Banking” do cadastro de configuração de bancos que não possuírem parametrização prévia. Para os bancos com alguma parametrização já criada, ele é chamado através do comando criar (Ctrl+I).


'''NOTA AOS SETORES DE ATENDIMENTO E IMPLEMENTAÇÃO CIGAM: '''Conforme mencionado no item [[#Obtenção de credenciais - Instruções Gerais | Obtenção de credenciais]] deste manual, independentemente do banco que você estiver configurando, antes de iniciar o processo de implementação, é imprescindível ter os dados de credenciais, certificados digitais, scopes etc em mãos, a primeira página do assistente open banking irá indicar as informações necessárias. Caso esteja em dúvida, consulte a sessão correspondente à obtenção de credenciais do banco que você está querendo configurar. Recomendamos que o trabalho de implementação/atendimento só seja iniciado após a confirmação da existência de tais dados uma vez que não está dentro das nossas possibilidades obter tais informações.


= Funcionalidades Open Banking =

Neste bloco iremos apresentar todos os processos existentes no Open Banking CIGAM. '''É importante destacar que o Open Banking CIGAM está disponível apenas na versão 11 e a partir das versões 201103.RC.'''

== Registro de cobrança ==

O registro de cobrança é a funcionalidade principal das APIs bancárias atuais, praticamente todas as instituições iniciam a sua jornada na liberação de APIs através dela. O escopo de funcionalidades varia desde APIs que apenas '''registram''' o título até aquelas que '''registram/alteram/capturam '''o retorno do título.


Se formos traçar um paralelo com o CNAB, o método de registro da API de Cobrança realiza todos os movimentos que um CNAB de cobrança realiza, ou seja, é o método utilizado para registrar um título e obter o resultado “ENTRADA CONFIRMADA”. Uma vez registrados, ainda temos a função “N comandos” do CNAB, que era utilizada para interagir com os títulos já registrados, em algumas APIs já é possível realizar alterações de vencimento, valor de juros e multa, baixa de títulos etc. Também é comum apenas a API de registro ser liberada sem o método de retorno,  nestes casos, o CNAB ainda é utilizado para realizar a consulta e liquidação dos títulos.


== Visão Geral ==

Para realizar o registro de um título, primeiro você precisa ter o seu banco parametrizado com o uso das credenciais conforme descrito no item [[#Obtenção de credenciais - Instruções Gerais | Obtenção de credenciais]] deste manual. A partir deste momento você estará apto a registrar títulos nesta instituição.


Sempre que um lançamento for criado utilizando um portador parametrizado para o Open Banking CIGAM, ele apresentará a legenda “Situação Open Banking” no grupo “Dados Bancários”, conforme apresentado na imagem abaixo:


[[Arquivo:Titulo Nao Registrado Open Banking atualizado.png|centro]]

== Status Open Banking para o método de cobrança ==

* '''Não Registrado:''' título recém-criado e não enviado para a instituição financeira.


* '''Registrado: '''título registrado na instituição financeira via Open Banking.


* '''Erro: '''representa um título que teve uma tentativa de registro, porém recebeu retorno com inconsistência da API. Maiores informações na sessão de tratamento de erros.


* '''Alteração Pendente: '''título com alteração realizada no CIGAM, mas ainda não registrada no Banco.


* '''Liquidado: '''título liquidado via API de retorno.


* '''Baixado: '''registrado via API de cobrança e baixado através do comando de baixa da API.


== Menu lateral Open Banking ==

Nos lançamentos pertencentes ao escopo da API de cobrança, está habilitado um novo menu de mesmo nome, abaixo segue um descritivo básico de cada uma das opções:


[[Arquivo:Menu Lateral Open Banking atualizado.png|centro]]

* '''Registrar: '''É o botão responsável por registrar um boleto na instituição financeira. Existem outras formas de realizar o registro, esta é a mais básica, as demais serão descritas mais a frente neste documento. Regras para habilitar o botão:
<ul>
* Possuir portador de Open Banking;
* Tipo do lançamento igual a 'Receber';
* Boleto impresso;
* Número no Banco preenchido;
* Lançamento diferente de Previsão;
* Tela em modo diferente de 'Criar';
* Boleto Impresso marcado;
* Status Open Banking igual a 'Não Enviado'.

</ul>

* '''Reenviar:''' Habilitado somente para lançamentos com a situação open banking igual a “Erro”, serve para realizar uma nova tentativa de registro em um título que esteja divergente.


* '''Baixar:''' Habilitado somente para lançamentos com a situação open banking igual a “Registrado”, serve para enviar o comando de baixa do título, após a sua execução, é possível realizar um novo registro. Maiores detalhes na sessão que descreve este processo.


* '''Registrar alteração: '''Habilitado apenas em títulos com o status “alteração pendente”, serve para registrar alterações realizadas em títulos previamente registrados. O tipo de alteração possível depende do escopo da API de cada banco.


* '''Histórico: '''Local onde são registradas todas as interações e tentativas de interação do ERP CIGAM com o Banco. A cada ação de comunicação com a API bancária para aquele lançamento, o CIGAM irá criar uma linha de histórico com data, hora e dados de usuário que realizou a ação, o log é incrementado da ação mais nova para a mais antiga.


[[Arquivo:Histórico Open Banking.png|centro]]


Abaixo serão descritos os campos “Ação” e “Status Open Banking”, eles representam respectivamente a comunicação CIGAM vs o retorno do Banco instituição financeira.


<center>
{| class="wikitable"
|-
! Ação (CIGAM) !! Status Open Banking (banco ou instituição)
|-
| '''Registrar:''' comunicação do CIGAM no momento da tentativa de registro do título. Em um paralelo com o CNAB, é a ação que representa o upload de um arquivo de remessa. || '''Registrado:''' resultado positivo para uma tentativa da ação CIGAM “Registrar”.
 
'''ERRO:''' resultado negativo para a ação “Registrar”.
|-
| '''Consultar:''' comunicação do CIGAM para obter informações daquele título, a rotina de retorno Open Banking sempre irá gerar um registro deste tipo. Dependendo dos filtros da rotina de retorno, a consulta pode resultar em uma liquidação, conforme abaixo. No modelo CNAB, esta seria a representação da importação de um arquivo de retorno. || '''Consulta:''' resultado positivo para uma tentativa da ação CIGAM “Consultar”.
|-
| '''Alterar:''' representa a ação de interação com o título já registrado, as possibilidades de alteração dependem do escopo da API da instituição com que se estiver trabalhando, as alterações mais comuns são de vencimento, juros e multa. Consulte os descritivos de cada banco para verificar as alterações possíveis. || '''Alterado:''' resultado positivo para uma tentativa da ação CIGAM “Alterar”. '''ERRO:''' resultado negativo para a ação “Alterar”.
|-
| '''Liquidar:''' Caso a consulta realizada retorne que o título está liquidado e o filtro da rotina de retorno esteja apontando para “Liquidar”, será criada uma linha com esta ação, liquidando o título. || '''Liquidado:''' resultado positivo para uma tentativa da ação CIGAM “Liquidar”. '''ERRO:''' resultado negativo para a ação “Alterar”.
|-
| '''Baixar:''' Ação utilizada para registrar a solicitação de baixa de um título. || '''Baixado:''' resultado positivo para uma tentativa da ação CIGAM “Baixar”. '''ERRO:''' resultado negativo para a ação “Baixar”.
|-
|}
</center>

'''Erro:''' resultado negativo para qualquer uma das ações CIGAM. Este status Open Banking será apresentado sempre que houver algum problema na ação que se deseja registrar. A solução para cada caso irá variar conforme a situação. O CIGAM possui um cadastro de sugestões para a solução dos erros já mapeados (conforme imagem abaixo) que podem ser utilizadas como guia para a sua resolução.


[[Arquivo:Erro Open Banking Historico.png|centro]]


Para uma nova tentativa após ajuste de uma situação de erro, existem duas possibilidades:


# Clicar no botão “Reenviar” no grupo “Open Banking” do menu lateral do lançamento financeiro
# Executar a rotina de remessa open banking utilizando um filtro que contemple o lançamento em questão. Caso a situação seja sanada, o registro acontecerá normalmente.

Maiores informações sobre o processo de mensagens de APIs financeiras podem ser encontradas na sessão específica deste manual no final desta sessão.



'''Altera Situação: '''Este campo do tipo “Checkbox” é marcado automaticamente pelo CIGAM sempre que o retorno da API open banking refletir em uma ação que altere o lançamento financeiro do CIGAM, seja uma liquidação ou uma baixa.


'''Comando: '''Este campo é uma identificação da API e é representado pelos códigos:


* 00 – Não Registrado


* 01 – Registrado


* 02 – Alterado


* 03 – Baixado


* 04 – Liquidado


* 06 – Consulta


* 07 – Erro



'''IMPORTANTE: '''Não confundir este campo comando com os “Comandos de remessa”, do lançamento financeiro e do cadastro de portador, estes serão explicados mais a frente e permanecem conforme as suas funções existentes.



'''Sequência: '''representa a sequência deste registro da tabela de log de histórico open banking.



'''U.N.: '''representa a Unidade de Negócio utilizada para a criação deste registro.



'''Usuário: '''usuário logado no sistema e responsável pela execução da ação.



'''Dados API: '''Todas as ações/status open banking possuirão um arquivo de remessa e retorno referentes à comunicação gerada entre CIGAM e Banco, estes arquivos contém os dados de todas as informações trocadas em um formato chamado “JSON”. Traçando um paralelo com o CNAB, este é o substituto do arquivo txt que era enviado e baixado no gerenciador bancário. Os dados de envio do JSON de cada interação estão disponíveis no botão da coluna “Dados API”:


[[Arquivo:Botao Dados API Historico OB.png|centro]]


Exemplo de JSON de registro (envio e retorno) de um título no Banco:


[[Arquivo:Exemplo JSON Envio OB.png|centro]]

== Botão “Copiar” ==

O Botão “Copiar” permite selecionar a totalidade do conteúdo dos arquivos JSON e copiá-los para o clipboard do Windows, desta forma, caso seja necessário enviar este conteúdo para um outro destinatário (suporte/implementação) basta teclar “Ctrl+v” em um editor de texto:

[[Arquivo:Botao Copiar Historico OB.png|centro]]
 
[[Arquivo:Mensagem Botao Copiar Historico OB.png|centro]]
 

'''Auditoria: '''conforme mencionado no item [[#Configuração do portador|Configuração do portador]] deste manual, os portadores utilizados no open banking devem possuir a opção “auditoria” selecionada com a opção “detalhado”, isso irá permitir o registro de todas as alterações do título em questão. Isso também permitirá clicar no botão “auditoria” do histórico open banking, o que permitirá identificar todas as informações daquele lançamento, bem como data, hora e usuário que realizou a alteração.


[[Arquivo:Pesquisa Auditoria OB.png|centro]]


As alterações são registradas da mais atual para a mais antiga.


== Pesquisa dinâmica de Lançamentos ==

A pesquisa dinâmica de lançamentos possui um filtro relativo à situação Open Banking do lançamento:


[[Arquivo:Pesquisa Dinamica OB.png|centro]]

== Mensagens de erro Open Banking ==

As mensagens open banking possuem um cadastro salvo em gestão financeira>parâmetros>Mensagem de Retorno de APIs financeiras. Este cadastro visa auxiliar o usuário na obtenção de informações acerca da resolução de situações de erro obtidas na comunicação das APIs do módulo financeiro, não somente ao Open Banking, mas também às APIs do PIX.


[[Arquivo:Mensagem de Retorno API Financeiro 2.png|centro]]


As mensagens estão distribuídas por banco, código de erro, status de retorno, descrição dada pelo banco, sugestão CIGAM, que é uma dica da equipe CIGAM em como resolver tal problema e por fim uma coluna de sugestão do cliente, que pode ser informada com as próprias interpretações dos usuários para solucionar aqueles casos.



A tabela é periodicamente atualizada pela equipe CIGAM e pode ser atualizada no cliente através do botão [[Image:Botao Refresh v2.png|top]]. Outra funcionalidade importante é que a tabela de erros do cliente é incrementada conforme as mensagens são recebidas, ou seja, caso o banco retorne uma mensagem que ainda não havia sido recebida ou contida na tabela, ela será inserida automaticamente, o que resulta em uma tabela sempre crescente e sem a possibilidade de apresentar um “erro desconhecido”.



As mensagens da API são apresentadas imediatamente no momento da recepção do erro e podem ser visualizadas novamente sempre que se clicar na palavra “erro” na situação open banking do lançamento ou dentro do botão histórico open banking.



[[Arquivo:Situacao Open Banking Historico atualizado.png|centro]]

=== Cadastro de mensagens de erro Open Banking ===

Qualquer pessoa poderá cadastrar uma mensagem de alerta/erro com texto mais amigável a fim de auxiliar os demais usuários em erros já conhecidos no registro do Open Banking. Para tanto, basta entrar no cadastro de mensagens, localizar a mensagem do banco que deseja inserir a sugestão e informar o texto no campo “Sugestão Cliente”:


[[Arquivo:Cadastro de Mensagem de Erro Open Banking.png|centro]]


Pronto! Na próxima vez que a mensagem de erro aparecer, o usuário logado irá visualizar a dica para a solução da situação.


= Registrando títulos =

Existem duas formas de realizar o registro de títulos open banking, um é realizado pelo movimento em que se está (lançamento, nota fiscal, contrato etc.), chamado de direto. A outra é pela rotina de remessa específica, chamado de indireto, ambos serão demonstrados abaixo.


'''IMPORTANTE: '''para a rotina de registro open banking não há distinção entre bancos, todos seguem o mesmo formato, isso significa que as próximas informações valem para qualquer banco ou instituição que possua API de registro no CIGAM.


== Registro do boleto de cobrança nas modalidades Direto ou indireto ==

A depender da opção “Direto” estar marcada nos parâmetros Open Banking, o CIGAM irá se comportar de formas distintas. Com a opção '''marcada''', o CIGAM irá realizar o registro do título na '''impressão '''do boleto. Com esta opção '''desmarcada''', o registro será feito apenas quando da execução da rotina “Remessa de cobranças Open Banking”.


[[Arquivo:Checkbox Direto Parametros Open Banking.png|centro]]

== Operação com a opção Registro Direto marcada ==

Este formato de uso é o mais recorrente em nossos clientes e é o formato de implementação sugerido, onde no momento do envio e confirmação da NFe o boleto já é registrado imediatamente. Esta é a opção necessária a ser utilizada juntamente com a opção “PIX”, no qual será impresso o QR Code para pagamento PIX.


Um título que que possua a opção “Direto” marcada será registrado nas seguintes situações:


# No cadastro de lançamento avulso ao clicar em “imprimir boleto”;
# Na confirmação da NFe/NFSe (caso parametrizada para envio de boleto);
# Na rotina de impressão de boletos em lote;


== Operação com a opção Registro Direto desmarcada ==

A opção “Registro direto” é utilizada desmarcada apenas em alguns casos específicos, por exemplo, quando o cliente possui um processo de conferência das notas fiscais após a sua geração e onde pode ocorrer alguma alteração de valores ou até mesmo um cancelamento da nota. Ao deixar a opção desmarcada, os boletos não serão registrados imediatamente na confirmação da nota.



Um título que possua a opção “Direto” desmarcada será registrado apenas na execução da rotina “Remessa de Cobrança Open Banking” (executada após a ter ocorrido a impressão do boleto).



Idealmente, neste formato, sugerimos que o boleto '''não''' seja parametrizado para envio pela NFe, já que, além de não estar registrado até que o seu registro seja feito pela rotina de “Remessa de cobrança Open Banking”, caso o banco que está sendo utilizado possua a opção de QR Code PIX no boleto, a operação PIX somente é gerada no momento do registro do boleto. Imprimir um boleto sem registro, embora seja possível, irá resultar em um boleto sem QR Code PIX.


== QR Code no Boleto ==

Alguns bancos disponibilizam juntamente com o serviço de registro de cobrança a possibilidade de criar uma Operação PIX de mesmo valor atrelada ao título que se está registrando. Esse registro possibilita mais uma forma de pagamento ao cliente que poderá pagar tanto pelo código de barras do boleto quanto pelo QR Code da operação PIX. Cada banco possui uma forma de lidar com estes registros, seja baixando automaticamente o boleto quando do pagamento do PIX ou cancelando-os. Consulte a área de open banking de cada uma das instituições para entender como cada uma gere estas transações.



No CIGAM a forma de se parametrizar uma operação PIX (QR Code no boleto) é sempre a mesma, deve ser marcada a opção “PIX” ao lado da opção “direto” no assistente de parametrização ou na tela de parâmetros open banking e utilizar um modelo de boleto padrão com QR Code ou adicionar a variável '''qrcode_pix''' (<!$MG_qrcode_pix>) ao seu modelo de boleto personalizado.


=== Chave PIX do QR Code no boleto ===

A Chave PIX utilizada no boleto varia conforme o Banco, porém atualmente existem duas origens possíveis:



No cadastro do portador de remessa (botão parâmetros PIX):


[[Arquivo:Chave Pix Open Banking Portador.png|centro]]


Ela será enviada no JSON dessa forma:


[[Arquivo:Dados Qrcode JSON Envio OB v2.png|centro]]


Ou será utilizada automaticamente a chave PIX da conta vinculada ao convênio do boleto, neste caso não é enviada chave no JSON, apenas a indicação de que há ou não PIX no boleto.


[[Arquivo:Indicador Pix JSON OB.png|centro]]

'''Manuais Referenciados:'''
*[[Open Banking - Não está imprimindo QR Code no meu boleto]]


== Rotina de Remessa Open Banking (via menu) ==

O registro de títulos open banking via menu é utilizada principalmente pelos clientes que optarem em não utilizar a opção “Direto” para os seus títulos.



''Menu: Gestão Financeira > Rotinas > Operacionais > Open banking > Remessa de cobrança Open Banking''



Ao utilizar a rotina de remessa via menu, os filtros a serem utilizados devem ser aqueles que sejam suficientes para localizar a todos os títulos que ainda não tenham sido registrados. Assim como nas remessas CNAB, uma boa ideia de filtro são todos os títulos com data de emissão inicial igual a 00/00/0000 até a data atual.


[[Arquivo:Remessa de Cobranca Open Banking v2.png|centro]]

== Condição para um lançamento ser registrado/apresentado na remessa open banking (avulso ou em lote) ==

Ao executar a rotina, serão registrados todos os títulos a receber com:

# situação “open banking = Não registrado”;
# com número no banco;
# opção “boleto impresso” marcada;
# opção “remessa enviada” desmarcada;
# que estiverem contemplados dentro dos filtros informados;
# Ela também serve para realizar o registro de alterações de títulos com Situação Open Banking = “Alteração Pendente” onde eles também serão enviados para registro da sua alteração.



Ao final, será apresentado o relatório com a situação de cada um dos títulos e seus retornos.


== Relatório de remessa bancária ==

O relatório de remessa bancária será impresso sempre que um registro avulso (direto pela tela de lançamentos) for feito ou como resultado da execução da rotina de Remessa Bancária On Line. As suas variáveis estão contidas no arquivo salvo em:


I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\RF00071_remessas.RTF 


Este modelo serve tanto para remessa quanto para retorno on line e é apresentado da seguinte forma:


[[Arquivo:Relatorio Remessa Bancaria.png|centro]]

== Rotina de Retorno Open Banking ==

O retorno de cobrança open banking, ao contrário do registro, é específico para cada instituição, eles serão apresentados banco a banco nesta sessão:



O retorno on line pelo Open Banking CIGAM vem para substituir o arquivo CNAB de retorno e é responsável por consultar e atualizar os títulos registrados na instituição bancária. Desta forma, o CIGAM está sempre atualizado com o seu banco. Este bloco do manual estará dividido diretamente por banco, uma vez que cada um possui uma forma de tratamento em seu retorno.



''Menu: Gestão Financeira>rotinas>operacionais>open banking>Retorno de cobrança open banking.''



A rotina de retorno é única para todos os bancos do escopo open banking e varia os seus parâmetros de filtros (na aba filtros) conforme o banco apontado no portador informado no filtro “portador”, para auxiliar na execução da rotina existe um botão “aqui” no texto “Para mais informações a respeito dos filtros, clique aqui”. Já a aba “parâmetros” segue a mesma regra para todos os bancos e utiliza funções herdadas da rotina de retorno de CNAB de cobrança conforme abaixo:


[[Arquivo:Portador Retorno de Cobranca Open Banking.png|centro]]


'''Tipo de 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 os contabilizar 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 - tag "dataRecebimentoTitulo") 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 - tag "dataCreditoLiquidacao") 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 alterá-la ou quando zerada habilita para buscar automaticamente a Data de Ocorrência ou Crédito.



'''Gerar acompanhamento das ocorrências bancárias: '''Esta opção é utilizada para descrever os dados de valores do título advindo do banco no retorno da ação de “liquidar” abertos por Valor, Juros, multa, desconto por tarifa, desconto e outros recebimentos.


=== Regras de Busca do Sistema para localizar títulos no retorno ===

O sistema tenta localizar os títulos pelo Número do Lançamento;



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''';



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''';



Quando o retorno de títulos for feito com o checkbox <ref group="Versão 251103.b">Liberado a partir da OS 961263/9.</ref>"Processar títulos não gerados pelo CIGAM" marcado, o sistema passa a priorizar a busca de títulos pelo Nosso Número. Essa opção deve ser utilizada quando os títulos não forem emitidos pelo CIGAM.


=== Retorno de cobrança via CNAB (bancos que ainda não possuem método para retorno) ===

O projeto open banking varia de instituição para instituição, é comum que um banco libere apenas a API de registro no seu projeto open banking. Nestes casos, você pode continuar realizando os retornos via CNAB configurável, nos mesmos moldes já utilizados. Ele é uma forma de consulta válida e que atende os requisitos da funcionalidade, porém fique atendo e em contato com a sua instituição e às atualizações do CIGAM, a qualquer momento o retorno bancário de cobrança poderá ser liberado e você poderá migrar para o Retorno de cobrança On Line.


==Endereço do Cliente==

Para registro do boleto, será utilizado o endereço principal do cliente, aquele informado na guia '''Empresa''' do cadastro do cliente informado no campo Cobrança do Lançamento Financeiro.

Não há tratativa para avaliação de múltiplos endereços de cobrança, neste caso, não valida a ordem do endereço informada no lançamento financeiro.

= Alterações de títulos registrados Via Open Banking =

As APIs de registro também são responsáveis por realizar alterações nos títulos existentes na instituição. A seguir serão apresentados os serviços de alteração disponíveis no CIGAM de forma geral, todos os bancos possuem o mesmo tratamento para todas as funções apresentadas. Basta avaliar se o banco que você está utilizando possui tal funcionalidade.


== Alteração de Juros, Multa e vencimento ==

Aqui, a maior diferença entre o CNAB e o Open Banking CIGAM é a de que, embora as duas metodologias utilizem o cadastro de comandos para realizar as três alterações mais comuns em títulos (Juros, Multa e Vencimento), o Open Banking irá funcionar mesmo que não haja um comando cadastrado para tanto. Nestes casos, eles serão criados automaticamente.


=== Regra Sistema para Vencimento, Multa ou Juros ===

O 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, Juros e Vencimento, o sistema cria automaticamente (Somente Juros, Multa e Vencimento).


Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo Multa, Juros ou vencimento, automaticamente após alteração da Multa, o Sistema irá criar essa parametrização do Comando de Remessa como sugestão (caso não haja um comando do tipo necessário), 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''' = ATJ
* '''Descrição''' = ALTERAÇÃO DE JUROS PARA OPEN BANKING
* '''Tipo de Comando''' = Alteração de Juros



'''Comando sugestão para troca de vencimento:'''


* '''Código Operação''' = ATV
* '''Comando''' = ATV
* '''Descrição''' = ALTERAÇÃO DE VENCIMENTO PARA OPEN BANKING
* '''Tipo de Comando''' = Alteração de vencimento


[[Arquivo:Comandos de Alteracao Open Banking.png|centro]]


A alteração destes 3 campos é enviada sempre que um título previamente registrado receber alguma alteração. Lembrando que para juros e multa, os campos enviados são sempre em valor, nunca em percentual. Isso auxilia
o cálculo de juros/multa ao dia simulado pelo CIGAM em locais como o portal do cliente – área financeira.



[[Arquivo:Alteracao Vencimento Open Banking alterado.png|centro]]

[[Arquivo:Alteracao Multa e Juros Open Banking.png|centro]]


Depois de realizar as alterações, elas serão enviadas de forma agrupada para o banco, bastando que seja salva a informação através do comando CTRL+Q ou clicando na opção “Registrar alteração” do menu lateral do grupo open banking do lançamento.



Veja que a situação open banking de um título que ainda não tenha tido a sua alteração registrada no banco fica como “Alteração pendente e o comando de remessa é preenchido. Outro ponto importante é que o comando de remessa para cada um dos tipos de alteração é utilizado conforme a sua existência no botão “comandos” do cadastro de portador. Caso ele não exista previamente, ele é criado de forma automática conforme apresentado na sessão de cadastros de portador deste manual.



[[Arquivo:Confirmar Envio de Alteracao ao Banco Open Banking atualizado.png|centro]]


Ao confirmar a mensagem acima, a alteração será processada e a situação do título, caso não ocorra nenhum erro, volta a ficar como registrada e tudo é gravado no histórico open banking:



[[Arquivo:Alteracao Concluida Open Banking atualizado.png|centro]]

=== Não escopo dos serviços de alteração ===

Alguns pontos ainda não estão tratados neste manual, por exemplo, alteração de desconto até o vencimento, endereços, etc.


== Baixa de títulos ==

A baixa de títulos serve para retirar o título do registro bancário, ela só está habilitada para um título com a situação “Registrado” e ao final do processo, o título terá todas as informações relativas à sua caracterização prévia (nosso número, número no banco etc) removidas. Isso possibilita realizar o registro do título novamente.


'''Observação: Para Baixar, não é necessário o cadastro de comando de remessa no Portador.'''


[[Arquivo:Botao Baixar Open Banking atualizado.png|centro]]


[[Arquivo:Titulo Baixado Open Banking atualizado.png|centro]]

[[Arquivo:Baixa Historico Open Banking.png|centro]]

=== Não escopo do serviço de baixa ===

Atualmente quando uma nota é cancelada, por exemplo, não é enviado o comando de baixa para o banco, portanto o processo sugerido é que primeiro seja realizado o processo de baixa unitário pela tela do lançamento financeiro e após proceder com o cancelamento.



Sugerimos cautela no uso de rotinas que realizem manutenção de lançamentos em lote como “Pagamentos/Recebimentos” e “Manutenção de Lotes” que realizam a troca de portadores de lançamentos financeiros. O motivo é que caso os portadores de lançamentos registrados via open banking tenham seus dados alterados, a informação do registro no CIGAM irá se perder. Embora haja mensagens de alerta para comunicar o usuário deste risco, ainda é possível realizar a confirmação das alterações.


== Abatimento de títulos ==

<ref group="Versão 251103">Liberado a partir da OS 816297/7.</ref>O abatimento é uma operação que permite reduzir parcialmente o valor de um título já registrado no banco. Quando um abatimento é registrado no Cigam, o sistema envia automaticamente a instrução para o banco por meio da integração de Open Banking, garantindo que o valor atualizado do boleto seja refletido tanto no ERP quanto na instituição financeira.


O abatimento ocorre quando o cliente decide reduzir (“perdoar”) parte do valor de um título registrado.
Exemplo:


* Valor original do título: R$ 100,00
* Valor do abatimento: R$ 20,00
* Novo valor do título no banco: R$ 80,00


Além disso, também será possível realizar o cancelamento do abatimento, retornando o título ao valor original.


=== Registro de abatimento ===

Para que o CIGAM reconheça automaticamente uma liquidação como abatimento, foi criado o novo tipo de controle "Abatimento" no cadastro do Portador:

[[Arquivo:Open Banking Geral 0002.png|centro]]

Sempre que uma liquidação for realizada utilizando um portador desse tipo, o CIGAM entenderá que se trata de um abatimento e registrará o comando correspondente no Open Banking automaticamente.


O abatimento pode ser registrado de duas formas:


* Diretamente na tela do lançamento financeiro, através de uma liquidação utilizando um portador de abatimento.
* Através da rotina de Devolução de Saídas, utilizando o portador de abatimento na liquidação do saldo em aberto contra devolução.


Sempre que um abatimento for realizado, o sistema utilizará o comando de remessa "ATA", criado automaticamente pelo próprio sistema.


'''Bancos atendidos:''' Banco do Brasil, Itaú, SICOOB, Santander e Sicredi.


'''Observação:''' O SICOOB pode levar em torno de 40 minutos para processar o abatimento.


=== Cancelamento de abatimento ===

Quando uma liquidação registrada em um portador de abatimento é excluída, o CIGAM realiza a exclusão do lançamento e envia automaticamente ao banco o comando de cancelamento do abatimento. Esse cancelamento pode ocorrer de duas formas:


* Pela exclusão da liquidação diretamente na tela do lançamento financeiro.
* Pela exclusão da nota de devolução quando o abatimento tiver sido gerado por meio da rotina de Devolução de Saídas.


Caso ocorra algum erro no processo, a liquidação será excluída normalmente, porém o lançamento original permanecerá com o comando de remessa “ATA” pendente para registro posterior.


= Proteções no Lançamento =

Com o advento do Open Banking, faz-se necessário um maior controle dos lançamentos registrados nos bancos, se um título registrado via API tiver seu portador e/ou vencimento alterados por rotinas do CIGAM, correremos o risco destas alterações não serem refletidas nos bancos.


No contexto atual, onde teremos ainda clientes utilizando serviços mesclados em CNABs para alguns bancos e Open Banking para outros, precisamos ter tratamentos específicos para cada situação. Em algumas delas é utilizado o que já é feito nos CNABs e em outras, foram realizados novos tratamentos visando alertar o usuário em ações executadas no sentido de quebra de integridade entre o banco e o CIGAM, seja nas rotinas em lote ou unitariamente no lançamento financeiro.


== Grupo Dados Bancários ==

<ref group="Versão 231002">Liberado a partir da versão BETA 231002.</ref> A fim de iniciar o processo de proteção dos lançamentos financeiros registrados via Open Banking, os campos que possam descaracterizar um lançamento já registrado não poderão ser alterados, sendo eles:


* '''Número no Banco:''' Bloqueado
* '''Nosso Número:''' Bloqueado
* '''Boleto impresso:''' Bloqueado
* '''Remessa enviada:''' Bloqueado
* '''Código Barras Lido:''' Removido para lançamentos a receber
Estes bloqueios são válidos apenas para titulos registrados via open banking

[[Arquivo:Open Banking - Geral 001.png|centro]]

Deste modo a única forma de alterar os dados bancários de um lançamento será através da alteração do seu portador. Esta alteração poderá nos levar a duas situações, sendo a primeira aquela em que o novo portador mantém todos os dados do portador atual (ex: troca da carteira simples para a carteira descontada) ou a segunda onde o portador alterado é uma conta/banco diferente, cada caso será apresentado abaixo.


== Alteração de Portador ==

Atualmente os lançamentos registrados por Open Banking trabalham de forma similar ao CNAB, onde caso eles sejam modificados a nível de portador, também perderão seus vínculos com o banco. Porém, como nesta modalidade temos uma integração completa com a instituição, faz mais sentido que as alterações “finalizem” o processo de forma mais organizada, ou seja, se um lançamento for perder o seu vínculo com o banco por conta de uma troca de portador ou cancelamento de nota, por exemplo, que isso seja realizado junto ao banco também.


=== Validação dos dados de portador ===

Quando é realizado a troca do primeiro portador para o segundo portador, é avaliado se no segundo todos os campos verificados estão batendo com os do primeiro, sendo eles Banco, Conta, Agência e Convênio.

[[Arquivo:Open Banking - Geral 002.png|centro]]

Se esses campos corresponderem o lançamento terá o seu portador alterado. Para não perder o vínculo com o banco será mantido o histórico Open Banking no antigo portador.

[[Arquivo:Open Banking - Geral 003.png|centro]]
Caso contrário, se os portadores possuírem os campos validados distintos será exibida a seguinte mensagem:
[[Arquivo:Open Banking - Geral 004.png|centro]]

Clicando em "Detalhes" serão exibidos os dados validados dos dois portadores:

[[Arquivo:Open Banking - Geral 005.png|centro]]

Para realizar a troca será necessário definir se o título será baixado ou não, se '''Baixar Título''' o título será baixado no banco e estará pronto para atender ao novo portador, caso '''Continuar sem Baixar''' o vínculo anterior é quebrado e os dados do lançamento serão sobrescrito com o novo portador.


= Retenção P/C/C - PIS, COFINS, CSLL =

Para quem utiliza o recurso de Controlar Retenções na Saída, ou seja, configuração [[GF - GE - 2505 - Código de imposto para controlar retenção de CSLL na saída]], e deseja registrar o lançamento financeiro no valor líquido, já descontando as retenções, é necessário:
*Parametrizar a configuração [[GF - GE - 3214 - Diminuir valor das retenções do valor total do boleto]], como '''1 - Sempre''' ou '''2 - Por Empresa''', e
*Se a configuração estiver como '''2 - Por Empresa''', deve-se marcar as empresas desejadas no campo '''Descontar Retenção no Boleto'''.

Para mais informações de como funciona esse recurso, consulte a WIKI [[OS 816297/10 – Retenções P/C/C + Boletos + CNAB e Open Banking]].

Para informações sobre o uso do Controle das Retenções na Saída, consulte [[GF - Como Fazer - Controlar Retenções de PIS-COFINS-CSSL-IRRF-INSS-ISS para Nota Fiscal de Saída]].

= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking para Banco do Brasil|Open Banking para Banco do Brasil]]
* [[GF - Como Fazer - Open Banking para Banco Itaú|Open Banking para Banco Itaú]]
* [[GF - Como Fazer - Open Banking para Banco SICOOB|Open Banking para Banco SICOOB]]
* [[GF - Como Fazer - Open Banking para Banco Bradesco|Open Banking para Banco Bradesco]]
* [[GF - Como Fazer - Open Banking para Banco Sicredi|Open Banking para Banco Sicredi]]
* [[GF - Como Fazer - Open Banking para Banco Santander|Open Banking para Banco Santander]]
* [http://ww2.cigam.com.br/mediawiki/index.php/FAQ_GF#Open_Banking FAQs - Open Banking]
*[[Open Banking - Em qual tabela fica gravado o registro do campo "Situação Open Banking" do lançamento financeiro]]
*[[Open Banking - O que é Endpoint, Request e Response?]]

= Versões =
== Versão 231002 ==
<references group="Versão 231002"/>

== Versão 251103 ==
<references group="Versão 251103"/>
=== Patch 'b' ===
<references group="Versão 251103.b"/>

== Versão 260601 ==
<references group="Versão 260601"/>
=== Patch 'b' ===
<references group="Versão 260601.b"/>

GF - Como Fazer - Open Banking

2026-08-27T19:38:51Z

Tais.felles: /* Versões */

[[categoria:Como_Fazer_Finanças]]

= Objetivo =


O open banking CIGAM é um projeto que visa implementar as APIs bancárias (interfaces online de comunicação) nos módulos financeiros do ERP CIGAM. O maior benefício obtido com estas integrações é a eliminação do uso de arquivos CNAB (*.txt) e a migração para uma conexão direta com o banco. Assim o usuário passa a fazer tudo dentro do CIGAM sem precisar entrar no gerenciador financeiro do banco.


Com base em estatísticas colhidas com nossos clientes, após a implementação do open banking CIGAM é possível reduzir cerca de 5 a 8 horas semanais de envolvimento com os gerenciadores bancários! Isso é mais tempo para o que realmente importa!


O presente manual visa apresentar o escopo completo do projeto Open Banking para tudo aquilo que é comum a todos os bancos. Para as dicas e orientações de instituições específicas, acesse o manual de cada banco.


==Introdução ao Open Banking==
<center><youtube>=Kdz-eqPaJj4&list=PLzmuT6ANAEw8F2yYpYiWH8lvJaL0cDmng&index=6</youtube></center> 

= APIs atendidas por instituição =

No quadro abaixo são apresentadas as instituições participantes do escopo do open banking e os serviços disponibilizados pelas mesmas bem como se este serviço já está sendo atendido no CIGAM.


[[Arquivo:Open Banking Geral 00011.png|centro]]
'''*''' Ainda não disponível no CIGAM

= Migrando um cliente do CNAB para a API Open Banking =

A migração para o Open Banking de um cliente que hoje está utilizando CNAB deve ocorrer de forma transparente, o que está mudando é a forma de registro e não o registro em si. '''Pense no CNAB como um envio via carta, e o Open Banking como um e-mail, a mensagem chegará de ambas as formas, porém na primeira você precisa levar a mensagem escrita à mão até o correio, já a segunda você digita e envia de casa.'''


Essa troca de formato possibilita que quando um cliente tiver o seu CIGAM configurado no open banking ele poderá imediatamente realizar o retorno via API e irá obter as informações dos títulos registrados na instituição independentemente da forma de registro previamente utilizada. Inclusive, o método de registro via CNAB continua valendo simultaneamente ao uso da API. Desta forma, embora alguns bancos disponibilizem ambientes de homologação, não recomendamos a criação de movimentos de teste nestes uma vez que existem restrições de CPF/CNPJ exclusivos para teste.


= Configurando APIs Open Banking para clientes novos em período de implementação =

Para clientes novos (em projeto), que não tem como registrar títulos oficiais no CIGAM, recomendamos avaliar a sessão “testes em homologação” nos manuais de cada banco para verificar as parametrizações necessárias.


= Obtenção de credenciais - Instruções Gerais =


A comunicação entre o CIGAM e as APIs Open Banking é iniciada através da validação de credenciais entre as duas partes. Estas credenciais podem variar de códigos de identificação como Client_ID e Client_Secret até o uso conjunto de certificados digitais, de forma semelhante à comunicação entre CIGAM e SEFAZ da Nota Fiscal Eletrônica (NFe).


Invariavelmente, para obter as suas credenciais, você deverá acessar primeiro o seu Gerente Cash ou gerente de conta PJ na instituição em que está buscando as credenciais. Em muitos casos, ele irá abrir um chamado técnico junto à área responsável para iniciar o seu processo de credenciamento seja através de um portal ou e-mail.


<ul>'''NOTA AOS SETORES DE ATENDIMENTO E IMPLEMENTAÇÃO CIGAM: '''é imprescindível ter os dados de credenciais, certificados digitais, scopes etc. em mãos, a primeira página do assistente open banking irá indicar as informações necessárias para cada banco. Recomendamos que o trabalho de implementação/atendimento só seja iniciado após a confirmação da existência de tais dados, uma vez que não está dentro das nossas possibilidades obter tais informações.</ul>


== Uso e Gestão dos certificados digitais nas credenciais Open Banking ==

Itens como “Client_ID” e “Client_secret” tem validade indeterminada e não sofrem alteração a não ser a pedido do próprio cliente. Porém um item que vêm sendo bastante difundido e incorporado ao grupo de credenciais para utilização das APIs Open Banking é o '''CERTIFICADO DIGITAL,''' no CIGAM será sempre utilizado o certificado com extensão *.pfx (contendo chave privada) com CN (common name) formado pela sua Razão Social + CNPJ. A grande maioria dos nossos clientes já possui um certificado com estas características sendo utilizado para a assinatura dos arquivos legais (SPED e EFD) e das NFes (Notas Eletrônicas) de modo que deve ser este o certificado a ser utilizado também no Open Banking.


O common name (CN) é obtido dentro da aba detalhes no item “Subject/Requerente” do certificado digital e o dado utilizado pelo CIGAM nos parâmetros de credenciais do Open Banking é sempre o que está após o texto “CN = “, ou seja, apenas a razão social + CNPJ conforme a imagem abaixo:

[[Image:Subject Certificado.png|center]]

'''IMPORTANTE:''' O cliente deve estar atento '''ao período de expiração''' (data de validade) do certificado instalado e compartilhado (chave pública) com a instituição financeira. Um certificado vencido irá implicar diretamente na comunicação com as APIs até que seja realizada a substituição por um certificado válido. O processo de substituição dos certificados irá variar conforme o banco e pode ser revisado neste manual no item correspondente a cada instituição. O CIGAM também possui a função de criar alertas a partir da versão 221107 que irá alertar o usuário indicado no assistente open banking ou a qualquer usuário que utilizar as rotinas open banking durante o período de 30 dias que anteceder o vencimento do certificado.


== Instruções para troca/renovação do certificado digital ==

As instruções para renovação do certificado digital utilizado nas credenciais dos bancos membros do projeto Open Banking variam de uma instituição para a outra para maiores instruções de como proceder, acesse o manual Open Banking de cada banco. Lembre-se de que sempre é possível contatar o seu gerente de Cash (gerente de contas do banco) para maiores informações e caso tenha dificuldade em realizar o processo, a CIGAM dispõe da [http://www.certidoc.com.br Certidoc] para prestar este auxílio.


= Configurando o Open Banking (informações gerais) =

Apesar de cada banco possuir o seu jeito de ser parametrizado, o processo de configuração do Open Banking CIGAM se dá através de apenas dois cadastros, sendo: cadastro de configuração de Bancos, onde todas as informações de credenciais e gerais daquela instituição serão concentradas; e o cadastro de portador, onde serão apontadas as informações referentes a cada uma das contas correntes de cada instituição.


'''IMPORTANTE:''' Recomendamos que antes de realizar a parametrização de bancos para o open banking CIGAM você revise todos os portadores que serão utilizados no processo, eles precisam existir e estarem prontos para serem utilizados.


== Configuração do portador ==

O cadastro do Portador, como no processo CNAB tem o objetivo de apontar os dados de cobrança/pagamento para uma Conta Corrente. De forma geral, todos os dados já informados funcionam da mesma maneira no Open Banking.

[[Image:Cadastro de Portador 221107.png|center]]

Dados como carteira e variação permanecem no mesmo formato uma vez que estas são informações de domínio do banco. Outro ponto de alerta é que para o Open Banking a opção “Processar retornos pelo número do boleto” deve estar marcada. (a rotina já realiza esta marcação, mas é importante verificar em caso de dúvidas).


Além disso, deve ser observado o campo Espécie do cadastro de Portadores, onde deverá ter o valor informado de acordo com as opções disponíveis listadas na Cigam Wiki no tópico de Open Banking de cada banco na seção '''Particularidades do cadastro de Portador''' ou através da documentação técnica atualizada fornecida por cada instituição bancária.

[[Image:Especie portador.png|center]]

Caso tenha sido realizada movimentação com esta opção desmarcada, não será possível realizar baixas, pois o sistema não consegue localizar títulos devido a não haver '''Nosso Número''' gravado nas tabelas envolvidas.


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


* Identificar o '''Nosso Número''' do registro a ser baixado (Lançamento Financeiro);
* 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.


Outro ponto importante a considerar é o campo “auditoria” do portador, no open banking é mandatório que ele esteja configurado como “'''Detalhada'''” para que o log de auditoria seja registrado.

[[Image:Auditoria Detalhada Portador Open Banking.png|center]]

Além disso, a configuração '''348 - Sincronismo lançamento''' precisa estar diferente de “Nenhum”.

[[Image:Configuracao 348 Ambos 221107.png|center]]


'''IMPORTANTE:''' Tanto no Banco do Brasil quanto nos demais bancos parametrizados no Open Banking, sugerimos a remoção dos ZEROS à esquerda nos campos de identificação do Portador (Agência, Conta, Convênio e Cedente), embora haja tratamentos no CIGAM, em alguns casos esse é o motivo de erros de comunicação, principalmente na rotina de retorno do Open Banking. Nestes pontos é comum acontecer erro de comunicação, falha de assinatura e derivados.



'''IMPORTANTE 2:''' o CIGAM atualmente não utiliza comandos de remessa no Open Banking.


== Protesto e Negativação ==

Os comandos “Protestar” e “Negativar” no Open Banking CIGAM são parametrizadas no cadastro do portador através do combo box abaixo:

[[Arquivo:Protestar e Negativar redimensionado.png|centro]]

É possível selecionar apenas uma das opções (negativar ou protestar) e no campo ao lado é possível informar a quantidade de dias a ser utilizado como regra para o comando.


Além da parametrização do portador, é possível definir o tratamento de protesto e negativação individualmente para cada cliente através do campo “Negativar/Protestar”, disponível na guia Geral do cadastro de Empresas/Pessoas.


O campo possui as seguintes opções:


* Cfe. Portador: o título seguirá a parametrização de protesto ou negativação definida no cadastro do portador.
* Dispensar: o título não será enviado para protesto ou negativação, independentemente da parametrização definida no portador.


Dessa forma, é possível utilizar a mesma parametrização de portador para diferentes clientes, permitindo que alguns sigam a regra definida no portador e outros sejam dispensados do procedimento.


'''IMPORTANTE:''' O CIGAM apenas envia a instrução de protesto/negativação no momento do registro do título. Os serviços de inclusão posterior, bem como a remoção do comando, se necessárias, precisam ser realizadas no gerenciador bancário.


'''IMPORTANTE 2:''' Podem existir regras de protesto e negativação específicas variando por banco, consulte a WIKI específica de cada um (na tabela de serviços disponíveis) para maiores informações.


== Configuração de bancos ==

No programa configuração de bancos, existe um tooltip que aponta quais os bancos estão disponíveis na sua versão do CIGAM:

[[Image:Tooltip Configuracao de Bancos.png|center]]


É no programa de configuração de bancos, dentro do botão “Open Banking” que serão informados os dados de credenciais, ambientes e serviços que serão utilizados via API para aquela instituição.


'''No primeiro acesso ao botão open banking, será chamado o assistente de configurações''' onde o usuário será acompanhado passo a passo no preenchimento das informações necessárias.


== Tela de parâmetros Open Banking ==

Caso você já possua uma parametrização open banking para o banco que você está entrando, a tela de parâmetros será aberta, aqui será possível visualizar os dados atuais parametrizados para o banco. Abaixo seguem as informações gerais de cada área da tela de parâmetros Open banking.

[[Image:Parametros Open Banking 221107_v2.png|center]]

=== [[Image:Icon Credenciais.png|top]] Botão “Credenciais” ===

A tela de credenciais apresentada poderá ter entre uma e duas abas. Conforme o banco, poderá existir uma aba para cada ambiente entre homologação e produção com credenciais distintas. Mas também existem bancos apenas com ambiente de produção, sem possibilidade de testes em ambiente de homologação; e ainda, aqueles que utilizam as mesmas credenciais para ambos, homologação e produção tendo o apontamento do ambiente como um combo em tela.

[[Image:Parametros Botao Credenciais.png|centro]]

Aqui são visualizadas todas as informações relacionadas às credenciais open banking do banco que se está pesquisando. As informações contidas aqui variam de acordo com a instituição e normalmente contém as credenciais (Client_secret e Client_ID), certificado digital (quando aplicável), versão da API que está sendo utilizada e dados de escopo (que são os serviços atendidos por aquelas credenciais).


As informações mais sensíveis estão protegidas por '''criptografia''' (representada pelo cadeado azul à direita) e não possuem nenhuma possibilidade de visualização. A partir do momento em que as informações são inseridas, o CIGAM as criptografa tanto em ambiente runtime quanto no banco de dados. A única forma de validar se as credenciais estão iguais às que você possui fora do CIGAM é através do botão [[Image:Icon Cadeado.png|top]], onde você pode reinseri-las e clicar em “validar”, caso estejam de acordo com os dados previamente gravados, será emitida uma mensagem confirmando.


[[Image:Criptografia Botao Credenciais.png|centro]]

[[Arquivo:Validacao Token Parametros v2.png|centro]]


Caso você queira utilizar um novo dado, basta inseri-lo e clicar em “confirmar”, o CIGAM irá checar novamente se é isso que você deseja fazer e substituir o dado antigo pelo novo.

[[Image:Alterar dado criptografado.png|centro]]

Ainda é possível remover uma credencial previamente informada através do botão “Excluir”:

[[Arquivo:Excluir dado criptografado.png|centro]]

=== Usuário de Alerta (alerta de vencimento de certificado digital) ===

Algumas instituições utilizam certificados digitais na composição e validação das credenciais das suas APIs open banking. Estes certificados por sua vez são vinculados às credenciais, desta forma, quando do seu vencimento, a sua substituição precisa ser realizada tanto no sistema interno do cliente quanto na instituição financeira. Ao utilizar o campo “usuário para alerta”, o CIGAM irá gerar uma mensagem para o usuário informado para alertá-lo a partir de 30 dias faltantes para o seu vencimento.


[[Arquivo:Parametros Open Banking Usuario Alerta.png|centro]]

[[Arquivo:Alerta Certificado.png|centro]]


'''OBS:''' caso nenhum usuário seja informado no momento da parametrização, será criado um alerta para qualquer usuário que utilizar uma funcionalidade open banking no período que anteceder 30 dias do vencimento do certificado.


=== [[Image:Icon_Enderecos.png|top]] Botão “Endereços” ===

Neste botão estão localizados os endereços de comunicação com as APIs bancárias do CIGAM para cada banco. Elas são geridas pela equipe de desenvolvimento CIGAM e não possuem possibilidade de alteração pelo usuário comum.

'''IMPORTANTE:''' Alguns bancos não fazem mais uso destas URL's, estando elas informadas diretamente nas informações de credenciamento nas parametrizações do Open Banking. Os bancos que ainda fazem uso das URL's do botão Endereços são os Banco do Brasil e Bradesco, que não possuem dados de URL's nas suas parametrizações.

[[Arquivo:Dados Endereco OB.png|centro]]

=== Abas Cobrança e Pagamento ===

Atualmente possuímos as abas Cobrança e Pagamento para configuração dos portadores destas APIs em separado, porém ainda não possuímos a função pagamento, desta forma ela ainda não está em uso e todas as informações contidas nesta sessão são relativas ao serviço de Cobrança. Inclusive a aba Pagamento foi removida a partir da versão 221107 e será novamente adicionada quando a funcionalidade for desenvolvida.


=== Grupo Convênios e Portadores ===

O grupo “convênios” pode ter N registros conforme o cliente os possuir, é comum que haja um convenio de cobrança e um convenio de pagamento em um cliente, porém pode ocorrer de haver mais de um convenio para um mesmo serviço de cobrança, por exemplo. O conteúdo do convenio é determinado durante a parametrização (no assistente do open banking) onde o usuário pode escolher apontar um convenio (localizado pelo CIGAM dentro do universo de portadores do banco que se está configurando), ou “pular” esta etapa. Se selecionado, será criada uma linha com aquele convenio selecionado, caso pulado, será criada uma linha com a informação “Geral”.

[[Arquivo:Convenios de Cobranca Pular.png|centro]]

Neste exemplo, foi localizado o convenio 946278214 dentre os portadores cadastrados para o banco SICREDI (746). Caso o usuário clique em “avançar”, os parâmetros Open Banking serão criados em uma linha com este convenio, caso seja selecionado o botão “pular”, a parametrização será criada como “Geral”.


Sempre que o Banco não especificar um convênio, sugerimos que esta etapa seja pulada para que as credenciais sejam criadas como “Geral”.

[[Arquivo:Parametros Open Banking Geral.png|centro]]

O grupo “Portadores” está amarrado ao grupo “Convênios”, ou seja, pode existir mais de uma linha de portadores para um mesmo convênio, essa situação é gerada quando o cliente possui mais de uma conta corrente que realiza cobranças.

[[Arquivo:Multiplos Portadores Parametros Open Banking.png|centro]]

No campo “Portador” está indicado o portador de registro a ser utilizado no registro dos boletos deste convenio, já o campo “Portador de Retorno” será trazido como sugestão de portador de liquidação na rotina de retorno open banking para os bancos que possuírem este serviço.


Aqui também existem alguns parâmetros relacionados ao comportamento do CIGAM como: “Direto” para que o registro seja feito diretamente na impressão do boleto; e “PIX” que irá indicar que os títulos registrados devem também registrar uma operação PIX e imprimi-la no boleto (atualmente disponível apenas no Banco do Brasil, Itaú e SICOOB). Já o campo “U.N. Ced” funciona como Empresa cedente na API de cobrança do Itaú. Maiores detalhes podem ser encontrados no manual Open Banking de cada banco.


=== Botão “Validar” ===

O botão validar permite consistir as credenciais atualmente informadas no convenio em que se está posicionado:

[[Arquivo:Botao Validar Parametros Geral.png|centro]]

Esta consulta, além de apresentar o resultado da tentativa de conexão em cada ambiente e nos serviços disponíveis para cada banco, também retorna o seu escopo de serviços das credenciais informadas. As informações apresentadas variam por banco.

[[Arquivo:Tela Valida Credenciais.png|centro]]
 

'''Os retornos possíveis serão:'''


* '''Conexão realizada com sucesso: '''As credenciais informadas conseguiram conectar no ambiente e serviços para os quais eles foram informados.

[[Arquivo:Conexao Realizada com Sucesso.png|centro]]
 

* '''Credenciais não fornecidas: '''O CIGAM não realizou o teste de conexão para esta API/Ambiente pois não foram informados dados de credencial.

[[Arquivo:Credenciais nao fornecidas v2.png|centro]]
 

* '''Erro de Conexão: '''Existe erro nas credenciais informadas. Confirme se estas credenciais são compatíveis com o escopo (API) ou ambiente (Homologação/Produção) que deseja configurar.

[[Arquivo:Erro na Conexao.png|centro]]

==== ''Botão Resposta API'' ====

Já o botão “Resposta API” apresenta especificamente a consulta feita pelo CIGAM, este dado é importante para avaliações dos setores de suporte e desenvolvimento da CIGAM.

[[Arquivo:Botao Resposta API.png|centro]]

=== Como excluir uma parametrização Open Banking ===

Por fim, cada grupo “Convenio” possui um conjunto de credenciais para si, ou seja, cada linha de convênio parametrizada terá credenciais específicas, desta forma, caso seja desejo '''EXCLUIR''' uma parametrização open banking, basta teclar F3 sobre o convênio desejado, com isso serão excluídos todos os registros de credenciais e portador vinculados a ele.


=== Como criar uma parametrização Open banking adicional para um mesmo Banco ===

É comum um mesmo banco possuir credenciais diferentes para mais de uma conta, neste caso, haverá mais de uma linha de convenio (A e B) ou até mesmo Geral + convenio específico. Neste caso, após realizar a primeira parametrização através do assistente, você poderá teclar “Ctrl+I” para invocar novamente o assistente e realizar a nova parametrização de dentro da tela “Parâmetros Open Banking”. Abaixo um exemplo:

[[Arquivo:Ctrl I Parametros Open Banking.png|centro]]

A primeira linha “Geral” valerá para qualquer convênio, menos para os portadores do convênio “1285184” que usarão suas credenciais específicas.


=== Como adicionar um novo portador para uma mesma credencial ===

Caso você precise incluir um novo portador, seja uma nova conta corrente ou uma nova carteira que compartilhe credenciais de uma parametrização de open banking que já exista. Basta em modo modificar na linha de convênio existente e, no bloco “Portadores” criar uma linha nova indicando os portadores adicionais. Não é necessário invocar o assistente.

[[Arquivo:Incluir novo portador open banking.png|centro]]

= Assistente de configuração Open Banking =

Como mencionado anteriormente, o assistente de parametrização do Open Banking será disparado sempre que se clicar no botão “Open Banking” do cadastro de configuração de bancos que não possuírem parametrização prévia. Para os bancos com alguma parametrização já criada, ele é chamado através do comando criar (Ctrl+I).


'''NOTA AOS SETORES DE ATENDIMENTO E IMPLEMENTAÇÃO CIGAM: '''Conforme mencionado no item [[#Obtenção de credenciais - Instruções Gerais | Obtenção de credenciais]] deste manual, independentemente do banco que você estiver configurando, antes de iniciar o processo de implementação, é imprescindível ter os dados de credenciais, certificados digitais, scopes etc em mãos, a primeira página do assistente open banking irá indicar as informações necessárias. Caso esteja em dúvida, consulte a sessão correspondente à obtenção de credenciais do banco que você está querendo configurar. Recomendamos que o trabalho de implementação/atendimento só seja iniciado após a confirmação da existência de tais dados uma vez que não está dentro das nossas possibilidades obter tais informações.


= Funcionalidades Open Banking =

Neste bloco iremos apresentar todos os processos existentes no Open Banking CIGAM. '''É importante destacar que o Open Banking CIGAM está disponível apenas na versão 11 e a partir das versões 201103.RC.'''

== Registro de cobrança ==

O registro de cobrança é a funcionalidade principal das APIs bancárias atuais, praticamente todas as instituições iniciam a sua jornada na liberação de APIs através dela. O escopo de funcionalidades varia desde APIs que apenas '''registram''' o título até aquelas que '''registram/alteram/capturam '''o retorno do título.


Se formos traçar um paralelo com o CNAB, o método de registro da API de Cobrança realiza todos os movimentos que um CNAB de cobrança realiza, ou seja, é o método utilizado para registrar um título e obter o resultado “ENTRADA CONFIRMADA”. Uma vez registrados, ainda temos a função “N comandos” do CNAB, que era utilizada para interagir com os títulos já registrados, em algumas APIs já é possível realizar alterações de vencimento, valor de juros e multa, baixa de títulos etc. Também é comum apenas a API de registro ser liberada sem o método de retorno,  nestes casos, o CNAB ainda é utilizado para realizar a consulta e liquidação dos títulos.


== Visão Geral ==

Para realizar o registro de um título, primeiro você precisa ter o seu banco parametrizado com o uso das credenciais conforme descrito no item [[#Obtenção de credenciais - Instruções Gerais | Obtenção de credenciais]] deste manual. A partir deste momento você estará apto a registrar títulos nesta instituição.


Sempre que um lançamento for criado utilizando um portador parametrizado para o Open Banking CIGAM, ele apresentará a legenda “Situação Open Banking” no grupo “Dados Bancários”, conforme apresentado na imagem abaixo:


[[Arquivo:Titulo Nao Registrado Open Banking atualizado.png|centro]]

== Status Open Banking para o método de cobrança ==

* '''Não Registrado:''' título recém-criado e não enviado para a instituição financeira.


* '''Registrado: '''título registrado na instituição financeira via Open Banking.


* '''Erro: '''representa um título que teve uma tentativa de registro, porém recebeu retorno com inconsistência da API. Maiores informações na sessão de tratamento de erros.


* '''Alteração Pendente: '''título com alteração realizada no CIGAM, mas ainda não registrada no Banco.


* '''Liquidado: '''título liquidado via API de retorno.


* '''Baixado: '''registrado via API de cobrança e baixado através do comando de baixa da API.


== Menu lateral Open Banking ==

Nos lançamentos pertencentes ao escopo da API de cobrança, está habilitado um novo menu de mesmo nome, abaixo segue um descritivo básico de cada uma das opções:


[[Arquivo:Menu Lateral Open Banking atualizado.png|centro]]

* '''Registrar: '''É o botão responsável por registrar um boleto na instituição financeira. Existem outras formas de realizar o registro, esta é a mais básica, as demais serão descritas mais a frente neste documento. Regras para habilitar o botão:
<ul>
* Possuir portador de Open Banking;
* Tipo do lançamento igual a 'Receber';
* Boleto impresso;
* Número no Banco preenchido;
* Lançamento diferente de Previsão;
* Tela em modo diferente de 'Criar';
* Boleto Impresso marcado;
* Status Open Banking igual a 'Não Enviado'.

</ul>

* '''Reenviar:''' Habilitado somente para lançamentos com a situação open banking igual a “Erro”, serve para realizar uma nova tentativa de registro em um título que esteja divergente.


* '''Baixar:''' Habilitado somente para lançamentos com a situação open banking igual a “Registrado”, serve para enviar o comando de baixa do título, após a sua execução, é possível realizar um novo registro. Maiores detalhes na sessão que descreve este processo.


* '''Registrar alteração: '''Habilitado apenas em títulos com o status “alteração pendente”, serve para registrar alterações realizadas em títulos previamente registrados. O tipo de alteração possível depende do escopo da API de cada banco.


* '''Histórico: '''Local onde são registradas todas as interações e tentativas de interação do ERP CIGAM com o Banco. A cada ação de comunicação com a API bancária para aquele lançamento, o CIGAM irá criar uma linha de histórico com data, hora e dados de usuário que realizou a ação, o log é incrementado da ação mais nova para a mais antiga.


[[Arquivo:Histórico Open Banking.png|centro]]


Abaixo serão descritos os campos “Ação” e “Status Open Banking”, eles representam respectivamente a comunicação CIGAM vs o retorno do Banco instituição financeira.


<center>
{| class="wikitable"
|-
! Ação (CIGAM) !! Status Open Banking (banco ou instituição)
|-
| '''Registrar:''' comunicação do CIGAM no momento da tentativa de registro do título. Em um paralelo com o CNAB, é a ação que representa o upload de um arquivo de remessa. || '''Registrado:''' resultado positivo para uma tentativa da ação CIGAM “Registrar”.
 
'''ERRO:''' resultado negativo para a ação “Registrar”.
|-
| '''Consultar:''' comunicação do CIGAM para obter informações daquele título, a rotina de retorno Open Banking sempre irá gerar um registro deste tipo. Dependendo dos filtros da rotina de retorno, a consulta pode resultar em uma liquidação, conforme abaixo. No modelo CNAB, esta seria a representação da importação de um arquivo de retorno. || '''Consulta:''' resultado positivo para uma tentativa da ação CIGAM “Consultar”.
|-
| '''Alterar:''' representa a ação de interação com o título já registrado, as possibilidades de alteração dependem do escopo da API da instituição com que se estiver trabalhando, as alterações mais comuns são de vencimento, juros e multa. Consulte os descritivos de cada banco para verificar as alterações possíveis. || '''Alterado:''' resultado positivo para uma tentativa da ação CIGAM “Alterar”. '''ERRO:''' resultado negativo para a ação “Alterar”.
|-
| '''Liquidar:''' Caso a consulta realizada retorne que o título está liquidado e o filtro da rotina de retorno esteja apontando para “Liquidar”, será criada uma linha com esta ação, liquidando o título. || '''Liquidado:''' resultado positivo para uma tentativa da ação CIGAM “Liquidar”. '''ERRO:''' resultado negativo para a ação “Alterar”.
|-
| '''Baixar:''' Ação utilizada para registrar a solicitação de baixa de um título. || '''Baixado:''' resultado positivo para uma tentativa da ação CIGAM “Baixar”. '''ERRO:''' resultado negativo para a ação “Baixar”.
|-
|}
</center>

'''Erro:''' resultado negativo para qualquer uma das ações CIGAM. Este status Open Banking será apresentado sempre que houver algum problema na ação que se deseja registrar. A solução para cada caso irá variar conforme a situação. O CIGAM possui um cadastro de sugestões para a solução dos erros já mapeados (conforme imagem abaixo) que podem ser utilizadas como guia para a sua resolução.


[[Arquivo:Erro Open Banking Historico.png|centro]]


Para uma nova tentativa após ajuste de uma situação de erro, existem duas possibilidades:


# Clicar no botão “Reenviar” no grupo “Open Banking” do menu lateral do lançamento financeiro
# Executar a rotina de remessa open banking utilizando um filtro que contemple o lançamento em questão. Caso a situação seja sanada, o registro acontecerá normalmente.

Maiores informações sobre o processo de mensagens de APIs financeiras podem ser encontradas na sessão específica deste manual no final desta sessão.



'''Altera Situação: '''Este campo do tipo “Checkbox” é marcado automaticamente pelo CIGAM sempre que o retorno da API open banking refletir em uma ação que altere o lançamento financeiro do CIGAM, seja uma liquidação ou uma baixa.


'''Comando: '''Este campo é uma identificação da API e é representado pelos códigos:


* 00 – Não Registrado


* 01 – Registrado


* 02 – Alterado


* 03 – Baixado


* 04 – Liquidado


* 06 – Consulta


* 07 – Erro



'''IMPORTANTE: '''Não confundir este campo comando com os “Comandos de remessa”, do lançamento financeiro e do cadastro de portador, estes serão explicados mais a frente e permanecem conforme as suas funções existentes.



'''Sequência: '''representa a sequência deste registro da tabela de log de histórico open banking.



'''U.N.: '''representa a Unidade de Negócio utilizada para a criação deste registro.



'''Usuário: '''usuário logado no sistema e responsável pela execução da ação.



'''Dados API: '''Todas as ações/status open banking possuirão um arquivo de remessa e retorno referentes à comunicação gerada entre CIGAM e Banco, estes arquivos contém os dados de todas as informações trocadas em um formato chamado “JSON”. Traçando um paralelo com o CNAB, este é o substituto do arquivo txt que era enviado e baixado no gerenciador bancário. Os dados de envio do JSON de cada interação estão disponíveis no botão da coluna “Dados API”:


[[Arquivo:Botao Dados API Historico OB.png|centro]]


Exemplo de JSON de registro (envio e retorno) de um título no Banco:


[[Arquivo:Exemplo JSON Envio OB.png|centro]]

== Botão “Copiar” ==

O Botão “Copiar” permite selecionar a totalidade do conteúdo dos arquivos JSON e copiá-los para o clipboard do Windows, desta forma, caso seja necessário enviar este conteúdo para um outro destinatário (suporte/implementação) basta teclar “Ctrl+v” em um editor de texto:

[[Arquivo:Botao Copiar Historico OB.png|centro]]
 
[[Arquivo:Mensagem Botao Copiar Historico OB.png|centro]]
 

'''Auditoria: '''conforme mencionado no item [[#Configuração do portador|Configuração do portador]] deste manual, os portadores utilizados no open banking devem possuir a opção “auditoria” selecionada com a opção “detalhado”, isso irá permitir o registro de todas as alterações do título em questão. Isso também permitirá clicar no botão “auditoria” do histórico open banking, o que permitirá identificar todas as informações daquele lançamento, bem como data, hora e usuário que realizou a alteração.


[[Arquivo:Pesquisa Auditoria OB.png|centro]]


As alterações são registradas da mais atual para a mais antiga.


== Pesquisa dinâmica de Lançamentos ==

A pesquisa dinâmica de lançamentos possui um filtro relativo à situação Open Banking do lançamento:


[[Arquivo:Pesquisa Dinamica OB.png|centro]]

== Mensagens de erro Open Banking ==

As mensagens open banking possuem um cadastro salvo em gestão financeira>parâmetros>Mensagem de Retorno de APIs financeiras. Este cadastro visa auxiliar o usuário na obtenção de informações acerca da resolução de situações de erro obtidas na comunicação das APIs do módulo financeiro, não somente ao Open Banking, mas também às APIs do PIX.


[[Arquivo:Mensagem de Retorno API Financeiro 2.png|centro]]


As mensagens estão distribuídas por banco, código de erro, status de retorno, descrição dada pelo banco, sugestão CIGAM, que é uma dica da equipe CIGAM em como resolver tal problema e por fim uma coluna de sugestão do cliente, que pode ser informada com as próprias interpretações dos usuários para solucionar aqueles casos.



A tabela é periodicamente atualizada pela equipe CIGAM e pode ser atualizada no cliente através do botão [[Image:Botao Refresh v2.png|top]]. Outra funcionalidade importante é que a tabela de erros do cliente é incrementada conforme as mensagens são recebidas, ou seja, caso o banco retorne uma mensagem que ainda não havia sido recebida ou contida na tabela, ela será inserida automaticamente, o que resulta em uma tabela sempre crescente e sem a possibilidade de apresentar um “erro desconhecido”.



As mensagens da API são apresentadas imediatamente no momento da recepção do erro e podem ser visualizadas novamente sempre que se clicar na palavra “erro” na situação open banking do lançamento ou dentro do botão histórico open banking.



[[Arquivo:Situacao Open Banking Historico atualizado.png|centro]]

=== Cadastro de mensagens de erro Open Banking ===

Qualquer pessoa poderá cadastrar uma mensagem de alerta/erro com texto mais amigável a fim de auxiliar os demais usuários em erros já conhecidos no registro do Open Banking. Para tanto, basta entrar no cadastro de mensagens, localizar a mensagem do banco que deseja inserir a sugestão e informar o texto no campo “Sugestão Cliente”:


[[Arquivo:Cadastro de Mensagem de Erro Open Banking.png|centro]]


Pronto! Na próxima vez que a mensagem de erro aparecer, o usuário logado irá visualizar a dica para a solução da situação.


= Registrando títulos =

Existem duas formas de realizar o registro de títulos open banking, um é realizado pelo movimento em que se está (lançamento, nota fiscal, contrato etc.), chamado de direto. A outra é pela rotina de remessa específica, chamado de indireto, ambos serão demonstrados abaixo.


'''IMPORTANTE: '''para a rotina de registro open banking não há distinção entre bancos, todos seguem o mesmo formato, isso significa que as próximas informações valem para qualquer banco ou instituição que possua API de registro no CIGAM.


== Registro do boleto de cobrança nas modalidades Direto ou indireto ==

A depender da opção “Direto” estar marcada nos parâmetros Open Banking, o CIGAM irá se comportar de formas distintas. Com a opção '''marcada''', o CIGAM irá realizar o registro do título na '''impressão '''do boleto. Com esta opção '''desmarcada''', o registro será feito apenas quando da execução da rotina “Remessa de cobranças Open Banking”.


[[Arquivo:Checkbox Direto Parametros Open Banking.png|centro]]

== Operação com a opção Registro Direto marcada ==

Este formato de uso é o mais recorrente em nossos clientes e é o formato de implementação sugerido, onde no momento do envio e confirmação da NFe o boleto já é registrado imediatamente. Esta é a opção necessária a ser utilizada juntamente com a opção “PIX”, no qual será impresso o QR Code para pagamento PIX.


Um título que que possua a opção “Direto” marcada será registrado nas seguintes situações:


# No cadastro de lançamento avulso ao clicar em “imprimir boleto”;
# Na confirmação da NFe/NFSe (caso parametrizada para envio de boleto);
# Na rotina de impressão de boletos em lote;


== Operação com a opção Registro Direto desmarcada ==

A opção “Registro direto” é utilizada desmarcada apenas em alguns casos específicos, por exemplo, quando o cliente possui um processo de conferência das notas fiscais após a sua geração e onde pode ocorrer alguma alteração de valores ou até mesmo um cancelamento da nota. Ao deixar a opção desmarcada, os boletos não serão registrados imediatamente na confirmação da nota.



Um título que possua a opção “Direto” desmarcada será registrado apenas na execução da rotina “Remessa de Cobrança Open Banking” (executada após a ter ocorrido a impressão do boleto).



Idealmente, neste formato, sugerimos que o boleto '''não''' seja parametrizado para envio pela NFe, já que, além de não estar registrado até que o seu registro seja feito pela rotina de “Remessa de cobrança Open Banking”, caso o banco que está sendo utilizado possua a opção de QR Code PIX no boleto, a operação PIX somente é gerada no momento do registro do boleto. Imprimir um boleto sem registro, embora seja possível, irá resultar em um boleto sem QR Code PIX.


== QR Code no Boleto ==

Alguns bancos disponibilizam juntamente com o serviço de registro de cobrança a possibilidade de criar uma Operação PIX de mesmo valor atrelada ao título que se está registrando. Esse registro possibilita mais uma forma de pagamento ao cliente que poderá pagar tanto pelo código de barras do boleto quanto pelo QR Code da operação PIX. Cada banco possui uma forma de lidar com estes registros, seja baixando automaticamente o boleto quando do pagamento do PIX ou cancelando-os. Consulte a área de open banking de cada uma das instituições para entender como cada uma gere estas transações.



No CIGAM a forma de se parametrizar uma operação PIX (QR Code no boleto) é sempre a mesma, deve ser marcada a opção “PIX” ao lado da opção “direto” no assistente de parametrização ou na tela de parâmetros open banking e utilizar um modelo de boleto padrão com QR Code ou adicionar a variável '''qrcode_pix''' (<!$MG_qrcode_pix>) ao seu modelo de boleto personalizado.


=== Chave PIX do QR Code no boleto ===

A Chave PIX utilizada no boleto varia conforme o Banco, porém atualmente existem duas origens possíveis:



No cadastro do portador de remessa (botão parâmetros PIX):


[[Arquivo:Chave Pix Open Banking Portador.png|centro]]


Ela será enviada no JSON dessa forma:


[[Arquivo:Dados Qrcode JSON Envio OB v2.png|centro]]


Ou será utilizada automaticamente a chave PIX da conta vinculada ao convênio do boleto, neste caso não é enviada chave no JSON, apenas a indicação de que há ou não PIX no boleto.


[[Arquivo:Indicador Pix JSON OB.png|centro]]

'''Manuais Referenciados:'''
*[[Open Banking - Não está imprimindo QR Code no meu boleto]]


== Rotina de Remessa Open Banking (via menu) ==

O registro de títulos open banking via menu é utilizada principalmente pelos clientes que optarem em não utilizar a opção “Direto” para os seus títulos.



''Menu: Gestão Financeira > Rotinas > Operacionais > Open banking > Remessa de cobrança Open Banking''



Ao utilizar a rotina de remessa via menu, os filtros a serem utilizados devem ser aqueles que sejam suficientes para localizar a todos os títulos que ainda não tenham sido registrados. Assim como nas remessas CNAB, uma boa ideia de filtro são todos os títulos com data de emissão inicial igual a 00/00/0000 até a data atual.


[[Arquivo:Remessa de Cobranca Open Banking v2.png|centro]]

== Condição para um lançamento ser registrado/apresentado na remessa open banking (avulso ou em lote) ==

Ao executar a rotina, serão registrados todos os títulos a receber com:

# situação “open banking = Não registrado”;
# com número no banco;
# opção “boleto impresso” marcada;
# opção “remessa enviada” desmarcada;
# que estiverem contemplados dentro dos filtros informados;
# Ela também serve para realizar o registro de alterações de títulos com Situação Open Banking = “Alteração Pendente” onde eles também serão enviados para registro da sua alteração.



Ao final, será apresentado o relatório com a situação de cada um dos títulos e seus retornos.


== Relatório de remessa bancária ==

O relatório de remessa bancária será impresso sempre que um registro avulso (direto pela tela de lançamentos) for feito ou como resultado da execução da rotina de Remessa Bancária On Line. As suas variáveis estão contidas no arquivo salvo em:


I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\RF00071_remessas.RTF 


Este modelo serve tanto para remessa quanto para retorno on line e é apresentado da seguinte forma:


[[Arquivo:Relatorio Remessa Bancaria.png|centro]]

== Rotina de Retorno Open Banking ==

O retorno de cobrança open banking, ao contrário do registro, é específico para cada instituição, eles serão apresentados banco a banco nesta sessão:



O retorno on line pelo Open Banking CIGAM vem para substituir o arquivo CNAB de retorno e é responsável por consultar e atualizar os títulos registrados na instituição bancária. Desta forma, o CIGAM está sempre atualizado com o seu banco. Este bloco do manual estará dividido diretamente por banco, uma vez que cada um possui uma forma de tratamento em seu retorno.



''Menu: Gestão Financeira>rotinas>operacionais>open banking>Retorno de cobrança open banking.''



A rotina de retorno é única para todos os bancos do escopo open banking e varia os seus parâmetros de filtros (na aba filtros) conforme o banco apontado no portador informado no filtro “portador”, para auxiliar na execução da rotina existe um botão “aqui” no texto “Para mais informações a respeito dos filtros, clique aqui”. Já a aba “parâmetros” segue a mesma regra para todos os bancos e utiliza funções herdadas da rotina de retorno de CNAB de cobrança conforme abaixo:


[[Arquivo:Portador Retorno de Cobranca Open Banking.png|centro]]


'''Tipo de 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 os contabilizar 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 - tag "dataRecebimentoTitulo") 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 - tag "dataCreditoLiquidacao") 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 alterá-la ou quando zerada habilita para buscar automaticamente a Data de Ocorrência ou Crédito.



'''Gerar acompanhamento das ocorrências bancárias: '''Esta opção é utilizada para descrever os dados de valores do título advindo do banco no retorno da ação de “liquidar” abertos por Valor, Juros, multa, desconto por tarifa, desconto e outros recebimentos.


=== Regras de Busca do Sistema para localizar títulos no retorno ===

O sistema tenta localizar os títulos pelo Número do Lançamento;



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''';



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''';



Quando o retorno de títulos for feito com o checkbox <ref group="Versão 251103.b">Liberado a partir da OS 961263/9.</ref>"Processar títulos não gerados pelo CIGAM" marcado, o sistema passa a priorizar a busca de títulos pelo Nosso Número. Essa opção deve ser utilizada quando os títulos não forem emitidos pelo CIGAM.


=== Retorno de cobrança via CNAB (bancos que ainda não possuem método para retorno) ===

O projeto open banking varia de instituição para instituição, é comum que um banco libere apenas a API de registro no seu projeto open banking. Nestes casos, você pode continuar realizando os retornos via CNAB configurável, nos mesmos moldes já utilizados. Ele é uma forma de consulta válida e que atende os requisitos da funcionalidade, porém fique atendo e em contato com a sua instituição e às atualizações do CIGAM, a qualquer momento o retorno bancário de cobrança poderá ser liberado e você poderá migrar para o Retorno de cobrança On Line.


==Endereço do Cliente==

Para registro do boleto, será utilizado o endereço principal do cliente, aquele informado na guia '''Empresa''' do cadastro do cliente informado no campo Cobrança do Lançamento Financeiro.

Não há tratativa para avaliação de múltiplos endereços de cobrança, neste caso, não valida a ordem do endereço informada no lançamento financeiro.

= Alterações de títulos registrados Via Open Banking =

As APIs de registro também são responsáveis por realizar alterações nos títulos existentes na instituição. A seguir serão apresentados os serviços de alteração disponíveis no CIGAM de forma geral, todos os bancos possuem o mesmo tratamento para todas as funções apresentadas. Basta avaliar se o banco que você está utilizando possui tal funcionalidade.


== Alteração de Juros, Multa e vencimento ==

Aqui, a maior diferença entre o CNAB e o Open Banking CIGAM é a de que, embora as duas metodologias utilizem o cadastro de comandos para realizar as três alterações mais comuns em títulos (Juros, Multa e Vencimento), o Open Banking irá funcionar mesmo que não haja um comando cadastrado para tanto. Nestes casos, eles serão criados automaticamente.


=== Regra Sistema para Vencimento, Multa ou Juros ===

O 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, Juros e Vencimento, o sistema cria automaticamente (Somente Juros, Multa e Vencimento).


Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo Multa, Juros ou vencimento, automaticamente após alteração da Multa, o Sistema irá criar essa parametrização do Comando de Remessa como sugestão (caso não haja um comando do tipo necessário), 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''' = ATJ
* '''Descrição''' = ALTERAÇÃO DE JUROS PARA OPEN BANKING
* '''Tipo de Comando''' = Alteração de Juros



'''Comando sugestão para troca de vencimento:'''


* '''Código Operação''' = ATV
* '''Comando''' = ATV
* '''Descrição''' = ALTERAÇÃO DE VENCIMENTO PARA OPEN BANKING
* '''Tipo de Comando''' = Alteração de vencimento


[[Arquivo:Comandos de Alteracao Open Banking.png|centro]]


A alteração destes 3 campos é enviada sempre que um título previamente registrado receber alguma alteração. Lembrando que para juros e multa, os campos enviados são sempre em valor, nunca em percentual. Isso auxilia
o cálculo de juros/multa ao dia simulado pelo CIGAM em locais como o portal do cliente – área financeira.



[[Arquivo:Alteracao Vencimento Open Banking alterado.png|centro]]

[[Arquivo:Alteracao Multa e Juros Open Banking.png|centro]]


Depois de realizar as alterações, elas serão enviadas de forma agrupada para o banco, bastando que seja salva a informação através do comando CTRL+Q ou clicando na opção “Registrar alteração” do menu lateral do grupo open banking do lançamento.



Veja que a situação open banking de um título que ainda não tenha tido a sua alteração registrada no banco fica como “Alteração pendente e o comando de remessa é preenchido. Outro ponto importante é que o comando de remessa para cada um dos tipos de alteração é utilizado conforme a sua existência no botão “comandos” do cadastro de portador. Caso ele não exista previamente, ele é criado de forma automática conforme apresentado na sessão de cadastros de portador deste manual.



[[Arquivo:Confirmar Envio de Alteracao ao Banco Open Banking atualizado.png|centro]]


Ao confirmar a mensagem acima, a alteração será processada e a situação do título, caso não ocorra nenhum erro, volta a ficar como registrada e tudo é gravado no histórico open banking:



[[Arquivo:Alteracao Concluida Open Banking atualizado.png|centro]]

=== Não escopo dos serviços de alteração ===

Alguns pontos ainda não estão tratados neste manual, por exemplo, alteração de desconto até o vencimento, endereços, etc.


== Baixa de títulos ==

A baixa de títulos serve para retirar o título do registro bancário, ela só está habilitada para um título com a situação “Registrado” e ao final do processo, o título terá todas as informações relativas à sua caracterização prévia (nosso número, número no banco etc) removidas. Isso possibilita realizar o registro do título novamente.


'''Observação: Para Baixar, não é necessário o cadastro de comando de remessa no Portador.'''


[[Arquivo:Botao Baixar Open Banking atualizado.png|centro]]


[[Arquivo:Titulo Baixado Open Banking atualizado.png|centro]]

[[Arquivo:Baixa Historico Open Banking.png|centro]]

=== Não escopo do serviço de baixa ===

Atualmente quando uma nota é cancelada, por exemplo, não é enviado o comando de baixa para o banco, portanto o processo sugerido é que primeiro seja realizado o processo de baixa unitário pela tela do lançamento financeiro e após proceder com o cancelamento.



Sugerimos cautela no uso de rotinas que realizem manutenção de lançamentos em lote como “Pagamentos/Recebimentos” e “Manutenção de Lotes” que realizam a troca de portadores de lançamentos financeiros. O motivo é que caso os portadores de lançamentos registrados via open banking tenham seus dados alterados, a informação do registro no CIGAM irá se perder. Embora haja mensagens de alerta para comunicar o usuário deste risco, ainda é possível realizar a confirmação das alterações.


== Abatimento de títulos ==

<ref group="Versão 251103">Liberado a partir da OS 816297/7.</ref>O abatimento é uma operação que permite reduzir parcialmente o valor de um título já registrado no banco. Quando um abatimento é registrado no Cigam, o sistema envia automaticamente a instrução para o banco por meio da integração de Open Banking, garantindo que o valor atualizado do boleto seja refletido tanto no ERP quanto na instituição financeira.


O abatimento ocorre quando o cliente decide reduzir (“perdoar”) parte do valor de um título registrado.
Exemplo:


* Valor original do título: R$ 100,00
* Valor do abatimento: R$ 20,00
* Novo valor do título no banco: R$ 80,00


Além disso, também será possível realizar o cancelamento do abatimento, retornando o título ao valor original.


=== Registro de abatimento ===

Para que o CIGAM reconheça automaticamente uma liquidação como abatimento, foi criado o novo tipo de controle "Abatimento" no cadastro do Portador:

[[Arquivo:Open Banking Geral 0002.png|centro]]

Sempre que uma liquidação for realizada utilizando um portador desse tipo, o CIGAM entenderá que se trata de um abatimento e registrará o comando correspondente no Open Banking automaticamente.


O abatimento pode ser registrado de duas formas:


* Diretamente na tela do lançamento financeiro, através de uma liquidação utilizando um portador de abatimento.
* Através da rotina de Devolução de Saídas, utilizando o portador de abatimento na liquidação do saldo em aberto contra devolução.


Sempre que um abatimento for realizado, o sistema utilizará o comando de remessa "ATA", criado automaticamente pelo próprio sistema.


'''Bancos atendidos:''' Banco do Brasil, Itaú, SICOOB, Santander e Sicredi.


'''Observação:''' O SICOOB pode levar em torno de 40 minutos para processar o abatimento.


=== Cancelamento de abatimento ===

Quando uma liquidação registrada em um portador de abatimento é excluída, o CIGAM realiza a exclusão do lançamento e envia automaticamente ao banco o comando de cancelamento do abatimento. Esse cancelamento pode ocorrer de duas formas:


* Pela exclusão da liquidação diretamente na tela do lançamento financeiro.
* Pela exclusão da nota de devolução quando o abatimento tiver sido gerado por meio da rotina de Devolução de Saídas.


Caso ocorra algum erro no processo, a liquidação será excluída normalmente, porém o lançamento original permanecerá com o comando de remessa “ATA” pendente para registro posterior.


= Proteções no Lançamento =

Com o advento do Open Banking, faz-se necessário um maior controle dos lançamentos registrados nos bancos, se um título registrado via API tiver seu portador e/ou vencimento alterados por rotinas do CIGAM, correremos o risco destas alterações não serem refletidas nos bancos.


No contexto atual, onde teremos ainda clientes utilizando serviços mesclados em CNABs para alguns bancos e Open Banking para outros, precisamos ter tratamentos específicos para cada situação. Em algumas delas é utilizado o que já é feito nos CNABs e em outras, foram realizados novos tratamentos visando alertar o usuário em ações executadas no sentido de quebra de integridade entre o banco e o CIGAM, seja nas rotinas em lote ou unitariamente no lançamento financeiro.


== Grupo Dados Bancários ==

<ref group="Versão 231002">Liberado a partir da versão BETA 231002.</ref> A fim de iniciar o processo de proteção dos lançamentos financeiros registrados via Open Banking, os campos que possam descaracterizar um lançamento já registrado não poderão ser alterados, sendo eles:


* '''Número no Banco:''' Bloqueado
* '''Nosso Número:''' Bloqueado
* '''Boleto impresso:''' Bloqueado
* '''Remessa enviada:''' Bloqueado
* '''Código Barras Lido:''' Removido para lançamentos a receber
Estes bloqueios são válidos apenas para titulos registrados via open banking

[[Arquivo:Open Banking - Geral 001.png|centro]]

Deste modo a única forma de alterar os dados bancários de um lançamento será através da alteração do seu portador. Esta alteração poderá nos levar a duas situações, sendo a primeira aquela em que o novo portador mantém todos os dados do portador atual (ex: troca da carteira simples para a carteira descontada) ou a segunda onde o portador alterado é uma conta/banco diferente, cada caso será apresentado abaixo.


== Alteração de Portador ==

Atualmente os lançamentos registrados por Open Banking trabalham de forma similar ao CNAB, onde caso eles sejam modificados a nível de portador, também perderão seus vínculos com o banco. Porém, como nesta modalidade temos uma integração completa com a instituição, faz mais sentido que as alterações “finalizem” o processo de forma mais organizada, ou seja, se um lançamento for perder o seu vínculo com o banco por conta de uma troca de portador ou cancelamento de nota, por exemplo, que isso seja realizado junto ao banco também.


=== Validação dos dados de portador ===

Quando é realizado a troca do primeiro portador para o segundo portador, é avaliado se no segundo todos os campos verificados estão batendo com os do primeiro, sendo eles Banco, Conta, Agência e Convênio.

[[Arquivo:Open Banking - Geral 002.png|centro]]

Se esses campos corresponderem o lançamento terá o seu portador alterado. Para não perder o vínculo com o banco será mantido o histórico Open Banking no antigo portador.

[[Arquivo:Open Banking - Geral 003.png|centro]]
Caso contrário, se os portadores possuírem os campos validados distintos será exibida a seguinte mensagem:
[[Arquivo:Open Banking - Geral 004.png|centro]]

Clicando em "Detalhes" serão exibidos os dados validados dos dois portadores:

[[Arquivo:Open Banking - Geral 005.png|centro]]

Para realizar a troca será necessário definir se o título será baixado ou não, se '''Baixar Título''' o título será baixado no banco e estará pronto para atender ao novo portador, caso '''Continuar sem Baixar''' o vínculo anterior é quebrado e os dados do lançamento serão sobrescrito com o novo portador.


= Retenção P/C/C - PIS, COFINS, CSLL =

Para quem utiliza o recurso de Controlar Retenções na Saída, ou seja, configuração [[GF - GE - 2505 - Código de imposto para controlar retenção de CSLL na saída]], e deseja registrar o lançamento financeiro no valor líquido, já descontando as retenções, é necessário:
*Parametrizar a configuração [[GF - GE - 3214 - Diminuir valor das retenções do valor total do boleto]], como '''1 - Sempre''' ou '''2 - Por Empresa''', e
*Se a configuração estiver como '''2 - Por Empresa''', deve-se marcar as empresas desejadas no campo '''Descontar Retenção no Boleto'''.

Para mais informações de como funciona esse recurso, consulte a WIKI [[OS 816297/10 – Retenções P/C/C + Boletos + CNAB e Open Banking]].

Para informações sobre o uso do Controle das Retenções na Saída, consulte [[GF - Como Fazer - Controlar Retenções de PIS-COFINS-CSSL-IRRF-INSS-ISS para Nota Fiscal de Saída]].

= Documentos Relacionados =

* [[GF - Como Fazer - Open Banking para Banco do Brasil|Open Banking para Banco do Brasil]]
* [[GF - Como Fazer - Open Banking para Banco Itaú|Open Banking para Banco Itaú]]
* [[GF - Como Fazer - Open Banking para Banco SICOOB|Open Banking para Banco SICOOB]]
* [[GF - Como Fazer - Open Banking para Banco Bradesco|Open Banking para Banco Bradesco]]
* [[GF - Como Fazer - Open Banking para Banco Sicredi|Open Banking para Banco Sicredi]]
* [[GF - Como Fazer - Open Banking para Banco Santander|Open Banking para Banco Santander]]
* [http://ww2.cigam.com.br/mediawiki/index.php/FAQ_GF#Open_Banking FAQs - Open Banking]
*[[Open Banking - Em qual tabela fica gravado o registro do campo "Situação Open Banking" do lançamento financeiro]]
*[[Open Banking - O que é Endpoint, Request e Response?]]

= Versões =
== Versão 231002 ==
<references group="Versão 231002"/>

== Versão 251103 ==
<references group="Versão 251103"/>
=== Patch 'b' ===
<references group="Versão 251103.b"/>

== Versão 260601 ==
<references group="Versão 260601"/>
=== Patch 'b' ===
<references group="Versão 260601.b"/>