GF - Como Fazer - Open Banking para Banco Bradesco

De CIGAM WIKI
Revisão de 12h36min de 17 de novembro de 2025 por Tais.felles (discussão | contribs) (API Cobrança/QRCode)


Objetivo

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 das APIs bancárias do Bradesco.

Aqui você será orientado desde a busca e obtenção das credenciais, assistente e parametrizações específicas do Bradesco 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

API Cobrança

Funcionalidade Versão
Registro de Cobrança Simples e vinculada 220404.BETA
Alteração de Vencimento Não tratados no CIGAM
Alteração de Juros e multa Não tratados no CIGAM
Demais alterações (endereço, desconto por antecipação, abatimentos, etc) Não tratados no CIGAM
Baixa de título Não tratados no CIGAM
Protesto 220404.BETA
Negativação Não tratado no CIGAM
Retorno de Cobrança Indisponível
QR CODE no Boleto Não tratados no CIGAM
API de PIX avulso (QR Code dinâmico ECF Lojas) 221107.a

API Cobrança/QRCode

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

* A alteração de vencimento, juros e multa não está disponível para boletos com QR Code Pix.

Open Banking Bradesco

Obtenção de credenciais - Bradesco

Obtenção de credenciais API Cobrança

Para obter as credenciais do Bradesco, além de abrir o chamado junto ao banco a fim de iniciar o processo de credenciamento, é necessário realizar a exportação e disponibilização das chaves públicas de certificado digital ICP-Brasil (e-CNPJ com extensão *.pfx) com CN (common name) composto por Razão Social + CNPJ. É importante observar que caso o cliente já possua um e-CNPJ em uso para a NFe ou arquivos legais (SPED e EFD), a exportação deve ser feita a partir deste certificado, uma vez que ambos precisam possuir a mesma nomenclatura e não podem existir dois certificados com nomes iguais.

Orientações do Bradesco quanto ao certificado:

Orientacoes de Certificado Bradesco.png

Orientações quanto à abertura de chamados no Bradesco:

Orientacoes de Solicitacao ao Suporte API Bradesco.png

O processo de obtenção de credenciais é totalmente de responsabilidade do cliente e sua equipe de TI juntamente com o Bradesco. Para aqueles que desejarem auxílio, dispomos de um parceiro homologado na empresa Certidoc onde cabe ao cliente fazer este contato.

Exemplo de exportação:

Acessar o Navegador Internet Explorer (ou Navegador Padrão) na Máquina que se encontra instalado o Certificado e acessar “Internet Options”:

Na guia Content acessar o botão Certificados;

Posicionar o cursor no Certificado Digital e selecionar o botão Exportar;

Internet Options Bradesco 1 e 2.png
Internet Options Bradesco 3.png

Próxima etapa é clicar em Next;

Exportacao Certificado 1.png

Nesta etapa deve ser selecionado a opção para Não Exportar as Chaves Privadas e seguir Next para próxima etapa;

Exportacao Certificado 2.png

Selecionar a seguinte opção - Base-64 encoded X.509 (.CER) e seguir com Next próxima etapa;

Exportacao Certificado 3.png

Selecionar o caminho a ser salvo do Arquivo que será exportado, informar o nome e seguir Next próxima etapa;

Exportacao Certificado 4.png

Exportação do Certificado Completa.

Exportacao Certificado 5.png

Após a Exportação do Certificado, é necessário entrar em contato com o Gerente de Cash (Gerente da Conta no Banco) solicitando validação do Registro de Cobrança Online para envio de Lançamentos Financeiros via API. Dele também será obtido o Client ID, necessário nos Parâmetros de Convênio Open Banking.

Cliente que, mesmo possuindo Contrato ativo, ainda não acessaram o Bradesco Net Empresa necessitam fazer o primeiro acesso antes de comandar registro de boleto por essa sistemática. Tal procedimento é premissa para o reconhecimento e autenticação do cliente na Plataforma Bradesco para a utilização do nosso serviço.

Obtenção de credenciais API Cobrança/QRCode

Para obter as credenciais do Bradesco, acesse o guia do usuário disponibilizado pelo banco e siga as instruções apresentadas.

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

Para o processo de renovação de certificado, são necessárias algumas ações das 3 partes envolvidas, o CIGAM, o banco Bradesco e o cliente (proprietário do certificado). Em linhas gerais, primeiramente um novo certificado (renovação) deve ser providenciado pelo cliente. Estando de posse do novo certificado, o cliente envia a parte pública deste certificado ao Bradesco, seguindo os passos conforme orientação do próprio Bradesco. O banco Bradesco confirmando a troca em seus sistemas do certificado antigo pelo novo enviado, o cliente poderá já realizar a desinstalação do antigo certificado (já vencido ou de vencimento próximo) e instalação do novo certificado em sua infraestrutura. Neste ponto, a comunicação entre CIGAM e as API's do Bradesco já estão operacionais. Ações adicionais no CIGAM somente são necessárias caso por algum motivo alguma informação do certificado tenha sido alterada em relação ao certificado antigo para o novo no processo de renovação, como o Common Name (CN) e/ou senha do certificado. Neste caso, deve-se acessar as parametrizações do Open Banking e atualizar as informações para estarem de acordo com o novo certificado.

O banco Bradesco realiza as renovações de certificados em produção em seus sistemas em uma grade específica que ocorre toda terça e quinta com início às 22hrs, porém, a renovação tem um intervalo de uma semana para poder entrar nessa grade, nesse caso é necessário que o certificado seja enviado com antecedência para renovação.

Para que o banco Bradesco possa agendar a troca de certificado em uma dessas grades, é necessário que preencham o checklist abaixo indicado pelo banco. Caso o checklist não seja preenchido, a renovação não será sequenciada.

Segue checklist abaixo à ser encaminhado ao banco Bradesco para processo de substituição de certificado:

  • Encaminhar em anexo o novo certificado que irá substituir o antigo após a renovação (necessário que seja somente o certificado público .cer, .crt ou .pem);

  • Informar a Razão Social, CNPJ, Escopo e ambiente (produção ou homologação) do cadastro que será renovado;

  • É possível que o cliente seja avisado assim que a renovação for realizada para validação, caso desejem validar, favor informar nome e contato/whatsapp (técnico) que será acionado após a troca;

  • Informar motivo caso optem por não validar após a renovação.

IMPORTANTE: A validação é feita para que o cliente realize a troca do certificado simultaneamente com o Banco e verifique se ocorreu com sucesso, caso haja algum problema, informar o executor que fez o contato e encaminhar um e-mail ao canal de SuporteAPI que fará a análise na manhã seguinte.

Este procedimento vale inclusive para os casos em que for preciso, por qualquer motivo, realizar a substituição do certificado digital. Lembrando que quando isso ocorre, apenas o certificado vinculado às credenciais é substituído, as credenciais são mantidas as mesmas.

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:

Renovacao Certificado Bradesco.png


Renovacao Certificado Bradesco 2.png

Caso o certificado tenha o CN alterado será necessário a atualização no banco e no CIGAM informar o subject do novo certificado no campo "Certificado" das Credenciais. Para validar a atualização verifique se o campo "Status do Certificado" foi atualizado.

Renovacao Certificado Bradesco 3.png

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

Assistente Open Banking - Bradesco

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

Open Banking Bradesco 0003.png


Passo 1: Aqui serão solicitados todos os dados relativos a credenciais e serão explicados um a um. O BRADESCO possui ambiente de testes, porém o CNPJ, Agência e Conta Correntes precisam ser específicos. Para instruções, consulte o item Ambiente de testes - Bradesco deste manual. Abaixo seguem as instruções para os dados da base de produção:

    a. Api Cobrança: Informe a API de acordo com a sua credencial, 01-API Cobrança ou [Versão 251103 1]02-API Cobrança/QRCode.
    b. Client Id (também chamado de ClientKEY): cole aqui a informação obtida conforme o tópico Obtenção de credenciais para a API utilizada.
    c. Client Secret: cole aqui a informação obtida conforme o tópico Obtenção de credenciais para a API utilizada.
    d. Certificado: informe o nome do certificado apontado no processo de credenciamento do Bradesco, utilize o mesmo nome dos detalhes do certificado no item “subject”, inclusive com CNPJ.

    CN Certificado Bradesco.png

    e. Senha do certificado: informe aqui a senha do certificado apontado no item d.
    f. CNPJ: informe o CNPJ informado no item d.
    g. Status Certificado: campo preenchido automaticamente pelo CIGAM ao localizar um certificado nomeado com o seu CN=RAZÃO SOCIAL+CNPJ conforme informado no item d.
    h. Usuário para Alerta: informe o usuário que receberá o alerta de vencimento do certificado para o processo de alerta descrito na seção Usuário de Alerta (alerta de vencimento de certificado digital) do manual geral do Open Banking.
    i. Algoritmo de assinatura: campo preenchido automaticamente pelo CIGAM.
    j. Versão da autenticação: campo preenchido automaticamente pelo CIGAM.
    k. Scope: campo preenchido automaticamente pelo CIGAM.
    l. Versão da API: campo preenchido automaticamente pelo CIGAM.
    m. Url Autorização: campo preenchido automaticamente pelo CIGAM.
    Url API: campo preenchido automaticamente pelo CIGAM.

Open Banking Bradesco 0004.png


Passo 2: Este passo diz respeito à seleção de convênios, ela é uma característica do BRADESCO 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 é “237”. Porém aqui cabe uma ressalva: a não ser que esteja discriminado nas suas credenciais, sugerimos que você clique em “pular” nesta tela, assim as suas credenciais valerão para qualquer convênio que a empresa possua.

Passo 2 Assistente Bradesco.png

O resultado de clicar em “pular” neste passo resultará em uma parametrização de convênio “Geral” na tela de parâmetros open banking. Depois disso, caso você deseje adicionar uma parametrização adicional, será obrigatório informar um convênio para as credenciais que se deseja adicionar (o botão pular estará desabilitado). Caso a parametrização atual possua um convênio especificado, será possível tanto configurar um novo convênio quanto pular a seleção, desta forma, as novas credenciais utilizarão um convênio “Geral”.


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 instância de credenciais. A informação do portador de retorno é para auxiliar na sugestão da rotina de retorno.

Passo 3 Assistente Bradesco.png

Apenas a opção “Direto” está habilitada para o BRADESCO, atualmente não existe opção para impressão de QR Code PIX no boleto, funcionalidade ativada pelo Checkbox “PIX” e desativada para este banco. O envio “Direto” está descrito em detalhes no Manual Open Banking Geral.

1. Importante: mesmo com a utilização da opção de convênio “Geral”, os portadores de remessa e retorno devem obrigatoriamente possuir o mesmo convênio, isso é importante para que a rotina de retorno funcione corretamente.

2. Importante: O Bradesco possui a funcionalidade de registro de operações PIX em seu escopo no CIGAM. Esta funcionalidade utiliza as mesmas credenciais da API de cobrança, porém tem um escopo e manual de utilização separados deste documento.


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”.

Passo 4 Assistente Bradesco.png

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.

Conclusao Assistente Bradesco.png

Observação: as credenciais ao lado direito “Credenciais de PIX” dizem respeito ao registro de operações PIX avulsas, ou seja, desvinculadas dos boletos. Esta funcionalidade, embora utilize as mesmas credenciais da API de cobrança, possui definições e manual de uso independentes.

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

Tela Parametros Open Banking Bradesco.png

A partir daqui o seu CIGAM já está parametrizado para utilizar o Open Banking do Banco Bradesco, 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 Bradesco. Demais instruções de uso do open banking estão no Manual Open Banking - Geral.

Ambiente de testes - Bradesco

O Bradesco não possui um ambiente de testes selecionável, o que ocorre é que o cliente permanece em ambiente de homologação enquanto não seguir as instruções abaixo para que ocorra a liberação do ambiente de produção para as suas credenciais:

Importante: esta seção é valida somente para a versão Cobrança.

Orientacoes Ambiente Bradesco.png

O Bradesco, por protocolo, solicita que alguns títulos sejam criados em ambiente de homologação com as credenciais do cliente. Na maioria dos casos, basta que seja passado ao setor de validação que o sistema utilizado já está homologado junto às APIs do Bradesco. Faça isso passando o CNPJ e Razão Social da CIGAM:

    CIGAM SOFTWARE CORPORATIVO S.A. 93.578.813/0001-44.

Porém, se mesmo assim for exigido o registro, o procedimento abaixo deve ser executado com o acompanhamento de um consultor CIGAM:

Deverá ser criada uma Unidade de Negócios com o CNPJ abaixo (possível apenas nas bases modelo da CIGAM, não realize alterações nas unidades de negócio do cliente, isso irá corromper a licença CIGAM):

    CNPJ EMISSOR (UN): 38.052.160/0057-01

Deverá ser criado um portador do banco 237 (Bradesco) com os seguintes dados:

    • AGÊNCIA: 3995
    • CONTA CORRENTE: 755575
    • CEDENTE: 2336835
    • CONVENIO: 2336835

Os demais dados da tela de parametrização Client_ID (também chamado de ClientKEY) e informações referentes ao certificado digital (Nome, Senha e CNPJ) devem ser utilizadas as mesmas de produção. Depois disso, basta criar os lançamentos de forma avulsa no CIGAM utilizando a Unidade de Negócios e o portador criados com os dados acima e realizar o seu registro.

Importante: a fim de facilitar o processo de homologação de nossos clientes, a partir da versão 221107.b, o CIGAM passou a mandar os dados acima de forma fixa em todos os registros realizados com credenciais de homologação, dessa forma não há necessidade de cadastramento de UN e nem de portador fictícios.

Importante 2: a versão Cobrança/QRCode não disponibiliza ambiente de testes.

Registro de cobrança - Bradesco

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

Particularidades do cadastro de Portador - Bradesco

- Recebimentos divergentes da cobrança: Para portadores do Bradesco (237) disponibilizamos o campo [Versão 231002.a 1]"Aceita recebimento divergente da cobrança". Se o checkbox for marcado, a tag "CdPagamentoParcial" do envio para registro no banco será enviada com o dado "S", permitindo que o título aceite recebimentos divergentes, caso contrário, a tag será enviada como "N" e o título não permitirá este tipo de recebimento.

Aceita recebimento divergente da cobranca Bradesco.png

- Carteira: Para a API de cobrança híbrida, a carteira indicada, pelo menos em nossos testes piloto foi a "04". Ao utilizar a carteira "09" padrão até então, é apresentado o erro "PRODUTO NÃO CADASTRADO". Desta forma é importante validar esta informação junto ao gerente de Cash.

Open Banking Bradesco 0005.png

- Espécie: Para portadores do Bradesco (237) no campo Espécie na guia CNAB do cadastro de Portadores, utilize uma das opções da coluna Código listadas abaixo a partir da documentação técnica fornecida pelo banco.

Especie bradesco.png


- Protesto e Negativação: Na versão Cobrança, o Bradesco disponibiliza apenas o serviço de protesto. Já na versão Cobrança/QRCode, estão disponíveis os serviços de protesto e negativação.

Impressão de QR Code no Boleto - Bradesco

Uma empresa que queira emitir QR Codes em seus boletos deve possuir credenciais com a versão da API Cobrança/QRCode 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 - bradesco_pix.rtf

Retorno de cobrança - Bradesco

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

Atenção: esta funcionalidade é atendida apenas na versao da API Cobrança/QRCode.

Open Banking Bradesco 0002.png


Open Banking Bradesco 0001.png


Busca Liquidações por:

  • Vencimento e/ou Data Emissão: habilita os filtros UN, Empresa, Lançamento, Vencimento, Data e Situação do Boleto.
    • 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).

  • Data Liquidação: habilita apenas o filtro Data Liquidação.

Observação: Títulos que sejam retornados na mesma data de sua liquidação permanecerão com o status "PROCESSANDO" e a mensagem "Pago no dia. Sem dados para efetuar liquidação no CIGAM. Tente novamente mais tarde.". Nesses casos, a liquidação não será realizada. Retorne no dia seguinte para que o título conste como liquidado e execute a liquidação.

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

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.

Documentos Relacionados

Documentação Bradesco

Versões

Versão 231002

Patch 'a'

  1. Liberado a partir da OS 816822/2.

Versão 251103

  1. Liberado a partir da OS 816823/1.