Para que serve
Na carteira do Sicredi, o boleto pode ser registrado no banco de dois jeitos:
- Arquivo CNAB, o jeito de sempre: o sistema gera o arquivo de remessa, você envia pelo site do banco e, depois, traz o arquivo de retorno para baixar os pagamentos.
- API do Sicredi: o sistema fala direto com o banco pela internet. Não há arquivo para enviar nem para buscar.
Por fora o boleto é o mesmo: mesma emissão, mesma impressão, mesmo Contas a Receber. O que muda é o caminho até o banco e a hora em que as coisas acontecem. Leia esta página antes de mudar a carteira, para não esperar da API o comportamento do arquivo.
O que muda em relação ao CNAB
| Arquivo CNAB | API do Sicredi | |
|---|---|---|
| Registrar o boleto | gerar a remessa e enviar o arquivo no site do banco | clicar em Enviar ao Sicredi (ou Remessa); o sistema registra na hora |
| Quando o boleto passa a valer | quando o banco processa o arquivo, às vezes só no dia seguinte | assim que aparece como registrado, em segundos |
| Boleto com problema | a recusa vem dias depois, no arquivo de retorno | a recusa aparece na tela, com o motivo do banco, no momento do envio |
| Saber o que foi pago | baixar o arquivo de retorno no site do banco | botão Consultar Sicredi (API) em Baixar Boletos, sem arquivo |
| Cancelar, prorrogar, dar abatimento ou desconto | instrução numa nova remessa | botão direito na Manutenção de Boletos; o banco responde na hora |
| Acompanhar | conferir a remessa e o retorno | faixa Sicredi (API) na Manutenção de Boletos, com o que falta enviar, o que foi recusado e o que está registrado |
🔑 Na API, o boleto só existe no banco depois de enviado. Emitir e imprimir não basta: enquanto ele aparecer como não enviado, o cliente não consegue pagar. Crie o hábito de clicar em Enviar ao Sicredi logo depois de emitir, principalmente quando o boleto vai por e-mail junto com a nota.
Antes de começar
- Contrate a Cobrança Online (API) com a sua cooperativa. Sem esse produto o Sicredi recusa todos os envios.
- Tenha a x-api-key. É a chave do aplicativo da sua empresa no Portal do Desenvolvedor do Sicredi; há uma chave para o ambiente de teste e outra para produção. O suporte RWA orienta esse cadastro.
- Gere o código de acesso no Internet Banking do Sicredi: Cobrança → Código de Acesso → Gerar.
- Confira os clientes: o Sicredi exige CPF ou CNPJ do pagador. Boleto de cliente sem documento não é enviado.
- Número do documento com até 10 caracteres. É o limite do Sicredi para o "seu número".
- Boleto com Pix (opcional): para o boleto sair com QR Code, contrate o Pix com a cooperativa e marque Boleto com Pix (QR Code) na carteira. Sem o Pix contratado, deixe em NÃO: o banco recusa o boleto com Pix.
Como fazer
- Abra Cadastros → Financeiro → Carteira de Cobrança, escolha a carteira do Sicredi e clique em Alterar (F2).
- Na aba API de Cobrança, preencha a x-api-key de teste e o Código de acesso. Em Ambiente, deixe Teste (sandbox). Clique em Gravar (F11).
- Clique em Testar conexão. A mensagem diz se o Sicredi aceitou a chave, o código e os dados da conta. Esse teste funciona mesmo com a carteira ainda em Arquivo CNAB.
- Em Registro do boleto, escolha API do Sicredi (online) e grave.
- Emita um boleto de teste como sempre e, na Manutenção de Boletos, clique em Enviar ao Sicredi. O resumo mostra o que foi registrado e o que foi recusado, com o motivo.
- Quando tudo estiver certo, preencha a x-api-key de produção, mude o Ambiente para Produção, grave e clique em Testar conexão de novo.
⚠️ Registro feito no ambiente de Teste não vale para pagamento. Use no teste só boletos de teste, que não vão para clientes.
No dia a dia
- Emita o boleto como sempre (pela nota, pelo Contas a Receber ou avulso).
- Na Manutenção de Boletos, clique em Enviar ao Sicredi. Ele envia de uma vez tudo o que falta: boletos novos, recusados já corrigidos e os que ficaram sem resposta.
- Olhe a faixa Sicredi (API), acima do total. Texto em vermelho quer dizer que há boleto recusado ou sem resposta: clique em Situação na API para ver quais.
- Para baixar os pagamentos, abra Financeiro → Boletos Bancários → Baixar Boletos, escolha a conta do Sicredi, clique em Consultar Sicredi (API) e depois em Processar Retorno. Ao abrir a Manutenção de Boletos, o sistema avisa quando há pagamentos ainda não baixados.
Como conferir se deu certo
- Na grade da Manutenção, o status do boleto fica Registrado no Sicredi (API).
- Botão direito no boleto → Detalhes do Registro mostra a situação, o ambiente, quem enviou e quando, e a linha digitável devolvida pelo banco.
- Botão direito → Conferir situação no Sicredi (API) consulta o boleto no banco agora: em carteira, vencido, pago, baixado, protestado.
Se acontecer...
| Situação | O que fazer |
|---|---|
| Recusado pelo Sicredi | leia o motivo no resumo ou em Detalhes do Registro, corrija (cliente, endereço, vencimento...) e clique em Enviar ao Sicredi de novo. |
| Sem resposta do banco | foi a internet ou o banco que não respondeu. Envie de novo em alguns minutos: o sistema consulta o banco antes e não registra o mesmo boleto duas vezes. |
| Não enviado: cliente sem CPF/CNPJ | complete o cadastro do cliente e envie de novo. |
| O Sicredi recusou as credenciais | confira a x-api-key e o código de acesso na carteira e clique em Testar conexão. |
| Preciso cancelar ou alterar um boleto já registrado | use o botão direito na Manutenção: Pedir baixa, Alterar vencimento, Conceder abatimento ou Alterar desconto no Sicredi (API). Alterar, Excluir e as opções de remessa ficam bloqueadas enquanto o boleto está registrado no banco. |
Perguntas frequentes
Ainda preciso entrar no site do banco para enviar arquivo? Não. Com a carteira na API não há arquivo de remessa nem de retorno.
Posso voltar para o CNAB? Pode: em Registro do boleto, escolha Arquivo CNAB (remessa). Antes, resolva os boletos que já estão registrados pela API: eles só são cancelados ou alterados pela API, e com a carteira no CNAB essas opções deixam de funcionar.
O boleto impresso muda? Só com Boleto com Pix ligado na carteira: o boleto ganha um QR Code para pagar pelo Pix. Fora isso, sai do mesmo jeito, com a linha digitável do mesmo nosso número.
E o boleto que vai por e-mail junto com a nota? Com a carteira na API, ele só é enviado depois que o boleto estiver registrado no Sicredi em Produção, para o cliente não receber um boleto que ainda não pode ser pago. Por isso, clique em Enviar ao Sicredi logo depois de emitir. Boleto registrado só no ambiente de Teste não vai por e-mail.
Todas as estações precisam estar atualizadas? Sim. Atualize o RWA Sistema em todos os computadores antes de mudar a carteira para a API: uma estação com versão antiga não conhece a API e geraria arquivo CNAB para esses boletos.
Onde vejo a situação de todos os boletos? Na Manutenção, pelo botão Situação na API, ou no relatório Relatórios → Boletos Bancários → Boletos Emitidos, com o filtro Situação na API do Sicredi.
Os campos da aba API de Cobrança estão em Carteira de Cobrança; a emissão, a remessa e a baixa em geral, em Boletos — da emissão à baixa.