FAQ - Open Banking para Banco Itaú

De CIGAM WIKI
Revisão de 20h24min de 28 de agosto de 2023 por Augusto.oliveira (discussão | contribs) (Erros comuns de retorno)

FAQ_CIGAM > FAQ_Finanças > Gestão Financeira > FAQ - Open Banking para Banco Itaú

Erros comuns de configuração

Erros comuns de certificado

Certificado não encontrado

Caso o erro abaixo aconteça (Certificado não encontrado!):

FAQ Certificado nao encontrado.png

Um dos motivos para este erro acontecer é que a conversão pelo OpenSSL ou similar não foi feita e o certificado instalado foi o *.cer ao invés do *.pfx ou houve algum erro na hora da instalação, abaixo seguem as opções necessárias para a instalação correta:

FAQ Instrucoes de Instalacao Certificado.png

Erros comuns de registro

Erro na validação de campos

Mensagem: O campo logradouro possui caracteres especiais não aceitos

No cadastro de empresas no CIGAM é permitido informar 30 caracteres em seus campos de texto, já a máscara dos campos da API de registro é 20 caracteres. A partir da RC 230502 o JSON de envio terá sua máscara condizente com a API através da OS 782916/5.


JSON de envio antes
FAQ Itau antes.png


Mensagem: O campo nome do pagador possui restrição de alguns caracteres ou palavras especiais.

A partir da os 782916/5 (RC 230502) o JSON de envio tratará caracteres especiais em todos campos de texto de acordo com a API.

Retorno em branco ao tentar registrar um título

Quando a parametrização de credenciais de Open Banking do Itaú via Assistente de Configuração do Open Banking do CIGAM informar que a comunicação foi realizada corretamente (sinaleira na cor verde), porém, ao tentar registrar um título ocorre Erro e não há informação nenhuma na guia "Retorno" no Histórico Open Banking, verificar se o Scope das credenciais fornecidades está correto possuindo as devidas autorizações para realizar registros de títulos. Também verificar se a instalação e as permissões do certificado estão de acordo, pois também podem ocasionar o mesmo erro

O Scope de uma credencial (client_id e client_secret) refere-se ao seu Escopo de trabalho, ou seja, o que a credencial tem permissão de realizar. Por exemplo, uma credencial com scope apenas para Consultar/Retornar os títulos, não conseguirá Registrar títulos, pois não faz parte do seu escopo. Isso não significa que a credencial é inválida, apenas que não possui autorização para realizar alguns métodos da API bancária, por isso que a validação no Assistente de Configuração do Open Banking do CIGAM sinaliza como válida, porém, o problema ocorre apenas ao tentar realizar uma operação não permitida para a credencial.

Parametrização via Assistente sinaliza como Sucesso
FAQ Conclusao Assistente.png


Retorno em branco no Histórico Open Banking
FAQ Retorno Em Branco.png


Para verificar se o Scope da credencial está incorreto, foi disponibilizado a partir da versão CIGAM 221107.b o botão "Validar" nas Parametrizações Open Banking. Ao acionar este botão, será realizada uma tentativa de conexão com a API bancária, onde para os bancos onde as suas credenciais possuem um scope atrelado, será exibida a informação do escopo para aquela credencial.


Botão "Validar" nas Parametrizações Open Banking
FAQ Botao Validar.png


Exemplo de credencial Itaú com Scope correto para API de Cash
FAQ Validar API Cash.png


Exemplo de credencial Itaú com Scope correto para API de Bolecode
FAQ Validar API Bolecode.png


Exemplo de credencial Itaú com Scope incorreto, sem permissão para executar nenhuma operação (Registro, Baixa, Alteração, Consulta/Retorno, Bolecode)
FAQ Validar API Erro Scope.png


Ocorrendo a constatação que o Scope das credenciais fornecidas pelo banco estão incorretas, o banco Itaú deverá ser acionado. Para que, preferencialmente se possível, ajuste o Scope das credenciais já geradas, incluindo os escopos necessários. Ou então, caso geradas novas credenciais pelo banco Itaú com client_id diferente, deverá ser gerado um novo certificado, pois o Common Name (CN) do certificado para Open Banking do Itaú sempre deverá ser o próprio client_id fornecido pelo banco. Também deve ser observado o propósito de uso da credencial, se for com o objetivo de registrar boleto sem QRCode, a credencial deve conter os respectivos scopes da API de Cash. E para Bolecode, os respectivos Scopes para tal, conforme imagens acima.

Importante: Essa situação não é ocasionada por qualquer questão envolvendo criação do certificado ou versão do CIGAM. Trata-se de processo interno do banco Itaú no momento da geração das credenciais, portanto, somente o banco Itaú poderá realizar o ajuste dos Scopes das credenciais existentes ou criação de novas com os Scopes de acordo.

Erros comuns de alteração

Erros comuns de retorno

Boleto/Lançamento Não Encontrado na Listagem de Retorno do Open Banking

Mensagem: Não Encontrado


Quando ocorre a implementação do uso da API de Cobrança Bancária, uma boa prática disponível apenas pela API do Itaú, é a utilização do modo de 'Validação' do boleto antes da sua total liberação para uso. Isso permite que sejam encontradas divergências nas informações dos boletos sem que sejam geradas cobranças por conta de taxas do registro de um boleto, ou que se tenha que emitir a cobrança para alguém com a finalidade apenas de testes e verificação.

Porém, quando utilizada a "Etapa Processo do Boleto" como "Validação", os boletos não podem sofrer Alterações como Multa/Juros/Vencimento, ser Baixado ou ser Consultado/Retornado pela rotina de Retorno do Open Banking. Somente boletos emitidos como "Etapa Processo Boleto" igual a "Efetivação", que é a forma de emissão de boletos de forma oficial, sendo integrado ao sistema de pagamentos brasileiro é que são passíveis de Alterações, Baixa ou de Consulta/Retorno.


Etapa Processo Boleto nos Parâmetros de Open Banking
FAQ Itau antes.png


Exemplo de Histórico Open Banking com a informação do json referente à Etapa Processo Boleto
FAQ Itau antes.png


Neste caso, sempre revise se o Histórico do Open Banking para o boleto emitido foi Registrado da maneira correta para a etapa da implementação.