GF - Como Fazer - Open Banking para Banco Santander

De CIGAM WIKI


Objetivo

[editar]

Este manual tem por objetivo instruir alguém que já tenha lido o manual geral do Open Banking CIGAM a realizar todo o processo de parametrização e início do uso da API bancária do Santander.

Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações específicas do Santander para o Open Banking. Para dúvidas gerais referentes a funcionalidades gerais do Open Banking consulte o manual Open Banking Geral.

APIs disponíveis e serviços atendidos pelo CIGAM

[editar]

Funcionalidade Versão
Registro de Cobrança Simples e vinculada 231002.b
Alteração de Vencimento 231002.b
Alteração de Juros e Multa 231002.b
Baixa de título 231002.b
Protesto 231002.b
Retorno de Cobrança 231002.b
Demais alterações (endereço, desconto por antecipação, etc) Não tratados no CIGAM
QR CODE no Boleto 231002.b
API de PIX avulso (QR Code dinâmico ECF Lojas) 240603.b
Abatimentos 251103.BETA

Open Banking Santander

[editar]

Obtenção de credenciais - Santander

[editar]

As credenciais do Santander são geradas através do Portal Developers. Para maiores informações, entre em contato com o seu gerente de cash e siga os passos do manual API de Cobrança Santander para obtenção do token.

IMPORTANTE: na seção "2.1 Portal do Desenvolvedor" no trecho "Na aba de criação da “Nova aplicação” temos dois tipos de aplicações. Verifique abaixo as regras de cada tipo, para decidir a qual será a opção ideal para você (Sou um desenvolvedor | Utilizo um parceiro):" utilize a opção sou um desenvolvedor e carregue seu proprio certificado A1 (mesmo certificado da nota fiscal).

Instruções para troca/renovação do certificado digital - Santander

[editar]

A renovação do certificado digital utilizado nas credenciais do Santander é composta por ações semelhantes às do primeiro credenciamento. Contate o seu gerente de Cash para maiores informações.

Refere-se ao certificado A1, o mesmo da NF. Ao gerar as credenciais, é necessário adicionar o certificado, via Portal Developers do Banco.

Para a troca do certificado no CIGAM em cenários onde o novo certificado manter o CN e alterar somente sua validade basta remover o antigo e instalar o atual. Para validar se a configuração Open Banking está utilizando o novo certificado entre nas Credenciais dos Parâmetros Open Banking e verifique se o campo "Status do Certificado" foi atualizado:


Para mais informações de instalação do certificado acesse a FAQ sobre instalação e revisão do certificado digital.

Assistente Open Banking - Santander

[editar]

Abertura do assistente: Ao abrir o assistente serão apresentadas as informações necessárias para a configuração do Santander.


Passo 1: Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um. O Santander não disponibiliza ambientes de teste, desta forma, preencha apenas os dados da guia "Produção", caso você tenha a necessidade de cadastrar alguns títulos de teste, utilize o campo “Etapa Processo do Boleto" como Teste.

    a. Client Id: cole aqui a informação obtida no Portal Developers do santander conforme o item Obtenção de credenciais deste manual;
    b. Client Secret: cole aqui a informação obtida no Portal Developers do santander conforme o item Obtenção de credenciais deste manual;
    c. Etapa Processo do Boleto: Aqui é onde existe a possibilidade de realizar registros de testes no Santander, a opção “etapa processo” permite realizar registros em ambiente não produtivo conforme abaixo:

      01 – Produção: este é o formato oficial onde os títulos serão registrados em ambiente de produção.
      02 – Teste: mantendo este parâmetro, os títulos serão enviados para um ambiente de testes restritos (apenas registro, sem possibilidade de alteração uma vez que o título não fica registrado, apenas é feita uma validação inicial).

    d. Versão da API: campo preenchido automaticamente pelo CIGAM;
    e. Certificado: informe aqui o “subject/requerente” do certificado digital do cliente. Essa informação é obtida no campo de mesmo nome na guia “detalhes” do certificado digital conforme abaixo:

    f. Status do Certificado: este campo será preenchido automaticamente com a data e hora de expiração do certificado informado no item acima. Caso não haja este preenchimento, significa que o mesmo não se encontra instalado corretamente, revise a sua instalação e tente novamente.
    g. URL Webhook: informe o site que irá receber os retornos do Santander quanto às alterações dos títulos. Esta informação é imprescindível para o uso do retorno de liquidação via data de liquidação, sem ela, o Santander somente permite o retorno via data de vencimento ou emissão. Os requisitos para um site ser aceito como WebHook estão listados na seção Requisitos para o Site a ser apontado como Webhook. A sugestão é utilizar o site da sua própria empresa, porém este ainda pode não ser aceito. Para saber se o site foi aceito, deve-se checar o campo “workspace” nos parâmetros open banking do Santander após a configuração, se ele estiver preenchido, o processo teve sucesso.
    h. Usuário para Alerta: informe aqui o usuário que receberá os alertas de vencimento do certificado digital utilizado na parametrização. Esta informação é muito importante pois o processo de renovação junto ao SANTANDER pode levar alguns dias e não será possível registrar títulos com um certificado vencido.
    i. Url Autorização: campo preenchido automaticamente pelo CIGAM;
    j. Url API: campo preenchido automaticamente pelo CIGAM.


Passo 2: Este passo diz respeito à seleção de convênios, ela é uma característica do Santander e serve para que possa ser apontado o convênio para o qual as credenciais geradas serão válidas. O CIGAM irá apresentar todos os códigos de convênios localizados dentre os portadores cujo código de banco é “033”.


Passo 3: Neste passo você irá informar os portadores de remessa e retorno que serão utilizados para esta parametrização do Open Banking, aqui você pode informar mais de um portador, por exemplo, o de carteira SIMPLES e o de carteira DESCONTADA e ambos utilizarão a mesma instancia de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

A opção “Direto” está detalhada no manual de funcionalidades Open Banking, já a opção PIX será detalhada mais a frente neste manual.


Passo 4: o passo 4 serve para realizar o apontamento do relatório de remessa que servirá como padrão tanto para a rotina de registro quanto para retorno do Open Banking. O CIGAM irá sugerir o caminho padrão para o modelo de relatório (RF00071), mas caso os seus modelos sejam salvos em algum outro local, basta alterá-lo neste momento, após, clique em “avançar”.

Pronto! Caso tenha dado tudo certo com as suas credenciais, o CIGAM irá emitir uma mensagem de sucesso para cada um dos ambientes para o qual você informou as credenciais.

Após clicar em “concluir” você será apresentado à tela “Parâmetros” Open Banking (conforme abaixo), você encontrará o descritivo de cada área dela no Tela de parâmetros Open Banking no manual Open Banking Geral.

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco Santander, os serviços disponíveis para ele estão na tabela apresentada no início deste manual. Nas sessões a seguir estarão descritas apenas as características específicas do Santander. Demais instruções de uso do open banking estão no manual Open Banking Geral.

Atenção: Revise se na tela de credenciais o workspace foi gerado corretamente, caso esteja em branco consulte a FAQ sobre erro de credenciais.

Requisitos para o Site a ser apontado como Webhook

[editar]

  • URL ativa em GET e POST;
  • Categorizada no site https://talosintelligence.com/;
  • A URL tem que ser https, não pode ser http, por conta do mTLS;
  • Ela precisa aceitar qualquer requisição em GET para cadastro.

Devem ser previstas do lado da empresa a implementação de boas práticas relacionadas as configurações da URL:

  • Monitoramento da URL. Certificar-se de que esteja online, ativa e devidamente categorizada;
  • Registro de URLs HTTPs;
  • Liberação das portas 443 e 80;
  • URL estar apta a receber POST com o body vazio (para etapa de cadastro da Workspace com Webhook);
  • URL estar apta a receber POST com o CONTENT_TYPE application/json;
  • Envie uma reposta HTTP adequada para o remetente do Webhook, como um código de status 200 (OK), para indicar que o recebimento foi bem-sucedido. O envio deve ser realizado imediatamente após a recepção da mensagem;
  • Tratativa de notificações duplicadas.

Ambiente de testes - Santander

[editar]

Atualmente não é disponibilizado o ambiente de testes do Santander, para registrar títulos nesta modalidade é necessário utilizar a opção “Teste” disponível nos parâmetros open banking no campo “Etapa Processo do Boleto”, neste formato os títulos são enviados para um ambiente de testes onde é possível realizar o registro, mas não alteração e retorno de títulos.

Registro de cobrança - Santander

[editar]

O registro do Santander é, de maneira geral, realizado como todos os outros bancos, abaixo seguem algumas explicações exclusivas.

Particularidades do cadastro de Portador - Santander

[editar]

- Protesto e Negativação: O Santander possui apenas o serviço de protesto.

- Convenio: tenha o convênio informado corretamente conforme recebido através do e-mail do Santander, essa informação é essenciais para a correta geração do workspace. Para mais informações sobre a geração do workspace consulte a FAQ.

Impressão de QR Code no Boleto - Santander

[editar]

Uma empresa que queira emitir QR Codes em seus boletos deve possuir credenciais com pix e seguir os itens abaixo:

  • marcar a opção “PIX” dos parâmetros open banking;
  • possuir a TAG qrcode_pix no seu modelo de boleto caminho para modelo padrão salvo em: I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098 - Santander_pix.rtf

A Chave pix será obtida no cadastro do portador de remessa:

Observação 1: Necessário direito de Menu GF Configurações e configuração 3099 - GF - GE Permitir acesso aos Parâmetros PIX marcada para o usuário para acesso ao botão Parâmetros PIX.

Observação 2: Caso o tipo de chave seja "Celular" deve-se utilizar a seguinte mácara: +55DDDNUMERO. Exemplo: +5551998899776.

Impressão do boleto com QR Code:

Particularidades de baixa - Santander

[editar]

O Santander permite a baixa do título após 1 minuto do registro.

Retorno de cobrança - Santander

[editar]

A rotina de retorno do Santander funciona da forma padrão com exceção da explicação contida no botão de alerta disponível na rotina:



Busca Liquidações por:

  • Vencimento e/ou Data Emissão: habilita os filtros UN, Empresa, Lançamento, Vencimento, Data e Situação do Boleto.
    • [Versão 231002.d 1] Situação do Boleto: Neste filtro teremos duas opções.
      • Todos: retornará todos lançamentos registrados independente da situação (entrada, baixado ou liquidado).
      • Somente Abertos: retornará somente lançamentos registrados com situação em aberto (entrada).

  • [Versão 241007.d 1] Data Liquidação: Este retorno funciona na modalidade “listagem” e mostrará todos os títulos encontrados no Santander com a data de liquidação informada, independente dele existir no CIGAM. Este formato de retorno somente está disponível para os clientes que possuem o serviço WEBHOOK ativo e somente retorna títulos registrados após a sua ativação, títulos anteriores à sua ativação não serão apresentados. É importante destacar que esta funcionalidade somente foi liberada na versão 241007.d e que se as suas credenciais tiverem sido geradas em versões anteriores, ou seja, sem a informação da URL Webhook, você precisará excluir as credenciais atuais e parametrizá-las novamente. Aqui você encontra informações de como excluir e reinserir credenciais.

Alterações de títulos registrados Via Open Banking

[editar]

Abatimento de títulos

[editar]

[Versão 251103 1]Este recurso permite realizar o registro e cancelamento de abatimentos de forma integrada ao Open Banking no CIGAM. Por meio da configuração de um portador específico do tipo Abatimento, o sistema identifica automaticamente as liquidações relacionadas, gera os comandos bancários necessários e envia as informações aos bancos homologados, tornando o processo mais ágil, seguro e automatizado.

Registro de Abatimento

[editar]

Para instruções completas de uso, consulte o manual Como Fazer - Open Banking - Abatimento de títulos.

Cancelamento de abatimento

[editar]

Para instruções completas de uso, consulte o manual Como Fazer - Open Banking - Cancelamento de abatimento.

Retenção P/C/C - PIS, COFINS, CSLL

[editar]

Para quem utiliza o recurso de Controlar Retenções na Saída, ou seja, configuração GF - GE - 2505 - Código de imposto para controlar retenção de CSLL na saída, e deseja registrar o lançamento financeiro no valor líquido, já descontando as retenções, é necessário:

Para mais informações de como funciona esse recurso, consulte a WIKI OS 816297/10 – Retenções P/C/C + Boletos + CNAB e Open Banking.

Para informações sobre o uso do Controle das Retenções na Saída, consulte GF - Como Fazer - Controlar Retenções de PIS-COFINS-CSSL-IRRF-INSS-ISS para Nota Fiscal de Saída.

CNPJ Alfanumérico

[editar]

Campo CNPJ, já é atendido no formato Alfanumérico.

Documentos Relacionados

[editar]

Documentação Santander

[editar]

Versões

[editar]

Versão 231002

[editar]

Patch 'd'

[editar]
  1. ↑ Liberado a partir da OS 816822/4.

Versão 241007

[editar]

Patch 'd'

[editar]
  1. ↑ Liberado a partir da OS 816834/11.

Versão 251103

[editar]
  1. ↑ Liberado a partir da OS 816297/7.
Disponível em “https://www.cigam.com.br/wiki/index.php?title=GF_-_Como_Fazer_-_Open_Banking_para_Banco_Santander&oldid=157463”