Com a carteira ligada à API, o Sicredi registra o boleto no momento em que ele é gravado no Mestre e devolve a linha digitável, o código de barras, o nosso número e o QR Code do Pix. As liquidações voltam pela própria API, sem arquivo de retorno. Este artigo conduz a equipe de suporte do pedido à cooperativa até o primeiro boleto registrado. Resumo O cliente contrata a Cobrança na modalidade API (Cobrança Online) com a cooperativa e recebe o código do beneficiário. Depois, gera o Código de Acesso no Internet Banking, com perfil master, na conta do convênio. No Mestre, o suporte preenche a carteira de cobrança com Username, Password, cooperativa, posto e código do beneficiário, confirma que o ambiente fiscal está em Produção e emite um boleto de teste. Não há certificado digital nem cadastro no portal do desenvolvedor: a chave de aplicação usada nas chamadas é a da Mestre Sistemas e já vem configurada. |
O posto é o campo que mais derruba a implantação Quem identifica o beneficiário no Sicredi é a tripla cooperativa + posto + código do beneficiário. O posto é o PA (posto de atendimento) da conta, tem dois dígitos e não aparece no documento de Código de Acesso que o banco entrega. Confirme o posto com o cliente ou na cooperativa: posto errado faz o registro voltar com “Beneficiário inativo ou não encontrado”, que parece problema de habilitação da conta e não é. |
Visão rápida- Credenciais: Username (código do beneficiário + cooperativa, 9 dígitos) e Password (Código de Acesso do Internet Banking). Sem certificado digital.
- Nosso número: quem numera é o Sicredi. A faixa Início/Fim/Atual da carteira não é usada na emissão por API.
- Pix no boleto: depende da habilitação de boletos híbridos junto ao Sicredi. O Mestre apenas pede o tipo híbrido no registro.
- Impressão: o Sicredi tem o PDF oficial do boleto, que o Mestre busca logo após o registro quando a carteira marca “Utilizar layout de impressão padrão do Banco”.
- Ambiente: não fica na carteira. Vem da configuração fiscal da empresa (a mesma da NF-e).
| Etapa | Quem executa | Resultado esperado |
|---|
| 1. Contratar a Cobrança na modalidade API | Cliente + cooperativa | Convênio habilitado e código do beneficiário informado | | 2. Gerar o Código de Acesso | Cliente (perfil master) | Senha da API em mãos | | 3. Levantar cooperativa, posto e beneficiário | Cliente + Suporte Mestre | A tripla que identifica a conta, com o posto confirmado | | 4. Configurar a carteira | Suporte Mestre | Carteira WebService completa e ambiente conferido | | 5. Emitir o primeiro boleto | Suporte Mestre | Boleto registrado, com linha digitável e código de barras |
1. O que o cliente precisa resolver com a cooperativaA parte comercial vem antes de qualquer configuração. Sem ela, o menu do Código de Acesso nem aparece no Internet Banking do cliente. | Item a confirmar | Para que serve |
|---|
| Produto Cobrança contratado na modalidade API (Cobrança Online) | É o que libera a emissão por API e o menu de Código de Acesso no Internet Banking | | Código do beneficiário (código do convênio), com 5 dígitos | Identifica o convênio de cobrança em todas as chamadas e compõe o usuário da autenticação | | Cooperativa (4 dígitos) e posto (2 dígitos) da conta | Junto com o código do beneficiário, identificam a conta. O posto costuma faltar na documentação entregue | | Habilitação de boletos híbridos (Pix), quando o cliente quiser QR Code no boleto | Sem isso o boleto sai sem QR Code. É solicitação ao Sicredi, não configuração do Mestre | | Acesso ao Internet Banking com perfil master na conta do convênio | É quem consegue gerar o Código de Acesso usado como senha da API |
2. Gerar o Código de Acesso no Internet BankingO Código de Acesso é a senha da API. Ele não é a senha do Internet Banking e é gerado pelo próprio cliente: | 1 | Entrar no Internet Banking com perfil master, na conta vinculada ao convênio de Cobrança. | | 2 | Acessar Cobrança > Código de Acesso > Gerar. | | 3 | Confirmar a geração conforme o Sicredi solicitar (a validação costuma ser feita pelo aplicativo, pelo titular). | | 4 | Guardar o código: ele será informado no campo Password da carteira. |
Gere e cadastre no mesmo atendimento O Sicredi disponibiliza o código por 24 horas; passado esse prazo é preciso gerar outro. O código também é por conta: cliente com mais de uma conta em cobrança gera um código para cada uma. Se, mais tarde, a autenticação passar a falhar, gere um novo código e atualize o campo Password da carteira. |
3. Montar o usuário da APIO usuário não é um dado novo: é a junção de dois que o cliente já tem. | Credencial | Como se forma |
|---|
| Username | Código do beneficiário (5 dígitos) seguido da cooperativa (4 dígitos), totalizando 9 dígitos, sem espaços nem separadores | | Password | O Código de Acesso gerado no Internet Banking | | Token de Acesso (chave da aplicação) | Não é do cliente: é o token da Mestre Sistemas como integradora, já configurado no sistema. O campo nem aparece na carteira |
Por isso, não é necessário criar conta nem aplicação no portal do desenvolvedor do Sicredi para usar o Mestre. Se o atendimento começar por aí, está no caminho errado. 4. Configurar a carteira de cobrançaAbra a rotina Carteiras de cobrança, localize a carteira do cliente (ou cadastre conforme o contrato) e marque Utilizar WebService. Ao escolher a Versão da API, os rótulos dos campos mudam para o vocabulário do Sicredi. | Campo | O que informar |
|---|
| Banco | 748 - Sicredi | | Agência | A cooperativa (4 dígitos) | | Posto | O PA da conta, com 2 dígitos. O Mestre recusa o envio quando o posto não tem dois dígitos | | Nº Conta e dígito | A conta corrente do convênio | | Código do cedente | O código do beneficiário (5 dígitos) | | Emissor | Banco | | Utilizar WebService | Marcado | | Versão da API | Sicredi - API V2. Sem esse campo o Mestre não encontra o provedor e a tela não sabe quais credenciais exibir | | Escopo | Sicredi - API V2 | | Username | Os 9 dígitos do beneficiário + cooperativa | | Password | O Código de Acesso gerado no Internet Banking | | Time Out | 60000 (padrão de uma carteira nova) | | Boleto Híbrido (com PIX) | Marque apenas se o boleto híbrido estiver habilitado pelo Sicredi | | Utilizar layout de impressão padrão do Banco | Marque para imprimir o PDF oficial do Sicredi. Desmarcado, o boleto sai pelo layout do Mestre | | Data Retorno | A data já conciliada. A consulta de liquidações começa no dia seguinte a ela |
Os campos Certificado e Token de Acesso não aparecem nesta versão de API: a Cobrança do Sicredi é a API do banco que não usa certificado, e a chave de aplicação é a da Mestre. A faixa de nosso número continua na aba de cobrança escritural e não participa da emissão por API. 5. Conferir o ambiente antes do testeO ambiente da cobrança por API não fica na carteira: ele vem da tela Documentos fiscais eletrônicos - Configuração, campo Ambiente — o mesmo que vale para a NF-e. Em homologação nada do cliente é testado Com a empresa em Homologação, o Mestre usa os dados fixos de teste publicados pelo Sicredi — usuário, senha, cooperativa, posto e beneficiário do manual — e não os do cliente. O boleto responde, mas não existe no banco e nada do que foi cadastrado é testado. A configuração do cliente só se prova com o ambiente em Produção. Lembre que virar esse campo afeta a emissão fiscal da empresa inteira, não só o boleto. |
6. Liberação de redeNão é preciso abrir porta de entrada nem cadastrar o IP do cliente. O computador ou servidor onde o Mestre roda precisa conseguir iniciar conexões de saída HTTPS (TCP 443) para: | api-parceiro.sicredi.com.br |
7. Emitir o primeiro boleto- Gere um título de teste, de valor baixo, na carteira configurada.
- Grave o boleto: é na gravação que o registro é enviado ao Sicredi.
- Confira se voltaram nosso número, linha digitável e código de barras. O Mestre recusa o registro que chegar sem esses dados.
- Imprima o boleto e confira o QR Code, quando o boleto híbrido estiver habilitado.
- Confirme com o cliente que o título aparece na cobrança do Sicredi.
Implantação concluída Considere a implantação concluída apenas depois que um boleto for registrado com sucesso em produção, com linha digitável e código de barras conferidos. |
8. Trazer as liquidações (retorno)Com a carteira por API não existe arquivo de retorno para baixar. Em Contas a Receber > Cobrança > Retorno, escolha a carteira e clique em Processar: o Mestre consulta os títulos liquidados direto no Sicredi. - A consulta vai dia a dia, do dia seguinte à Data Retorno até o dia anterior ao de hoje — o banco só fecha o movimento depois do expediente.
- Cada dia consultado com sucesso avança a Data Retorno, e o log mostra o que foi processado.
- Na implantação, ajuste a Data Retorno para o último dia já conciliado, para não reprocessar nem pular liquidação.
Como o Mestre faz O Mestre conversa com o Sicredi por implementação própria, sem componente de terceiros, e o que ele mostra na tela é o que o banco respondeu: - Registra o título na gravação do boleto e também na emissão automática pela finalização da nota.
- Nunca calcula linha digitável, código de barras ou nosso número: registro cuja resposta venha incompleta é tratado como falha, e não vira boleto “meio pronto”.
- Envia prorrogação, baixa, abatimento, desconto e juros na hora em que o movimento é gravado, uma instrução por chamada, como a API exige.
- Busca o PDF oficial do boleto pela linha digitável logo após o registro, quando a carteira usa a impressão do banco; se o banco não devolver o PDF, o boleto continua válido e sai pelo layout do Mestre.
- Envia as mensagens ao pagador em até quatro linhas de 80 caracteres, que é o limite aceito pelo Sicredi.
- Grava a requisição e a resposta de cada operação, com a URL e o status, para diagnóstico posterior.
|
Checklist de conferência- Cobrança contratada na modalidade API (Cobrança Online) e código do beneficiário em mãos.
- Código de Acesso gerado no Internet Banking, na conta do convênio, e cadastrado no mesmo atendimento.
- Posto confirmado com o cliente, com dois dígitos, e não copiado de outra implantação.
- Carteira com Banco 748, Utilizar WebService, Versão da API, Escopo, Username e Password preenchidos.
- Agência (cooperativa), conta e Código do cedente conferem com o convênio.
- Ambiente da configuração fiscal em Produção.
- Boleto de teste registrado, com nosso número, linha digitável e código de barras.
- Data Retorno ajustada antes do primeiro processamento de retorno.
Erros comuns e como evitar - “Beneficiário inativo ou não encontrado” — na prática, quase sempre é o posto errado. O erro não cita o posto e o código do beneficiário sai correto na requisição, o que joga a suspeita para a habilitação da conta. Confirme o PA antes de abrir chamado no banco.
- “O posto da carteira precisa de dois dígitos” — o próprio Mestre barra antes de enviar. Preencha o posto com dois dígitos, incluindo o zero à esquerda.
- Falha de autenticação — Username fora do formato de 9 dígitos, ou Código de Acesso vencido. Gere um novo código no Internet Banking e atualize o campo Password.
- Menu de Código de Acesso não aparece — o convênio não está na modalidade API (Cobrança Online). É liberação da cooperativa.
- Boleto sem QR Code — boleto híbrido não habilitado. Enquanto isso não se resolve com o Sicredi, desmarque “Boleto Híbrido (com PIX)” e emita boleto comum.
- Cancelamento de abatimento recusado — a API V2 do Sicredi não tem essa instrução. O Mestre avisa explicitamente em vez de fingir que enviou.
- Retorno “sem nada a consultar” — a Data Retorno já está no dia de ontem ou à frente. O movimento do dia corrente só fica disponível depois do fechamento no banco.
|
FontesFluxo em uma linha Cooperativa habilita a modalidade API → cliente gera o Código de Acesso no Internet Banking → suporte monta o Username com beneficiário + cooperativa → confirma o posto → configura a carteira → confere o ambiente → emite o boleto de teste. |
Revisão: setembro de 2026 — Mestre 9.0.1, API Cobrança V2 do Sicredi. Campos, mensagens e comportamento conferidos no fonte do provedor e na tela de Carteiras de cobrança; etapas do banco conferidas na documentação pública do Portal de Desenvolvedores do Sicredi. |