Mudanças entre as edições de "Integração API Sicredi"
Linha 132: | Linha 132: | ||
<b>urlWebhook</b>: Url de callback que foi utilizada para registro no Sicredi. | <b>urlWebhook</b>: Url de callback que foi utilizada para registro no Sicredi. | ||
== Funcionalidades == | |||
Antes de prosseguir, verifique se os processamentos específicos, indicadores e relatórios específicos foram liberados para o usuário responsável pela utilização da API. |
Edição das 12h19min de 26 de julho de 2024
APIs de Recebimento Sicredi
Documentação para utilização das APIs de Cobrança do Sicredi para permitir realizar envio e retorno de remessas bancárias sem utilizar a troca de arquivos, além da emissão de Boletos Híbridos.
Boletos Híbridos
O boleto híbrido é o meio de cobrança que utiliza as funcionalidades do recebimento por PIX e por Boleto no mesmo documento de pagamento.
O recebimento por QRCode é identificado de forma imediata pelo Sicredi.
Credenciais
Será necessário contratar junto ao gerente da conta do Sicredi a modalidade da API para Cobrança Online. Ao contratar o produto, será disponibilizado o código do beneficiário (código do convênio) , importante para utilização da integração.
Será necessário acessar o portal de desenvolvedor do Sicredi (https://developer.sicredi.com.br/api-portal/pt-br) para criar as credenciais de Homologação e Produção.
Credenciais necessárias
- Código do Beneficiário
- Token (Homologação)
- Token (Produção)
Configurações do Sistema
Necessário solicitar liberação da funcionalidade licenciada ao setor responsável: INTEGRACAO_API_SICREDI
Cadastro da Conta Corrente
Incluir ou alterar cadastro da conta corrente que será utilizada para integração com o Sicredi.
Preencher os dados:
- Registro/Endereço: CNPJ/CEI, Inscrição Estadual e Endereço Completo;
- Informações Bancárias: Banco, Agência, Conta e Digito Conta, Titular e Documento do Titular;
- Padrões da Remessa: Descrição, Carteira, Lay-Out Remessa, Lay-Out Impressão Boleto;
Atenção aos campos:
- Descrição Padrão de Remessa: preencher descrição como API_SICREDI;
- Próximo Slip: Sem necessidade de informar, será gerado pelo Sicredi no momento da geração da remessa bancária;
- Layout Config Remessa: Utilizar layout padrão SICREDI: INTEGRAÇÃO COM API – REMESSA;
- Layout Config Boleto: Sem necessidade de configurar, boleto será impresso pelo Sicredi através da Api.
Configurações da Unidade de Codificação
Incluir na TekStore da conta do Suporte a unidade de codificação correspondente as configurações que serão utilizadas para Api do Sicredi. Seguir padrão JSON já conhecido para as demais integrações.
Nome da Unit deverá ser P10_SICREDI_CONFIGURACAO_XXXX. Onde XXXX corresponde ao código do cliente cadastrado na Tek-System.
Exemplo de configuração:
[ { "contaBancaria": 0, "ambiente": "HOMOLOGACAO", "_comentario_": "Conta 0 - Usada em Requisições sem Autenticação - Não remover - É necessária!" }, { "contaBancaria": 0, "_comentario_": "Api Sicredi", "ambiente": "HOMOLOGACAO", "token_sandbox": "", "token_producao": "", "username_producao": "", "password_producao": "", "cooperativa": "", "posto": "", "codigoBeneficiario": "", "autoIncPadraoRemessa": 0, "tipoTitulo": "A", "protestar": false, "diasAposVencimentoParaProtestar": 0, "instrucaoNegativacao": false, "diasAposVencimentoParaNegativar": 0, "vlrTxMulta": "00000.00", "diasAposVencimentoParaAceitarRecebimento": 0, "tipoDescontoBoleto": "B", "vlrDescontoAtencipado": "00000000000000.00", "mensagemBoleto1": "", "mensagemBoleto2": "", "mensagemBoleto3": "", "mensagemBoleto4": "", "tokenWebhookTekSystem": "", "urlWebhook": "" } ]
Descrição dos campos:
contaBancaria: Código da conta corrente do Sicredi cadastrada no sistema Tek-System;
ambiente: Informar qual ambiente a conta está sendo utilizada. PRODUCAO/HOMOLOGACAO;
token_sandbox: Token que será utilizado para geração do Token da API em ambiente Sandbox;
Observação sobre o ambiente Sandbox: Apesar de existir, não é possível realizar uma validação completa. Sugerimos que utilize o ambiente de produção com valores pequenos adotando alguns cuidados: a) Contate o gerente da conta para comunicar sobre o teste, solicitando isenção das taxas cobradas pelas operações; b) Contate o contador da empresa solicitando orientações sobre a forma que irá conduzir os testes (considerando que haverá movimentação financeira na conta); c) Após os testes, analise minunciosamente os extratos e relatórios de movimento na conta, observando os reflexos das operações.
token_producao: Token gerado no Sicredi que será utilizado para geração do Token da API em ambiente Produção;
AutoIncPadraoRemessa: Corresponde a sequência do cadastro de padrão da remessa da conta corrente.
TipoTitulo: Indica a espécie do título que será enviado na remessa bancária. Utilizar A-Duplicata Mercantil Indicação;
protestar: Indicar true/false para protesto dos títulos. O protesto é a ação através da qual o portador de um título comercial cujo pagamento não foi efetuado dentro do prazo, garante seu pagamento por ações judiciais. Utilizar apenas se instrução de negativação não for utilizado;
diasAposVencimentoParaProtestar: Indica quantidade de dias após vencimento para protesto do título. Informar apenas se protestar for verdadeiro. Caso contrário, campo será desconsiderado;
instrucaoNegativacao: Indicar true/false para negativação dos títulos. A negativação é o ato de inserir uma pessoa em cadastros de maus pagadores, tais como Serasa e o Serviço Central de Proteção ao Crédito (SCPC), porque não pagou uma conta, uma prestação ou outra obrigação financeira. Utilizar apenas se instrução de protesto não for utilizado;
diasAposVencimentoParaNegativar: Indica quantidade de dias após vencimento para negativação do título. Informar apenas se protestar for verdadeiro. Caso contrário, campo será desconsiderado;
taxaMulta: Informar percentual para valor de multa. Ex: 02.00;
mensagemBoleto1: Primeira mensagem individual a ser impressa no boleto. Limite de 80 caracteres. Uso opcional;
mensagemBoleto2: Segunda mensagem individual a ser impressa no boleto. Limite de 80 caracteres. Uso opcional;
mensagemBoleto3: Terceira mensagem individual a ser impressa no boleto. Limite de 80 caracteres. Uso opcional;
mensagemBoleto4: Quarta mensagem individual a ser impressa no boleto. Limite de 80 caracteres. Uso opcional;
diasAposVencimentoParaAceitarRecebimento: indica a quantidade de dias corridos após Data de Vencimento, em que a cobrança do Boleto poderá ser paga;
tipoDescontoBoleto: indica o tipo de desconto do boleto. Podendo ser as opções: A - VALOR e B - PERCENTUAL;
tokenWebhookTekSystem: token da configuração do cliente cadastrada na TekHook.
urlWebhook: Url de callback que foi utilizada para registro no Sicredi.
Funcionalidades
Antes de prosseguir, verifique se os processamentos específicos, indicadores e relatórios específicos foram liberados para o usuário responsável pela utilização da API.