Como configurar a API de Cobrança do Sicredi no PlusCom

A integração permite emitir e consultar boletos do Sicredi diretamente pelo PlusCom, além de obter o PDF, solicitar baixa, alterar vencimento e consultar liquidações, conforme as funcionalidades homologadas no sistema.

Importante: este conteúdo foi elaborado com base na documentação do Sicredi consultada em 21/08/2026 e na implementação atual do PlusCom. O Sicredi poderá alterar portais, nomes de opções, credenciais, exigências e procedimentos. Antes de configurar o ambiente de produção, confirme todas as informações com o(a) gerente da conta ou com o suporte oficial do Sicredi. Em caso de divergência, prevalece a orientação oficial mais recente do banco.

Pré-requisitos

Antes de iniciar a configuração, confirme se a empresa ou pessoa associada:

• possui conta ativa no Sicredi;

• contratou o produto Cobrança;

• optou pela modalidade API - Cobrança Online;

• assinou o termo de contratação ou adesão;

• recebeu o Código do Beneficiário, também chamado de código do convênio;

• possui acesso ao Portal do Desenvolvedor Sicredi; (procedimento feito pela equipe do PlusCom)

• possui acesso ao Internet Banking da conta vinculada ao convênio;

• recebeu ou solicitou a liberação das credenciais necessárias para homologação e produção.

A contratação e a habilitação comercial são realizadas junto à cooperativa.
O Código do Beneficiário é gerado durante esse processo e é obrigatório na integração. Consulte o guia oficial de acesso à API de Cobrança.

Informações que você precisará

Para configurar a integração no PlusCom, solicite ou confirme com o Sicredi:

• código da cooperativa;

• código do posto;

• Código do Beneficiário;

• usuário de autenticação, chamado de username na documentação;

• Código de Acesso da conta;

• chave da aplicação, chamada de x-api-key;

• ambiente ao qual cada credencial pertence: Sandbox ou Produção;

• byte de geração do Nosso Número, entre 2 e 9;

• habilitação para boleto tradicional ou boleto híbrido;

• autorização para protesto automático, caso essa funcionalidade seja utilizada.

Não utilize dados de exemplos encontrados em manuais antigos para configurar a produção.

Homologação e produção

O Sicredi trabalha com ambientes separados:

• Homologação ou Sandbox: destinado aos testes da integração;

• Produção: destinado à emissão de boletos reais.

As credenciais e a chave da aplicação podem ser diferentes em cada ambiente.
Não misture, por exemplo, a chave da aplicação de Sandbox com o Código de Acesso ou os dados de produção.

A orientação atual do Sicredi é validar primeiro em Sandbox e somente depois configurar a produção com os dados reais e as liberações correspondentes.

Criando a aplicação no Portal do Desenvolvedor

Acesse o Portal do Desenvolvedor Sicredi, crie uma conta ou entre com seu usuário.

No portal:

1. Acesse a área Minhas Apps.

2. Selecione a opção para criar uma nova aplicação.

3. Informe um nome que permita identificar a empresa, a API e o ambiente.

4. Selecione a API de Cobrança e a API de Autenticação de Parceiros disponibilizadas pelo portal.

5. Conclua a criação da aplicação.

6. Acesse Suporte > Abrir chamado e solicite a liberação da chave para a API de Cobrança.

7. Depois que a solicitação for atendida, acesse Minhas Apps, abra os detalhes da aplicação e localize a credencial utilizada como x-api-key.

Crie e identifique separadamente as aplicações e credenciais destinadas ao Sandbox e à Produção, conforme a orientação vigente do portal.

O Portal do Desenvolvedor também apresenta um Client ID ao criar a aplicação. Na integração atual do PlusCom, esse Client ID não deve ser confundido com o campo ID do Cliente. O PlusCom utiliza nesse campo o username da API de Cobrança.

Gerando o Código de Acesso

Para produção, o Código de Acesso é gerado no Internet Banking da conta vinculada ao convênio de Cobrança.

De acordo com a documentação atual do Sicredi:

1. Acesse o Internet Banking com um usuário que possua o perfil necessário, atualmente indicado como perfil Master.

2. Acesse Cobrança > Código de Acesso > Gerar.

3. Confirme a operação com o dispositivo de segurança solicitado.

4. Guarde o código gerado em local seguro.

O Código de Acesso é específico por conta. Se a empresa utilizar mais de uma conta com a API de Cobrança, deverá gerar e configurar o código correspondente em cada conta.

Se a opção Código de Acesso não estiver disponível, confirme com a pessoa gerente da conta se a modalidade API - Cobrança Online está habilitada e se o usuário do Internet Banking possui as permissões necessárias.

Correspondência das credenciais no PlusCom

Na integração Sicredi, preencha os campos da seguinte maneira:

ID do Cliente → username utilizado na autenticação

Chave Secreta do Cliente → Código de Acesso

Chave de Aplicativo → x-api-key da aplicação

Ambiente → Homologação ou Produção

Segundo a documentação atual, o username é formado pelo Código do Beneficiário, com cinco posições, seguido do código da cooperativa, com quatro posições. Confirme o valor com o Sicredi e informe-o exatamente como orientado pelo banco.
O PlusCom não tenta remontar ou corrigir essa credencial. Veja os detalhes oficiais da autenticação.

A x-api-key pode aparecer no Portal do Desenvolvedor como token ou chave de acesso da aplicação.
Ela não é o mesmo token temporário gerado durante a autenticação.
O token temporário é controlado automaticamente pelo PlusCom e não deve ser copiado para nenhum campo da conta corrente.

Configurando a conta corrente no PlusCom

Clique aqui para saber como configurar a conta corrente no PlusCom.

Configurando a carteira de cobrança

Depois de configurar a conta corrente, abra a configuração da carteira de boletos vinculada a essa conta.

Confira os seguintes campos:

Banco → 748 - Sicredi

Agência → Código da cooperativa, com quatro posições

Dígito da agência → Código do posto, com duas posições

Código do cedente → Código do Beneficiário, com cinco posições

Tipo de integração → Integração via API bancária

Byte - somente Sicredi → Valor entre 2 e 9, confirmado para a carteira

Híbrido Pix → Ativar somente se a modalidade estiver habilitada no Sicredi

Dias para protesto → Configurar somente quando contratado e autorizado

O PlusCom valida a cooperativa com quatro dígitos e o Código do Beneficiário com cinco dígitos.

Atenção ao código do posto

A implementação atual do PlusCom aceita um posto com dois caracteres alfanuméricos. Entretanto, a referência eletrônica atual da API apresenta o posto como campo numérico de duas posições.

Se o posto da sua conta contiver letras, não prossiga para produção sem obter a confirmação formal do Sicredi sobre o valor que deve ser enviado.

Byte de geração do Nosso Número

O byte participa da formação do Nosso Número do boleto. Para boletos gerados pelo beneficiário, o manual utilizado na implementação admite valores de 2 a 9.

Solicite ao Sicredi a confirmação do byte apropriado para a carteira. Não escolha o número aleatoriamente e não o altere depois que a carteira começar a emitir boletos sem antes consultar o Sicredi e o suporte do PlusCom, pois uma alteração indevida pode causar conflito com Nosso Número já utilizado.

Boleto tradicional e boleto híbrido

O Sicredi oferece:

• Boleto tradicional: possui linha digitável e código de barras;

• Boleto híbrido: possui linha digitável, código de barras e QR Code Pix.

Ative Híbrido Pix no PlusCom somente quando essa modalidade estiver habilitada para o convênio no Sicredi.

A documentação oficial atual informa que a habilitação da modalidade híbrida deve ser solicitada pelo canal indicado pelo banco, atualmente citado como Portal PJ. Confirme o procedimento com a cooperativa antes da configuração.

Na integração atual do Sicredi, o campo genérico Chave Pix para o boleto híbrido não é enviado pela API de Cobrança. Não preencha esse campo por suposição. A emissão do QR Code depende da habilitação bancária da modalidade híbrida.

Se forem enviadas datas de início de juros ou de multa, o Sicredi poderá registrar o boleto como tradicional, sem QR Code, mesmo que a carteira esteja configurada como híbrida. Esse comportamento está previsto na documentação atual da API. Consulte a referência oficial de cadastro de boleto.

Juros, multa e protesto

Configure juros, multa e protesto de acordo com o contrato da empresa e com as regras aprovadas pelo Sicredi.

Na implementação atual:

• juros e multa são enviados em percentual quando configurados;

• valores negativos não são permitidos;

• protesto automático pode ser omitido ou configurado entre 3 e 99 dias;

• o boleto híbrido poderá ser convertido em tradicional quando houver data inicial de juros ou multa.

Não ative protesto automático sem confirmar que o produto e a carteira possuem essa autorização.

Espécie do documento

A integração atual do PlusCom envia os boletos Sicredi como Duplicata Mercantil por Indicação.

Se a empresa precisa emitir outra espécie de documento, consulte o suporte do PlusCom antes de utilizar a integração. Não altere a espécie apenas para contornar uma rejeição do banco.

Testando a configuração

Uma autenticação bem-sucedida confirma as credenciais, mas não confirma, sozinha, que todos os dados da carteira estão corretos ou que todas as funcionalidades estão habilitadas.

Cuidados durante a emissão

Se ocorrer falha de comunicação, interrupção ou resultado indeterminado durante o envio, não gere imediatamente um novo boleto para a mesma cobrança.

O título poderá ter sido recebido pelo banco mesmo sem o PlusCom ter obtido a resposta final. Consulte a situação do boleto ou procure o suporte antes de tentar novamente, evitando cobranças duplicadas.

Problemas mais comuns

A autenticação não foi autorizada

Confira:

• se o ambiente selecionado corresponde às credenciais;

• se o username está correto;

• se o Código de Acesso pertence à conta configurada;

• se a x-api-key pertence à aplicação e ao ambiente corretos;

• se não foram inseridos espaços antes ou depois das credenciais.

O teste de conexão funciona, mas o boleto é recusado

Confira:

• cooperativa;

• posto;

• Código do Beneficiário;

• byte do Nosso Número;

• habilitação da carteira;

• modalidade tradicional ou híbrida;

• permissões de protesto;

• dados obrigatórios do pagador.

O boleto híbrido foi emitido sem QR Code

Verifique:

• se a modalidade híbrida está habilitada no Sicredi;

• se a carteira está marcada como híbrida no PlusCom;

• se foram aplicadas datas de início de juros ou multa;

• se a resposta do banco confirmou o QR Code.

Não reenvie o título apenas porque o QR Code não foi apresentado. Primeiro consulte o boleto existente.

O que confirmar com o Sicredi

Antes de utilizar a produção, solicite a confirmação dos seguintes pontos:

• A modalidade API - Cobrança Online está ativa para esta conta?

• Qual é o Código do Beneficiário?

• Quais são os códigos corretos da cooperativa e do posto?

• Qual username deve ser utilizado?

• A x-api-key de produção está liberada?

• O Código de Acesso foi gerado para a conta correta?

• Qual byte, entre 2 e 9, deve ser utilizado no Nosso Número?

• A modalidade de boleto híbrido está habilitada?

• O protesto automático está autorizado?

• Caso o posto seja alfanumérico, qual valor deve ser enviado pela API?

• A homologação está concluída e a conta está autorizada para produção?

Documentação e suporte

Consulte sempre as fontes oficiais mais recentes:

• Documentação pública das APIs Sicredi

• Como obter acesso à API de Cobrança

• Autenticação da API de Cobrança

• Portal do Desenvolvedor Sicredi

Para contratação, habilitação e dados da conta, procure a sua cooperativa ou a pessoa gerente da conta. Para aplicação, credenciais e dificuldades técnicas, utilize o menu Suporte do Portal do Desenvolvedor.