GF - Como Fazer - Open Banking para Banco Sicredi

De CIGAM WIKI


Objetivo

[editar]

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 SICREDI.

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

APIs disponíveis e serviços atendidos pelo CIGAM

[editar]

API Ecommerce

[editar]

Apenas para clientes implementados até junho de 2022.

Funcionalidade Versão
Registro de Cobrança Simples e vinculada 220404.BETA
Alteração de Vencimento 220404.BETA
Alteração de Juros e multa 220404.BETA
Baixa de título 220404.BETA
Negativação (Protesto não previsto para esta versão) 220404.BETA
Retorno de Cobrança Não tratados no CIGAM
Demais alterações (endereço, desconto por antecipação, abatimentos, etc) Não tratados no CIGAM
QR CODE no Boleto Não tratados no CIGAM
API de PIX avulso (QR Code dinâmico ECF Lojas) Não tratados no CIGAM

API Cobrança Híbrida

[editar]

Para clientes implementados a partir de junho de 2022.

Funcionalidade Versão
Registro de Cobrança Simples e vinculada 231002.b
Alteração de Vencimento 231002.b
Alteração de Juros (Multa não prevista para esta versão) 231002.b
Baixa de título 231002.b
Negativação e Protesto 231002.b
Retorno de Cobrança 231002.b
Demais alterações (endereço, desconto por antecipação, etc) Não tratados no CIGAM
QR CODE no Boleto 231002.b
API de PIX avulso (QR Code dinâmico ECF Lojas) Não tratados no CIGAM
Abatimentos 251103.BETA

Open Banking SICREDI

[editar]

Obtenção de credenciais - SICREDI

[editar]

API Ecommerce (antiga)

[editar]

As credenciais do SICREDI são obtidas diretamente com o seu gerente de Cash. Ele deve iniciar o trâmite junto ao contato técnico do banco.

IMPORTANTE: O Banco Sicredi, possui uma nomenclatura interna para esse processo, conhecido como Registro de Cobrança OnLine ou Ecommerce, conforme documentação. Então ao entrar em contato com o Gerente de Cash, validar as nomenclaturas para que haja o entendimento da funcionalidade.

Abaixo seguem as orientações atuais do banco conforme o seu manual mais recente.


API Cobrança Híbrida

[editar]

1. Entre no Portal Developers e crie um usuário e senha para o login.

2. Em "Minha Conta" selecione "Minhas Apps" e em seguinte "Cadastrar Nova App".

3. Informe os dados e crie a aplicação.

A API será criada e serão obtidos o Client ID e Client Secret.

4. Em Suporte selecione “Abra um chamado”.

5. Preencha o formulário com a solicitação do “access token” informando o Client_id obtido lá no processo inicial.

Após a criação do chamado, o Sicredi irá responder com a geração, a resposta estará em “minhas apps” no botão “detalhes”:


Exemplo Detalhes

Importante: Esse "código" será o "Access Token" a ser informado nos parâmetros do Assistente Open Banking.

6. Depois disso, o último passo é criar um usuário e senha, o caminho é o abaixo (retirado do manual da API página 8):

Ao final teremos os seguintes dados:

Importante 2:

  • O "Código do Beneficiário" e "Cooperativa Origem" irão compor o campo "Usuário(Beneficiário + Cooperativa)" nos parâmetros do Assistente Open Banking.
  • O "Código de Acesso" será a "Senha(64 Dígitos)" nos parâmetros do Assistente Open Banking.

Instruções para troca/renovação do certificado digital - SICREDI

[editar]

Atualmente o SICREDI não utiliza certificados digitais em suas APIs.

Assistente Open Banking - SICREDI

[editar]

Abertura do assistente: Ao abrir o assistente serão apresentadas as informações necessárias para a configuração de cada API disponibilizada.


Passo 1: Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um. O SICREDI possui ambiente de teste somente para a API Cobrança Híbrida, desta forma, caso seja utilizada a API Ecommerce preencha apenas os dados da aba “Produção”, caso você tenha a necessidade de cadastrar alguns títulos de teste, realize a criação de alguns lançamentos com valor baixo em ambiente oficial ou combine com o gerente de Cash do SICREDI um CPF/CNPJ específico para serem registrados e baixados sem custo.

    a. Api Cobrança: Informe a API de acordo com a sua credencial 01-Ecommerce ou 02-Cobrança Normal + Híbrida.
    b. Access Token: quando API Ecommerce cole o código de acesso obtido junto com seu gerente de cash. Quando API Cobrança Híbrida cole aqui a informação do "código" dentro do botão Detalhes em Minhas Apps obtida conforme as instruções do item API Cobrança Híbrida da Obtenção de credenciais.
    c. Usuário(Beneficiário + Cooperativa): Utilizado apenas para a API 02-Cobrança Normal + Híbrida. Informe o usuário SICREDI, ele será a junção do "Código do Beneficiário" e "Cooperativa Origem" obtidos conforme as instruções do item API Cobrança Híbrida da Obtenção de credenciais. Exemplo: Código do Beneficiário: 81234 e Cooperativa Origem: 2233, informaremos no campo o valor "812342233".
    d. Senha(64 Dígitos): Utilizado apenas para a API 02-Cobrança Normal + Híbrida. Informe a senha SICREDI, ela será o "Código de Acesso" de 64 dígitos obtido conforme as instruções do item API Cobrança Híbrida da Obtenção de credenciais..
    e. Versão da API: campo preenchido automaticamente pelo CIGAM.
    f. Versão da Autenticação: campo preenchido automaticamente pelo CIGAM.
    g. Url Autorização: campo preenchido automaticamente pelo CIGAM.
    h. Url API: campo preenchido automaticamente pelo CIGAM.
    i. Scope: campo preenchido automaticamente pelo CIGAM.


Passo 2: Este passo diz respeito à seleção de convênios, ela é uma característica do SICREDI 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 é “748”. 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 convenio que a empresa possua.

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 convenio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convenio especificado, será possível tanto configurar um novo convenio 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 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.

Apenas a opção "Direto" está habilitada para as duas versões do SICREDI. Atualmente somente a API Cobrança Híbrida disponibiliza a impressão de QRCode Pix no boleto, assim habilitando a opção "Pix" somente se o campo "Api Cobrança do Passo 1 for informada com "02-Cobrança Normal + Híbrida". O envio “Direto” está descrito em detalhes no manual Open Banking - Geral.


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”.

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. O padrão de finalização do CIGAM é manter o banco em homologação, mas caso você só possua credenciais de produção ou deseje ir diretamente para este ambiente, marque a opção “alterar o ambiente para produção”.

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no Tela de parâmetros Open Banking no manual Open Banking - Geral.

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco Sicredi, 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 SICREDI. Demais instruções de uso do open banking estão no Manual Open Banking - Geral.


Ambiente de testes - SICREDI

[editar]

Atualmente existe ambiente de homologação para o SICREDI somente para a API Cobrança Híbrida.

Registro de cobrança - SICREDI

[editar]

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

Particularidades do cadastro de Portador - SICREDI

[editar]

- Posto: O cadastro do posto deve ser informado nos seguintes campos do portador:


- Espécie: Para portadores do Sicredi (748) 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.


- Protesto e Negativação: O SICREDI possui os serviços de protesto e negativação e apenas um destes serviços pode ficar ativo.

Outra característica importante é que o SICREDI pode possuir regras de dias de negativação mínimo variando por estado. Para atender a este cenário, a sugestão é a criação de um outro portador para comportar esses dados específicos.

Exemplo: “Dias de negativação inválido para a UF de Mato Grosso do Sul. Para este estado o mínimo precisa ser 46 e máximo 99.”

Impressão de QR Code no Boleto - SICREDI

[editar]

Uma empresa que queira emitir QR Codes em seus boletos deve possuir credenciais com a versão da API Cobrança Híbrida 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_Sicredi_pix.rtf

Identificação no arquivo JSON de remessa:

Impressão do boleto com QR Code (Boleto Híbrido):

Retorno de cobrança - SICREDI

[editar]

O retorno de cobrança do SICREDI é disponibilizada apenas para a versão Cobrança Híbrida. A rotina de retorno do SICREDI funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:



A consulta de retornos no Sicredi funciona de forma responsiva, ou seja, o CIGAM é quem pergunta a situação dos títulos de acordo com a existência dos mesmos em sua base de dados. Títulos que somente existam na base de dados do Sicredi não são apresentados nesta consulta.

[Versão 240506 1]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).

Retenção P/C/C - PIS, COFINS, CSLL

[editar]

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:

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 Referenciados

[editar]

Documentação SICREDI

[editar]


Versões

[editar]

Versão 240506

[editar]
  1. ↑ Liberado a partir da OS 816822/4.

Versão 251103

[editar]
Disponível em “https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking_para_Banco_Sicredi&oldid=157454”