Linha RM

Atalhos

Páginas filhas
  • Registro Online SICOOB

01. VISÃO GERAL

Este recurso tem como objetivo preparar o TOTVS Gestão Financeira para utilizar o serviço de registro online da carteira de cobrança registrada do Banco SICOOB.

02. CONFIGURAÇÃO

No cadastro do convênio, na aba 'Registro Online' deve ser marcado a opção "Permite registro de boleto online".

Modelo v1:

  • URL do serviço de registro do boleto: Deve ser informada a URL do serviço de registro do boleto disponibilizada pelo Banco
  • URL do sistema autorizador: Deve ser informada a URL do serviço de autorização disponibilizado pelo Banco
  • Client Id e Client Secret: Código do sistema de autorização fornecido pelo Banco
  • URL de Callback: URL de Callback que deve ser informada na geração do código de autorização, onde o mesmo será exibido. (http://[servidor]/Corpore.Net/Source/Fin-Financeiro/RM.Fin.Banco/SicoobCallback.aspx) - 
  • Código de autorização: Código de acesso do sistema de autorização para criação de tokens. Deve ser gerada no portal do Banco.

Importante:

  • O campo "Refresh token" está disponível apenas no modelo de registro online "v1". Ao ser gerado o código de autorização e informado no cadastro do convênio, deve ser obtido o refresh token clicando no botão. Esse refresh token será usado para obter o acess token necessário para registro do boleto no banco. Somente é preciso obter o refresh token uma vez
  • O código de autorização expira em 5 minutos, ou seja, o mesmo deve ser utilizado nesse tempo para obter o refresh token

           Modelo v2:

  • URL do serviço de registro do boleto: Deve ser informada a URL do serviço de registro do boleto disponibilizada pelo Banco
  • URL do sistema autorizador: Deve ser informada a URL do serviço de autorização disponibilizado pelo Banco
  • Client Id : Código do sistema de autorização fornecido pelo Banco
  • Certificado digital: Certificado digital cadastrado junto ao Banco para o registro de boleto online. (Disponível apenas no modelo v2)

Importante:

  • O Modelo de registro online "v2" está disponível a partir do patch 12.1.2302.152.
  • Informações de como gerar o certificado é necessário verificar as instruções disponíveis na documentação da API. Dúvidas a respeito, recomendamos entrar em contato com o suporte do Banco.

https://developers.sicoob.com.br/portal/documentacao?slugItem=apis-do-sicoob&slugSubItem=primeiros-passos

https://developers.sicoob.com.br/portal/documentacao?slugItem=seguranca&slugSubItem=certificado-digital


03. LAYOUT

Para enviar dados de forma flexível para o registro online dos boletos para o banco, devem ser criados os campos, primeiramente via anexo "Layout Registro Online" disponível no cadastro de Bancos e Agências. Os campos devem ser criados conforme manual de cobrança do SICOOB (https://developers.sicoob.com.br/#!/documentacao). Esses campos devem ser associados a fórmulas ou valores fixos, via anexo "Associação do Layout do Registro Online" no cadastro do convênio. Alguns exemplos abaixo:

dataLimitePagamento

tipoMulta

Notas:

  • Se no lançamento financeiro o campo 'Multa' for maior que 0 (zero), a tag tipoMulta será preenchida com o valor "1". Do contrário, se multa ao dia for maior que 0 (zero), a tag será preenchida com o valor "2". Por último, quando ambos 0 (zero), esta tag será preenchida com o valor "0"
  • Para os dois primeiros casos a tag dataMulta será preenchida com a data de vencimento acrescida do campo "Dias atraso multa". No último caso, será preenchida com valor nulo.
  • Códigos da Multa, segundo o Sicoob: 

         '0' = Isento 
         '1' = Valor Fixo 
         '2' = Percentual

dataMulta

valorMulta

tipoJurosMora

Notas: 

  • Se no lançamento financeiro o valor de juros ao dia for maior que 0 (zero) e o tipo de juros ao dia como "Valor", a tag tipoJurosMora será gerada com o valor "1". Caso contrário, se o campo 'Juros' for maior que 0 (zero), a tag será preenchida com o valor "2". Por último, se ambos valores de juros for igual a 0 (zero) esta tag será preenchida com o valor "0"
  • Para os dois primeiros casos a tag dataJurosMora será preenchida com a data de vencimento acrescida da carência de juros (campo do lançamento financeiro). No último caso, será preenchida com valor nulo.
  • Código do Juros de Mora, segundo o SICOOB: 

         '0' = Isento 
         '1' = Valor por Dia 
         '2' = Taxa Mensal 

dataJurosMora

valorJurosMora

pagador.numeroCpfCnpj

pagador.nome

        mensagensInstrucao.mensagens1

        mensagensInstrucao.mensagens2

        mensagensInstrucao.mensagens3

        mensagensInstrucao.mensagens4

        mensagensInstrucao.mensagens5

04. EXEMPLO DE UTILIZAÇÃO V1

Exemplo de geração do código de autorização.

A URL para gerar o código de autorização tem o seguinte formato:

https://api.sisbr.com.br/auth/oauth2/authorize?response_type=code&redirect_uri=[[callback_url]]&client_id=[[client_id]]&versaoHash=3&scope=[[escopos]], onde

[[callback_url]] = URL de callback informada no convênio

[[client_id]] = client id informado no convênio

[[escopos]] = cobranca_boletos_incluir