GF - Como Fazer - Open Banking para Banco 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  Manual Open Banking - Geral.

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 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:

• Portal do Desenvolvedor do Banrisul
• Documentação da API de Cobrança
• 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.

Assistente Open Banking - Banrisul

O acesso as parâmetros Open Banking serão realizados através do menu Finanças > Gestão Financeira > Parâmetros > 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 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.

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:

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 Como Fazer - Open Banking - Abatimento de títulos.

Cancelamento de abatimento

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

Documentos Relacionados

• Manual Open Banking - Geral
• FAQs - Open Banking