748 - Sicredi

1. Visão Geral
2. Fluxograma completo de utilização
3. Como obter credenciais junto ao banco
   1. Pré-requisitos para realizar o procedimento completo de liberação de credenciais bancárias.
   2.  Acesso ao portal do desenvolvedor Sicredi.
   3. Criando uma nova API no developer Sicredi
   4. Selecionando o produto desejado
   5. Obtendo a CHAVE KEY
   6. Obtendo o ApiSecret
4. Como configurar as credenciais no PlugBoleto
5. Recursos disponíveis API Sicredi
   1. Boleto Hibrido Sicredi 
      1. O que é necessário para utilizar o Boleto Hibrido com o banco Sicredi?
      2. Emitindo o boleto híbrido VIA API
      3. Consultando o boleto híbrido
      4. Impressão do boleto híbrido
   2. Consulta de Boletos
      1. Consulta individual
      2. Consulta geral em boletos REGISTRADOS
      3. Informações sobre Pagamento de Boletos disponível na API Sicredi
   3. Alteração Individual de Boletos via API
      1. Requisitos para a Alteração de Boletos 
      2. Como ativar a Alteração via API
      3. Como disparar a requisição para realizar a alteração individual via API BANCÁRIA.
      4. Campos disponíveis para alteração 
   4. Baixa de Boletos
      1. Requisitos para a Baixa de Boletos
      2. Como solicitar a Baixa

Visão Geral

O recurso de transmissão instantânea foi desenvolvido para facilitar a integração de sistemas de cobrança com as APIs bancárias, oferecendo uma solução prática e eficiente para desenvolvedores.

Esse método permite a consulta direta dos dados dos boletos nos servidores bancários, retornando imediatamente após sua criação o status REGISTRADO como nos boletos de cobranças de grandes marketplaces.

Ao utilizar a transmissão instantânea, desenvolvedores conseguem implementar um fluxo de emissão de boletos mais ágil e seguro, permitindo que clientes finais possam realizar o pagamento dos títulos logo após a criação. Isso elimina o tempo de espera que existe no tradicional método de transmissão de remessas e obtenção de retorno que é D+1, já que cada boleto emitido pelo sistema é validado instantaneamente, integrando-se com o servidor bancário em tempo real.

Essa solução simplifica a comunicação com instituições financeiras, reduzindo o esforço de implementação e manutenção de sistemas de cobrança, enquanto melhora a experiência do usuário final. Com a transmissão instantânea, é possível construir aplicações financeiras robustas que garantem precisão nos dados de pagamento, ao mesmo tempo em que agilizam o processo de verificação e registro de boletos.

Atenção: Apesar de a captura do status de REGISTRO ou REJEIÇÃO via API ser imediato as LIQUIDAÇÕES(pagamentos) não seguem a mesma dinâmica, dependendo dos procedimentos internos do banco. Isso significa que o status de liquidação não está disponível instantaneamente e depende dos prazos internos de atualização de suas bases. Esse tempo pode variar de acordo com o banco e o serviço de API.

Fluxograma completo de utilização

Como obter credenciais junto ao banco

Pré requisitos para realizar o procedimento completo de liberação de credenciais bancárias

1 Passo -  Acesso ao portal developer Sicredi

Crie um cadastro no portal developer Sicredi  com os dados do titular da conta corrente.

2 Passo -  Criação da API Sicredi

Clique em Minha Conta e depois Minhas Apps

3 Passo -  Seleção do produto desejado.

No checkbox abaixo, selecione a opção OPEN API - COBRANCA - PARCEIROS 1.0.0, e finalize a criação da sua App.

4 Passo -  Obtendo a CHAVE KEY

Após finalizado o vá novamente em "Minhas Apps" e então você vera as informações de clientID e Client Secret, essas informações não serão utilizados no cadastro do convênio no PlugBoleto.

Clique em "detalhes", e então será disponibilizado a chave key. Esta será a informação que você preencherá no cadastro de convênio do PlugBoleto.

**Em alguns casos, após a criação de aplicação, o token acaba não aparecendo no detalhamento, nestas situações, é necessário acionar o suporte do Sicredi pela própria plataforma, e solicitar a geração do token para a aplicação em questão.

5 Passo -  Obtendo o ApiSecret

Após realizado os passos anteriores então deve se ser acessado o internet banking do titular da conta corrente e navegar até a área denominada "Código de Acesso" e gerar o código de acesso e então sera disponibilizado o ApiSecret que será utilizado no PlugBoleto.

Como configurar as credenciais no PlugBoleto

Para melhor visualização e entendimento do processo vamos utilizar nossa GUI WEB para explicar o preenchimento de campos mas esse processo também poderá ser realizado via API conforme a documentação de integração com a API PlugBoletos.

Após realizar o cadastro da conta, acesse a na página de convênios e caso não tenha sido ainda criado o convenio referente a conta deve ser criado conforme a documentação de cadastro de convênios.

Com o convenio criado ative a opção "Registro instantâneo", esse campo é onde você habilita o uso desse recurso no seu convênio.

Quando o campo Registro instantâneo for ativado deve aparecer logo abaixo cinco novos campos que devem ser preenchidos da seguinte forma:

• Versão web service: Preencha com V3.
• Código da estação: Código de Cooperativa sem o posto, ou seja, 4 dígitos.
• Username: Código de beneficiário com 5 dígitos + Cooperativa com 4 dígitos, totalizando 9.
• Chave Key: Token gerado via portal do desenvolvedor do Sicredi.
• Password: Código de acesso gerado no internet banking, conforme o processo detalhado a seguir. O cedente deve entrar no internet banking do Sicredi e ir na área de código de acesso.

Exemplo do cadastro das credenciais no portal do Plugboleto: 

Recursos disponíveis na Api Sicredi

Boleto Hibrido

O boleto híbrido do Sicredicombina as opções de pagamento via boleto e Pix para uma mesma cobrança. Isso permite oferecer aos clientes a flexibilidade de quitar o pagamento utilizando o código de barras do boleto ou o QR Code do Pix.

O que é necessário para utilizar o Boleto Hibrido com o banco Sicredi?

Para utilizar o boleto híbrido com o Banco Sicredi, basta realizar a liberação das credenciais conforme descrito neste passo. Após isso, você estará apto a usar a API bancária. No caso do Sicredi, não é necessária nenhuma liberação adicional de escopos ou serviços junto ao banco, com a credencial padrão já é possível realizar o registro.

Emitindo o boleto híbrido VIA API

Para comandar que um boleto seja  registrado no modelo HIBRIDO basta adicionar ao JSON de envio anteriormente implementado o campo chamado "hibrido": true, caso tenha duvidas sobre a implementação da rota de inclusão de boletos basta acessar nossa documentação.

Abaixo um exemplo do campo a ser adicionado:

{
  ...
  ...
  "TituloNossoNumero":"123",
  "TituloValor":"100,00",
  "hibrido": true
}

Consultando o boleto híbrido

A consulta do boleto hibrido segue a mesma implementação da consulta de boletos tradicionais conforme a documentação de consulta de boletos, sendo necessário apenas a leitura dos dois novos campos referentes ao boleto hibrido.

{
  "hibrido": true,
  "UrlPix": "http://plugboleto.com.br/api/v1/boletos/impressao/HRKCVJXVV/pix",
}

Impressão do boleto híbrido

Para saber mais sobre os tipos de impressão, acesse a documentação referente aos exemplos de impressão.

Exemplo de boleto híbrido:

Consulta de Boletos

Consulta individual

As  requisições que forem disparadas para o endpoint de consulta do Plugboleto serão imediatamente processadas e apresentará os dados atuais do titulo em nosso banco de dados, em seguida replicaremos a consulta diretamente no servidor bancário a fim de buscar uma possível atualização de dados, caso seja identificado uma atualização de status automaticamente será disparado um webhook de notificação para a Software House, caso não tenha webhook configurado é possível obter as atualizações realizando uma nova consulta em seguida.

Um boleto pode ter 7 situações diferentes, que podem ser verificadas neste link.

Para verificar quais campos são retornados nesta consulta, clique aqui.

Consulta Automática

 O PlugBoletos conta com rotinas de consultas automáticas que tem como intuito dar mais confiabilidade e celeridade as conciliações de boletos, no momento para o banco Sicredi V2 temos disponível apena a consulta geral, sem webhook ou francesa.

Consulta geral em boletos REGISTRADOS

Considerando que a consulta francesa e o webhook não estão disponíveis para o Sicredi é realizada uma consulta em todos os títulos com status de REGISTRADO em nossa base, ela se inicia as  7 horas da manha e seu tempo de execução pode variar de acordo com o tamanho da base a ser consultada.

Informações do boleto atualizadas após a conciliação na API Sicredi.

Com a atualização via API o banco Sicredi reduz a quantidade de informações disponibilizadas sobre o pagamento limitando se as principais informações de LIQUIDAÇÃO:

• Situação

• PagamentoData

• PagamentoValorPago

• PagamentoValorAcrescimos

Vale apenas ressaltar que todas as outras informações da cobrança já foram capturadas e estamos focando apenas em campos atualizados após o pagamento do titulo.

Alteração Individual de Boletos via API

A alteração de boletos é útil em situações onde informações previamente registradas, como data de vencimento, valor ou valor de abatimento precisam ser modificadas após o titulo ja estar registrado. Abaixo está uma visão geral de como funciona o processo de alteração de boletos via API bancária no PlugBoletos.

Requisitos para a Alteração de Boletos

Antes de comandar uma alteração, é importante garantir que o boleto se enquadra em alguns requisitos. O boleto precisa estar REGISTRADO no Sicredi.

• Apenas determinados campos podem ser modificados, como data de vencimento, valor de cobrança, multa, juros e descontos aplicáveis.

• É necessário possuir as credenciais de autenticação bancárias descritas em Como obter credenciais junto ao Banco para acessar a API Sicredi V2.

Como ativar a Alteração via API

 Para ativar a funcionalidade de alteração após ter configurado as credenciais no convenio basta ativar a opção "Alteração via WS" no cadastro de convenio.

Como disparar a requisição para realizar a alteração individual via API BANCÁRIA.

POST

Homologação:

Produção:

Headers

Headers (Opcional)

Utilizar esses headers em caso de autenticação direto com as credenciais do cedente:

Campos disponíveis para alteração 

Baixa de Boletos

Para boletos que alcançaram o status de REGISTRADO, o cancelamento só pode ser realizado através de uma solicitação formal de BAIXA. Esse processo, para o Sicredi, pode ser automatizado diretamente por meio da API bancária, facilitando o cancelamento e integração com sistemas de cobrança.

Requisitos para a Baixa de Boletos

1. Status de REGISTRADO: Assim que um boleto é registrado no banco, ele fica disponível para pagamento e segue sob controle do sistema bancário.

2. Solicitação de Baixa: Caso o boleto precise ser cancelado (por exemplo, devido a duplicidades, erros ou desistência de cobrança), uma requisição de baixa deve ser enviada ao banco.

3. É necessário possuir as credenciais de autenticação bancárias descritas em Como obter credenciais junto ao Banco para acessar a API Sicredi.

Como solicitar a Baixa

Para realizar a solicitação de baixa basta realizar a integração com o endpoint de baixa do Plugboletos.