ATENÇÃO!

A partir de 30 de abril de 2025, a versão 2 e 2.2 da API do Banco Sicoob será descontinuada.
Para garantir o pleno funcionamento das cobranças, solicitamos que sejam regeneradas as credenciais que ainda não estão atualizadas para a última versão da API bancária. Caso as credenciais não sejam atualizadas, a utilização do serviço de cobrança será interrompida.

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 Sicoob.
   3. Autenticação com os dados do internet banking
   4. Preenchimento dos dados da API a ser criada
   5. Upload do certificado A1.
   6. Seleção do produto desejado
   7. Conferencia dos dados e obtenção das credenciais.
4. Como configurar as credenciais no PlugBoleto
   
5. Recursos disponíveis API Sicoob
   
   1. Boleto Hibrido Sicoob 
      1. O que é necessário para utilizar o Boleto Hibrido com o banco Sicoob?
      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 Sicoob
   3. Alteração de Boletos
      1. Requisitos para a Alteração de Boletos 
      2. Como disparar a requisição para realizar a alteração individual via API BANCÁRIA.
      3. 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

Para obter as credenciais para utilizar o registro instantâneo com o Sicoob, é preciso apenas possuir um cadastro ativo no portal developer do banco. Este cadastro deve ser feito diretamente no CPF ou CNPJ do correntista.

Passo 1 - Acesso ao portal developer do sicoob.

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

 

Passo 2 - Autenticação com os dados do internet banking

Após logar no portal developer pela primeira vez você será automaticamente redirecionado a tela de login ou caso não tenha sido clique em "Gerar aplicativo" para chegar até a tela de login.

"Nesta tela utilize seu usuario e senha do APP Sicoob - Mobile Banking, ou seja os mesmos dados que utiliza para acessar a conta do app do sicoob."

 

Passo 3 - Preenchimento dos dados da API a ser criada.

De um nome a API que esta sendo criada para identificação mais facil, preencha a conta corrente e nome do cooperado e crie uma descrição qualquer, esses dados são de preenchimento obrigatorio.

 

Passo 4 - Upload do certificado A1.

Na pergunta "A integração será por uma empresa parceira?" você deve selecionar a opção "não". Na mesma página, selecione um certificado digital A1 válido que tenha sido emitido para o CNPJ do cedente, em seguida clique em “Prosseguir”. O certificado deve estar no formato .PEM para vincular o certificado à sua credencial.

Caso não saiba como exportar o .PEM verifique esta documentação: Certificado digital.

 

Passo 5 - Seleção do produto desejado.

No caso especifico do Plugboleto deve se ser selecionado o produto "Cobrança Bancária"  e clique em prosseguir.

 

OBS: No exemplo abaixo está selecionado PIX, para boletos selecione Cobrança Bancaria.

Passo 6 - Conferencia de dados e obtenção das credenciais.

Verifique se os dados inseridos estão corretos e caso estejam corretos clique em "Criar aplicativo"

 

 

Após clicar em Criar Aplicativo já sera disponibilizado para você as credenciais para utilização da API Sicoob.

 

 

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 novos campos o primeiro é "Versão web service" que deve ser preenchido com V2.2 ou V3, o segundo é o campo "API - ID" onde deve ser informado o client_id informado pelo Sicoob neste passo.

Como ultimo requisito para registro de boletos temos o campo para ser feito o upload do certificado.pfx obtido neste passo juntamente com a senha que foi definida na conversão de .crt para .pfx.

Exemplo do cadastro das credenciais no portal do Plugboleto:

 

Recursos disponíveis na API Sicoob

 

Boleto Hibrido

O boleto híbrido do Sicoob combina 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 Sicoob?

Para utilizar o boleto híbrido com o Banco sicoob, 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 Sicoob, 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 Sicoob 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 sicoob é 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 Sicoob.

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

• Situação
• PagamentoData
• PagamentoDataCredito
• 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 Sicoob.

• 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 Sicoob V2.

 

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

 

POST

Homologação:

Produção:

 

Headers

 

Nome	Descrição	Exemplo
Content-Type	Indica o tipo de arquivo	application/json
cnpj-cedente	CNPJ do Cedente	01001001000113
cnpj-sh	CNPJ da Software House	01001001000113
token-sh	Token da Software House	f22b97c0c9a3d41ac0a3875aba69e5aa

 

 

Headers (Opcional)

 

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

Nome	Descrição	Exemplo
Content-Type	Indica o tipo de arquivo	application/json
cnpj-cedente	CNPJ do Cedente	01001001000113
token-cedente	Token do Cedente	f22b97c0c9a3d41ac0a3875aba69e5aa1

 

Objeto

Para solicitar a impressão, o objeto JSON pode ter os seguintes campos:

Campo	Tipo	Descrição
Tipo	string	Campo	Descrição	Exemplo
Boletos	array	TituloValor	Altera o valor do título	15,00
		TituloDataVencimento	Alterar a data de vencimento	15/03/2023
		TituloValorDescontoTaxa	Alterar o valor do desconto	100
		TituloValorAbatimento	Alterar o valor do abatimento ou redução do valor do boleto	5
		TituloCodProtesto	Alterar o código de protesto	8
		TituloPrazoProtesto	Alterar a data do protesto	20/02/2023

Campos obrigatórios de acordo com o tipo

 

Tipo	Campos obrigatórios	Observações
0	TituloDataVencimento	Deve ser informado uma data posterior a data de vencimento atual, Nova data não deve ser maior que 5 anos que a data atual. Deve ser informada no formato (DD/MM/YYYY).
2	TituloValorAbatimento	O valor do abatimento a ser concedido deve estar no formato (1000,00).
12	TituloCodDesconto	Nesse tipo é necessário informar o campo TituloCodDesconto (1)
12	TituloValorDescontoTaxa	O TituloValorDescontoTaxa deve estar no formato (1000,00).
13	TituloCodigoJuros	Nesse tipo é necessário informar o campo TituloCodJuros (1)
13	TituloValorJuros	O TituloValorJuros deve estar no formato (1000,00).
14	TituloCodDesconto	Nesse tipo é necessário informar o campo TituloCodDesconto (1)
14	TituloDataDesconto	Deve ser informado uma data anterior a data de vencimento atual, Deve ser informada no formato (DD/MM/YYYY).

 

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 Sicoob, 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 Sicoob.

Como solicitar a Baixa

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