Emissão Automática de Boletos - API
O que é necessário saber antes de configurar ?
- Contratar o plano de acordo com a quantidade de boletos mensal.
- Solicitar ao banco a emissão de boletos pela API. Pode haver interpretações por parte do banco, explique que é para emitir o boleto usando a API e não o arquivo de remessa.
Deve ser realizado a contratação do serviço junto ao banco. Inclusive com a opção de emitir o PIX com o boleto.
Importante estar atento para não afetar o que o cliente já tenha contratado.
Como configurar no sistema
Passo a passo de como configurar a emissão de boletos pela API, no sistema.
As instruções a seguir têm como objetivo orientar a configuração da emissão, abordando os requisitos técnicos necessários. Este guia não fornecerá explicações sobre como acessar as configurações nem sobre conceitos como portador e conta. É importante ter um bom entendimento do processo para evitar possíveis problemas.
Portador
Cadastrar um novo portador no contas a receber.
Ind.Tipo deve ser 2 - Banco.
Ind.Cob.Banco: Escolher o banco.
Configurações
| Chave | Valor | Observação |
|---|---|---|
| Tipo Boleto | Escolher opção | Escolher o formato que será impresso |
| ID Portador Boletos | 0 (padrão) | Portador padrão do sistema |
| Versão | 1 - Modelo Novo |
Configuração ID.Origem do Portador
Entrar na configuração com ID.Origem do portador (pode ser acessado pelas configurações no cadastro do portador).
Considerar que cada banco tenha as suas configurações específicas.
SICREDI
Grupo API
Será necessário solicitar as credenciais para o banco.
| Chave | Valor | Observação |
|---|---|---|
| Ambiente | 1- Produção | |
| Usuário | ****** | Fornecido pelo banco |
| Senha | ****** | Fornecido pelo banco ou internet banking |
| X-API-KEY | ****** | Access token gerado pelo portal do desenvolvedor |
Grupo Banco
Preencher conforme o cadastro do cliente com o banco e suas necessidades de emissão.
Grupo Geral
Essas são as configurações padrões, podem haver mais chaves no sistema de situações específicas.
| Chave | Valor | Observação |
|---|---|---|
| Tipo de Envio | 0 - API | |
| Tipo de Registro | 0 - Obrigar registro | |
| Tipo de Cobrança | 0 - Normal: somente boleto
1 - Híbrido: boleto e pix. |
Verificar no contrato cliente/banco. |
| IDEmpresa | Define a empresa responsável pelo boleto | |
| Gerar Dados | Habilitar todas | Opção que o sistema irá gerar para o boleto. Verificar no contrato cliente/banco. |
| Prefixo | 3 até 9 | Valor fixo na máscara do boleto. É necessário verificar os boletos já emitidos e sua máscara para evitar duplicidade |
| Sequencial | Sequencial dos boleto. | |
| Data Consulta | Deixar em branco | Sistema armazena a data do dia anterior para o uso do retorno. |
Tipo de pagamento
Cadastrar Ind.Boleto API no cadastro de Tipo de pagamento.
Cadastrar as empresas a partir do tipo de pagamento.
Cadastrar o boleto e vincular o portador para a empresa.